CANTAGESTUDIO avatar

brand-guidelines-enforcer

[Design System] Lightweight brand guidelines enforcement for UI copy and visual motifs. Use when (1)

by CANTAGESTUDIO|Open Source

Brand Guidelines Enforcer

Lightweight enforcement of brand guidelines for UI copy and visual motifs.

Quick Start

python3 scripts/enforce_brand.py --guidelines brand.yml --source src/

Violation Types

TypeSeverityDescription
wrong-color-contextwarningColor used outside allowed context
tone-violationwarningCopy doesn't match brand voice
reserved-component-misuseerrorReserved component in wrong screen
prohibited-worderrorProhibited word/pattern found
capitalization-errorinfoWrong capitalization style

Detection Examples

Tone Violations

// Violation: unfriendly error message
<ErrorMessage>Error occurred: Invalid input</ErrorMessage>
// Suggested: "Something went wrong. Please check this field."

// Violation: generic CTA
<Button>Click here</Button>
// Suggested: "Get started" or "Continue"