[Typography] Add semantic type tokens and block new raw font sizes #96880
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| const name = 'no-raw-typography'; | ||
|
|
||
| const meta = { | ||
| type: 'problem', | ||
| docs: { | ||
| description: 'Disallow raw numeric fontSize/lineHeight values. Type must come from the typography scale so it cannot drift from the design system.', | ||
| recommended: 'error', | ||
| }, | ||
| schema: [], | ||
| messages: { | ||
| rawTypography: 'Raw `{{property}}: {{value}}` is not allowed. Use a `<Text variant="...">` or a token from src/styles/typography.ts (https://github.com/Expensify/App/issues/37503).', | ||
| }, | ||
| }; | ||
|
|
||
| const BANNED_PROPERTIES = new Set(['fontSize', 'lineHeight']); | ||
|
|
||
| /** | ||
| * @param {import('estree').Node} key | ||
| * @returns {string | undefined} | ||
| */ | ||
| function getPropertyName(key) { | ||
| if (key.type === 'Identifier') { | ||
| return key.name; | ||
| } | ||
| if (key.type === 'Literal' && typeof key.value === 'string') { | ||
| return key.value; | ||
| } | ||
| return undefined; | ||
| } | ||
|
|
||
| /** | ||
| * @param {import('estree').Node} node | ||
| * @returns {boolean} | ||
| */ | ||
| function isNumericLiteral(node) { | ||
| if (node.type === 'Literal' && typeof node.value === 'number') { | ||
| return true; | ||
| } | ||
| return node.type === 'UnaryExpression' && node.operator === '-' && isNumericLiteral(node.argument); | ||
|
grgia marked this conversation as resolved.
Outdated
grgia marked this conversation as resolved.
Outdated
|
||
| } | ||
|
|
||
| /** | ||
| * Flags object properties (`{fontSize: 17}`) and JSX attributes (`<Text fontSize={17}>`) that set | ||
| * `fontSize`/`lineHeight` to a numeric literal. References to tokens or computed values are allowed. | ||
| * | ||
| * @param {import('eslint').Rule.RuleContext} context | ||
| * @returns {import('eslint').Rule.RuleListener} | ||
| */ | ||
| function create(context) { | ||
| function report(valueNode, propertyName) { | ||
| context.report({ | ||
| node: valueNode, | ||
| messageId: 'rawTypography', | ||
| data: { | ||
|
There was a problem hiding this comment.
When a style is built or mutated with an assignment such as Useful? React with 👍 / 👎. |
||
| property: propertyName, | ||
| value: context.sourceCode.getText(valueNode), | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| return { | ||
| Property(node) { | ||
| if (node.computed) { | ||
| return; | ||
| } | ||
| const propertyName = getPropertyName(node.key); | ||
| if (propertyName === undefined || !BANNED_PROPERTIES.has(propertyName) || !isNumericLiteral(node.value)) { | ||
| return; | ||
| } | ||
| report(node.value, propertyName); | ||
| }, | ||
| JSXAttribute(node) { | ||
| if (node.name.type !== 'JSXIdentifier' || !BANNED_PROPERTIES.has(node.name.name)) { | ||
| return; | ||
| } | ||
| if (node.value?.type !== 'JSXExpressionContainer' || !isNumericLiteral(node.value.expression)) { | ||
| return; | ||
| } | ||
| report(node.value.expression, node.name.name); | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| export {name, meta, create}; | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are all changes in this file necessary? We should not add more eslint disablings.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Each new row is an existing violation of the two checks this PR introduces: raw fontSize/lineHeight values, and the now-deprecated fontSize prop on Text. Listing them at today's counts lets both checks ship as errors without migrating all ~60 call sites in this PR. They get removed as files migrate to the tokens.