ESLint: Add bare token check to no-unknown-ds-tokens
#76210
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,35 +4,41 @@ const tokenList = tokenListModule.default || tokenListModule; | |
| const DS_TOKEN_PREFIX = 'wpds-'; | ||
|
|
||
| /** | ||
| * Single-pass extraction that finds all `--prefix-*` tokens in a CSS value | ||
| * string and classifies each occurrence as `var()`-wrapped or bare. | ||
| * | ||
| * @param {string} value - The CSS value string to search. | ||
| * @param {string} [prefix=''] - Optional prefix to filter variables (e.g., 'wpds-'). | ||
| * @return {{ tokens: Set<string>, bare: Set<string> }} | ||
| * `tokens` — every unique matched token; | ||
| * `bare` — the subset that appeared at least once without a `var()` wrapper. | ||
| * | ||
| * @example | ||
| * classifyTokens( | ||
| * 'var(--wpds-color-fg) --wpds-color-bg', | ||
| * 'wpds-' | ||
| * ); | ||
| * // → { tokens: Set {'--wpds-color-fg','--wpds-color-bg'}, | ||
| * // bare: Set {'--wpds-color-bg'} } | ||
| */ | ||
| function classifyTokens( value, prefix = '' ) { | ||
| const regex = new RegExp( | ||
| `(?:^|[^\\w])(var\\(\\s*)?(--${ prefix }[\\w-]+)`, | ||
| 'g' | ||
| ); | ||
| const tokens = new Set(); | ||
| const bare = new Set(); | ||
|
|
||
| let match; | ||
| while ( ( match = regex.exec( value ) ) !== null ) { | ||
| const token = match[ 2 ]; | ||
| tokens.add( token ); | ||
| if ( ! match[ 1 ] ) { | ||
| bare.add( token ); | ||
| } | ||
| } | ||
|
|
||
| return { tokens, bare }; | ||
| } | ||
|
|
||
| const knownTokens = new Set( tokenList ); | ||
|
|
@@ -50,6 +56,8 @@ module.exports = /** @type {import('eslint').Rule.RuleModule} */ ( { | |
| 'The following CSS variables are not valid Design System tokens: {{ tokenNames }}', | ||
| dynamicToken: | ||
| 'Design System tokens must not be dynamically constructed, as they cannot be statically verified for correctness or processed automatically to inject fallbacks.', | ||
| bareToken: | ||
| 'Design System tokens must be wrapped in `var()` for build-time fallback injection to work: {{ tokenNames }}', | ||
| }, | ||
| }, | ||
| create( context ) { | ||
|
|
@@ -71,6 +79,7 @@ module.exports = /** @type {import('eslint').Rule.RuleModule} */ ( { | |
| [ dynamicTemplateLiteralAST ]( node ) { | ||
| let hasDynamic = false; | ||
| const unknownTokens = []; | ||
| const bareTokens = []; | ||
|
|
||
| for ( const quasi of node.quasis ) { | ||
| const raw = quasi.value.raw; | ||
|
|
@@ -84,7 +93,7 @@ module.exports = /** @type {import('eslint').Rule.RuleModule} */ ( { | |
| hasDynamic = true; | ||
| } | ||
|
|
||
| const { tokens, bare } = classifyTokens( | ||
| value, | ||
| DS_TOKEN_PREFIX | ||
| ); | ||
|
|
@@ -95,12 +104,15 @@ module.exports = /** @type {import('eslint').Rule.RuleModule} */ ( { | |
| const endMatch = value.match( /(--([\w-]+))$/ ); | ||
| if ( endMatch ) { | ||
| tokens.delete( endMatch[ 1 ] ); | ||
| bare.delete( endMatch[ 1 ] ); | ||
| } | ||
| } | ||
|
|
||
| for ( const token of tokens ) { | ||
| if ( ! knownTokens.has( token ) ) { | ||
| unknownTokens.push( token ); | ||
| } else if ( bare.has( token ) ) { | ||
| bareTokens.push( token ); | ||
| } | ||
| } | ||
| } | ||
|
Comment on lines
79
to
118
There was a problem hiding this comment. In the dynamic TemplateLiteral handler,
Member
Author
There was a problem hiding this comment. Skipping this one since the same pattern already existed for |
||
|
|
@@ -123,6 +135,18 @@ module.exports = /** @type {import('eslint').Rule.RuleModule} */ ( { | |
| }, | ||
| } ); | ||
| } | ||
|
|
||
| if ( bareTokens.length > 0 ) { | ||
| context.report( { | ||
| node, | ||
| messageId: 'bareToken', | ||
| data: { | ||
| tokenNames: bareTokens | ||
| .map( ( token ) => `'${ token }'` ) | ||
| .join( ', ' ), | ||
| }, | ||
| } ); | ||
| } | ||
| }, | ||
| /** @param {import('estree').Literal | import('estree').TemplateElement} node */ | ||
| [ staticTokensAST ]( node ) { | ||
|
|
@@ -145,7 +169,7 @@ module.exports = /** @type {import('eslint').Rule.RuleModule} */ ( { | |
| return; | ||
| } | ||
|
|
||
| const { tokens: usedTokens, bare } = classifyTokens( | ||
| computedValue, | ||
| DS_TOKEN_PREFIX | ||
| ); | ||
|
|
@@ -164,6 +188,31 @@ module.exports = /** @type {import('eslint').Rule.RuleModule} */ ( { | |
| }, | ||
| } ); | ||
| } | ||
|
|
||
| // Skip bare-token check for property keys | ||
| // (e.g. `{ '--wpds-token': value }` declaring a custom property). | ||
| const isPropertyKey = | ||
| node.parent?.type === 'Property' && | ||
| node.parent.key === node; | ||
|
|
||
| if ( ! isPropertyKey ) { | ||
| const bareTokens = [ ...usedTokens ].filter( | ||
| ( token ) => | ||
| knownTokens.has( token ) && bare.has( token ) | ||
| ); | ||
|
|
||
| if ( bareTokens.length > 0 ) { | ||
| context.report( { | ||
| node, | ||
| messageId: 'bareToken', | ||
| data: { | ||
| tokenNames: bareTokens | ||
| .map( ( token ) => `'${ token }'` ) | ||
| .join( ', ' ), | ||
| }, | ||
| } ); | ||
| } | ||
| } | ||
| }, | ||
| }; | ||
| }, | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.