Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | /** A single validation error. */
export interface ValidationError {
segment: string;
expected: string[];
received: string;
/**
* Optional human-readable rename / migration hint. Set by anti-pattern
* detectors that know the canonical form (e.g. "rename to
* `--slds-c-button-color-foreground`"). Generic structural errors
* leave this unset; the formatter falls back to the
* `Expected/Received` shape.
*/
hint?: string;
}
/** A single validation warning (e.g. deprecated squash-case syntax). */
export interface ValidationWarning {
type: 'legacy-syntax';
segment: string;
received: string;
canonical: string;
}
/** Return type for all validators. */
export interface ValidationResult {
errors: ValidationError[];
warnings: ValidationWarning[];
}
/** Signature for a global category validator function. */
export type CategoryValidator = (segments: string[], aliases?: Record<string, string>) => ValidationResult;
/** Token metadata for component hooks and shared tokens. */
export interface ComponentValidValues {
category: string[];
property: string[];
attribute: string[];
state: string[];
pseudoState: string[];
/**
* Categories that MUST be followed by a property segment. Most
* categories may stand alone at the end of the hook
* (`--slds-c-icon-size`, `--slds-c-button-shadow`); a few don't —
* `color` requires `-{background|foreground|border}` per RFC 1157.
*/
categoriesRequiringProperty: string[];
/**
* Categories that may carry a per-state suffix (`-hover`, `-focus`,
* `-active`, `-disabled`). RFC 1157 §State Hooks (line 689) restricts
* the carveout to color-{background|foreground|border} and shadow.
* Every other category rejects state suffixes; per-state overrides
* for those categories are expressed at the selector level in the
* theme file, not as a hook suffix.
*/
categoriesAllowingState: string[];
}
/** Token metadata for reference tokens. */
export interface ReferenceValidValues {
category: string[];
role: string[];
}
/** Global metadata (category list only; per-category allowlists are generated). */
export interface GlobalValidValues {
category: string[];
}
/** Full metadata shape. */
export interface Metadata {
scopes: string[];
global: { valid: GlobalValidValues };
reference: { valid: ReferenceValidValues };
shared: { valid: Record<string, never> };
component: { valid: ComponentValidValues };
deprecated: Record<string, string>;
privateSyntax: string[];
legacyPropertyAliases: Record<string, string>;
skipScopeValidation?: boolean;
}
/** Plugin rule options passed by consumers. */
export interface RuleOptions {
privateSyntax?: string;
deprecated?: Record<string, string>;
skipScopeValidation?: boolean;
valid?: Partial<ComponentValidValues>;
global?: { valid?: Partial<GlobalValidValues> };
}
|