@atlaskit/eslint-plugin-design-system 8.33.0 → 8.36.0

package/dist/es2019/rules/use-tokens-typography/index.js

@@ -0,0 +1,36 @@
+import { createLintRule } from '../utils/create-rule';
+import { getConfig, ruleSchema } from './config';
+import { errorBoundary } from './error-boundary';
+import { StyleObject } from './transformers/style-object';
+const create = context => {
+  const config = getConfig(context.options[0]);
+  return {
+    // const styles = css({ fontSize: '14px, ... }), styled.div({ fontSize: 14, ... })
+    ObjectExpression: node => errorBoundary(() => {
+      return StyleObject.lint(node, {
+        context
+      });
+    }, {
+      config
+    })
+  };
+};
+const rule = createLintRule({
+  meta: {
+    name: 'use-tokens-typography',
+    type: 'problem',
+    fixable: 'code',
+    hasSuggestions: true,
+    docs: {
+      description: 'Enforces usage of design tokens for typography properties rather than hard-coded values.',
+      recommended: false,
+      severity: 'warn'
+    },
+    messages: {
+      noRawTypographyValues: 'Typography primitives or tokens should be used instead of hard-coded values.\n\n@meta <<{{payload}}>>.'
+    },
+    schema: ruleSchema
+  },
+  create
+});
+export default rule;

package/dist/es2019/rules/use-tokens-typography/transformers/style-object.js

@@ -0,0 +1,209 @@
+/* eslint-disable @repo/internal/react/require-jsdoc */
+
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { Object as ASTObject, ObjectEntry, Root } from '../../../ast-nodes';
+import { getValueForPropertyNode, insertTokensImport, normaliseValue } from '../../ensure-design-token-usage/utils';
+import { isDecendantOfGlobalToken, isDecendantOfStyleBlock, isDecendantOfType } from '../../utils/is-node';
+import { convertPropertyNodeToStringableNode, defaultFontWeight, findFontFamilyValueForToken, findFontWeightTokenForValue, findTypographyTokenForValues, fontWeightMap, getLiteralProperty, getTokenProperty, isValidPropertyNode, notUndefined } from '../utils';
+export const StyleObject = {
+  lint(node, {
+    context
+  }) {
+    // To force the correct node type
+    if (!isNodeOfType(node, 'ObjectExpression')) {
+      return {
+        success: false
+      };
+    }
+
+    // Check whether all criteria needed to make a transformation are met
+    const {
+      success,
+      refs
+    } = StyleObject._check(node, {
+      context
+    });
+    if (!success || !refs) {
+      return;
+    }
+    const {
+      fontSizeNode,
+      fontSizeRaw,
+      tokensImportNode
+    } = refs;
+    const fontSizeValue = normaliseValue('fontSize', fontSizeRaw);
+
+    // -- Font weight --
+    const fontWeightNode = ASTObject.getEntryByPropertyName(node, 'fontWeight');
+    const fontWeightRaw = fontWeightNode && getValueForPropertyNode(fontWeightNode, context);
+
+    // If no fontWeight value exists, default to 400 to avoid matching with a bolder token resulting in a visual change
+    let fontWeightValue = fontWeightRaw && normaliseValue('fontWeight', fontWeightRaw) || defaultFontWeight;
+    fontWeightValue = fontWeightValue.length === 3 ? fontWeightValue : fontWeightMap[fontWeightValue] || defaultFontWeight;
+
+    // -- Line height --
+    const lineHeightNode = ASTObject.getEntryByPropertyName(node, 'lineHeight');
+    const lineHeightRaw = lineHeightNode && getValueForPropertyNode(lineHeightNode, context);
+    let shouldAddFontWeight = false;
+    let lineHeightValue = lineHeightRaw && normaliseValue('lineHeight', lineHeightRaw) || undefined;
+    if (lineHeightValue === fontSizeValue) {
+      lineHeightValue = '1';
+    }
+
+    // -- Match tokens --
+    let matchingTokens = findTypographyTokenForValues(fontSizeValue, lineHeightValue);
+    if (matchingTokens.length) {
+      // If we have multiple matching tokens, try matching fontWeight
+      let matchingTokensWithWeight = matchingTokens.filter(token => fontWeightValue ? token.values.fontWeight === fontWeightValue : token);
+      if (matchingTokensWithWeight.length) {
+        // Possibly narrowed down tokens
+        matchingTokens = matchingTokensWithWeight;
+      } else {
+        // Ended up with 0 matches by matching fontWeight
+        // return body token and add fontWeight manually
+        matchingTokens = matchingTokens.filter(token => token.tokenName.includes('.body'));
+        shouldAddFontWeight = true;
+      }
+    }
+
+    // Get other font-* nodes that we can replace/remove.
+    // These aren't needed for token matching.
+
+    // -- Font family --
+    const fontFamilyNode = ASTObject.getEntryByPropertyName(node, 'fontFamily');
+    const fontFamilyRaw = fontFamilyNode && getValueForPropertyNode(fontFamilyNode, context);
+    const fontFamilyValue = fontFamilyRaw && normaliseValue('fontFamily', fontFamilyRaw) || undefined;
+    let fontFamilyToAdd;
+    // If font family uses the Charlie font we can't replace; exit
+    if (fontFamilyValue) {
+      if (fontFamilyValue.toLowerCase().includes('charlie display')) {
+        fontFamilyToAdd = 'heading';
+      } else if (fontFamilyValue.toLowerCase().includes('charlie text')) {
+        fontFamilyToAdd = 'body';
+      }
+    } else {
+      // Font family node exists but we can't resolve its value
+      // Will need to re-add it below the font property to ensure it still applies
+      fontFamilyToAdd = fontFamilyNode ? 'original' : undefined;
+    }
+
+    // -- Font style --
+    const fontStyleNode = ASTObject.getEntryByPropertyName(node, 'fontStyle');
+    const fontStyleRaw = fontStyleNode && getValueForPropertyNode(fontStyleNode, context);
+    const fontStyleValue = fontStyleRaw && normaliseValue('fontStyle', fontStyleRaw) || undefined;
+    let fontStyleToAdd;
+    if (fontStyleValue === 'italic') {
+      fontStyleToAdd = 'italic';
+    }
+
+    // -- Letter spacing --
+    const letterSpacingNode = ASTObject.getEntryByPropertyName(node, 'letterSpacing');
+
+    // A single matching token
+    // TOOD: Maybe suggest options if > 1 matching token
+    if (matchingTokens.length === 1) {
+      const matchingToken = matchingTokens[0];
+
+      // fontSize node is always first
+      const nodesToReplace = [fontSizeNode, fontWeightNode, lineHeightNode, fontFamilyNode, fontStyleNode, letterSpacingNode].filter(notUndefined);
+      const fontFamilyTokenName = fontFamilyToAdd ? `font.family.brand.${fontFamilyToAdd}` : '';
+      const fontWeightReplacementToken = shouldAddFontWeight ? findFontWeightTokenForValue(fontWeightValue) : undefined;
+      const fontWeightReplacement = fontWeightReplacementToken && getTokenProperty('fontWeight', fontWeightReplacementToken.tokenName, fontWeightValue);
+      const fontFamilyReplacement = fontFamilyToAdd && (fontFamilyToAdd === 'original' ? convertPropertyNodeToStringableNode(
+      // This will always exist if fontFamilyToAdd === 'original', TS can't figure that out.
+      fontFamilyNode) : getTokenProperty('fontFamily', fontFamilyTokenName, findFontFamilyValueForToken(fontFamilyTokenName)));
+      const fontStyleReplacement = fontStyleToAdd && getLiteralProperty('fontStyle', fontStyleToAdd);
+      const fixerRefs = {
+        matchingToken,
+        nodesToReplace,
+        tokensImportNode,
+        fontWeightReplacement,
+        fontFamilyReplacement,
+        fontStyleReplacement
+      };
+      context.report({
+        node: fontSizeNode,
+        messageId: 'noRawTypographyValues',
+        data: {
+          payload: `fontSize:${fontSizeRaw}`
+        },
+        fix: StyleObject._fix(fixerRefs, context)
+      });
+    } else if (!matchingTokens.length) {
+      context.report({
+        node: fontSizeNode,
+        messageId: 'noRawTypographyValues',
+        data: {
+          payload: `fontSize:${fontSizeRaw}`
+        }
+      });
+    }
+    return;
+  },
+  _check(node, {
+    context
+  }) {
+    if (!isDecendantOfStyleBlock(node) && !isDecendantOfType(node, 'JSXExpressionContainer')) {
+      return {
+        success: false
+      };
+    }
+
+    // -- Font size --
+    const fontSizeNode = ASTObject.getEntryByPropertyName(node, 'fontSize');
+    if (!fontSizeNode || !isValidPropertyNode(fontSizeNode) || isDecendantOfGlobalToken(fontSizeNode.value)) {
+      return {
+        success: false
+      };
+    }
+    const fontSizeRaw = getValueForPropertyNode(fontSizeNode, context);
+
+    // Without a valid fontSize value we can't be certain what token should be used; exit
+    if (!fontSizeRaw) {
+      return {
+        success: false
+      };
+    }
+    const importDeclaration = Root.findImportsByModule(context.getSourceCode().ast.body, '@atlaskit/tokens');
+
+    // If there is more than one `@atlaskit/tokens` import, then it becomes difficult to determine which import to transform
+    if (importDeclaration.length > 1) {
+      return {
+        success: false
+      };
+    }
+    return {
+      success: true,
+      refs: {
+        fontSizeNode,
+        fontSizeRaw,
+        tokensImportNode: importDeclaration[0]
+      }
+    };
+  },
+  _fix(refs, context) {
+    return fixer => {
+      const {
+        matchingToken,
+        nodesToReplace,
+        tokensImportNode,
+        fontWeightReplacement,
+        fontFamilyReplacement,
+        fontStyleReplacement
+      } = refs;
+      const fontSizeNode = nodesToReplace[0];
+      return (!tokensImportNode ? [insertTokensImport(fixer)] : []).concat(nodesToReplace.map((node, index) => {
+        // Replace first node with token, delete remaining nodes. Guaranteed to be fontSize
+        if (index === 0) {
+          return fixer.replaceText(node, `${getTokenProperty('font', matchingToken.tokenName, matchingToken.tokenValue)}`);
+        }
+
+        // We don't replace fontWeight/fontFamily/fontStyle here in case it occurs before the font property.
+        // Instead delete the original property and add below
+        return ObjectEntry.deleteEntry(node, context, fixer);
+      }),
+      // Make sure font weight/family/style properties are added AFTER font property to ensure they override corectly
+      fontWeightReplacement ? [fixer.insertTextAfter(fontSizeNode, `,\n${fontWeightReplacement}`)] : [], fontFamilyReplacement ? [fixer.insertTextAfter(fontSizeNode, `,\n${fontFamilyReplacement}`)] : [], fontStyleReplacement ? [fixer.insertTextAfter(fontSizeNode, `,\n${fontStyleReplacement}`)] : []);
+    };
+  }
+};

package/dist/es2019/rules/use-tokens-typography/utils.js

@@ -0,0 +1,99 @@
+import { callExpression, identifier, isNodeOfType, literal, property } from 'eslint-codemod-utils';
+import { typographyPalette } from '@atlaskit/tokens/palettes-raw';
+import { typographyAdg3 as typographyTokens } from '@atlaskit/tokens/tokens-raw';
+export const typographyProperties = ['fontSize', 'fontWeight', 'fontFamily', 'lineHeight'];
+export const isTypographyProperty = propertyName => {
+  return typographyProperties.includes(propertyName);
+};
+export const isFontSize = node => isNodeOfType(node, 'CallExpression') && isNodeOfType(node.callee, 'Identifier') && (node.callee.name === 'fontSize' || node.callee.name === 'getFontSize');
+export const isFontSizeSmall = node => isNodeOfType(node, 'CallExpression') && isNodeOfType(node.callee, 'Identifier') && node.callee.name === 'fontSizeSmall';
+export const isFontFamily = node => isNodeOfType(node, 'CallExpression') && isNodeOfType(node.callee, 'Identifier') && (node.callee.name === 'fontFamily' || node.callee.name === 'getFontFamily');
+export const isCodeFontFamily = node => isNodeOfType(node, 'CallExpression') && isNodeOfType(node.callee, 'Identifier') && (node.callee.name === 'codeFontFamily' || node.callee.name === 'getCodeFontFamily');
+export const typographyValueToToken = typographyTokens
+// we're filtering here to remove the `font` tokens.
+.filter(t => t.attributes.group === 'typography').filter(t => t.cleanName.includes('font.heading') || t.cleanName.includes('font.body')).map(currentToken => {
+  var _typographyPalette$fi, _typographyPalette$fi2, _typographyPalette$fi3;
+  const individualValues = {
+    fontSize: (_typographyPalette$fi = typographyPalette.find(baseToken => baseToken.path.slice(-1)[0] ===
+    // @ts-expect-error token.original.value can be a string, due to the typographyTokens export including deprecated tokens
+    currentToken.original.value.fontSize)) === null || _typographyPalette$fi === void 0 ? void 0 : _typographyPalette$fi.value,
+    fontWeight: (_typographyPalette$fi2 = typographyPalette.find(baseToken => baseToken.path.slice(-1)[0] ===
+    // @ts-expect-error token.original.value can be a string, due to the typographyTokens export including deprecated tokens
+    currentToken.original.value.fontWeight)) === null || _typographyPalette$fi2 === void 0 ? void 0 : _typographyPalette$fi2.value,
+    lineHeight: (_typographyPalette$fi3 = typographyPalette.find(baseToken => baseToken.path.slice(-1)[0] ===
+    // @ts-expect-error token.original.value can be a string, due to the typographyTokens export including deprecated tokens
+    currentToken.original.value.lineHeight)) === null || _typographyPalette$fi3 === void 0 ? void 0 : _typographyPalette$fi3.value
+  };
+  return {
+    tokenName: currentToken.cleanName,
+    tokenValue: currentToken.value,
+    values: individualValues
+  };
+});
+export function findTypographyTokenForValues(fontSize, lineHeight) {
+  let matchingTokens = typographyValueToToken.filter(token => token.values.fontSize === fontSize)
+  // If lineHeight == 1, we don't match to a token
+  .filter(() => lineHeight === '1' ? false : true);
+  return matchingTokens;
+}
+export const fontWeightTokens = typographyTokens.filter(token => token.attributes.group === 'fontWeight').map(token => {
+  return {
+    tokenName: token.cleanName,
+    tokenValue: token.value,
+    values: {}
+  };
+});
+export function findFontWeightTokenForValue(fontWeight) {
+  return fontWeightTokens.find(token => token.tokenValue === fontWeight);
+}
+export const fontWeightMap = {
+  regular: '400',
+  medium: '500',
+  semibold: '600',
+  bold: '700'
+};
+export const defaultFontWeight = fontWeightMap.regular;
+export const fontFamilyTokens = typographyTokens.filter(token => token.attributes.group === 'fontFamily');
+export function findFontFamilyValueForToken(tokenName) {
+  var _fontFamilyTokens$fin;
+  // Note this will only ever be undefined if the tokens get renamed, and should never happen.
+  return ((_fontFamilyTokens$fin = fontFamilyTokens.find(token => token.cleanName === tokenName)) === null || _fontFamilyTokens$fin === void 0 ? void 0 : _fontFamilyTokens$fin.value) || '';
+}
+export function notUndefined(value) {
+  return value !== undefined;
+}
+export function isValidPropertyNode(node) {
+  if (!isNodeOfType(node.key, 'Identifier') && !isNodeOfType(node.key, 'Literal')) {
+    return false;
+  }
+  return true;
+}
+function getTokenNode(tokenName, tokenValue) {
+  return callExpression({
+    callee: identifier({
+      name: 'token'
+    }),
+    arguments: [literal({
+      value: `'${tokenName}'`
+    }), literal(tokenValue)],
+    optional: false
+  });
+}
+export function getTokenProperty(propertyName, tokenName, tokenFallback) {
+  return property({
+    key: identifier(propertyName),
+    value: getTokenNode(tokenName, tokenFallback)
+  });
+}
+export function getLiteralProperty(propertyName, propertyValue) {
+  return property({
+    key: identifier(propertyName),
+    value: literal(propertyValue)
+  });
+}
+export function convertPropertyNodeToStringableNode(node) {
+  return property({
+    key: node.key,
+    value: node.value
+  });
+}

package/dist/esm/ast-nodes/index.js

@@ -3,4 +3,5 @@ export { Import } from './import';
 export { JSXAttribute } from './jsx-attribute';
 export { JSXElement } from './jsx-element';
 export { Object } from './object';
+export { ObjectEntry } from './object-entry';
 export { Root } from './root';

package/dist/esm/ast-nodes/object-entry.js

@@ -0,0 +1,22 @@
+var ObjectEntry = {
+  deleteEntry: function deleteEntry(node, context, fixer) {
+    var _lastToken;
+    // context.getSourceCode() is deprecated in favour of context.sourceCode, however this returns undefined for some reason
+    var sourceCode = context.getSourceCode();
+
+    // fixer.remove() doesn't account for things like commas or newlines within an ObjectExpression and will result in invalid output.
+    // This approach specifically removes the node and trailing comma, and should work for single- and multi-line objects.
+    // From https://github.com/eslint/eslint/issues/9576#issuecomment-341737453
+    var prevToken = sourceCode.getTokenBefore(node);
+    while (((_prevToken = prevToken) === null || _prevToken === void 0 ? void 0 : _prevToken.value) !== ',' && ((_prevToken2 = prevToken) === null || _prevToken2 === void 0 ? void 0 : _prevToken2.value) !== '{') {
+      var _prevToken, _prevToken2;
+      prevToken = sourceCode.getTokenBefore(node);
+    }
+    var lastToken = sourceCode.getTokenAfter(node);
+    if (((_lastToken = lastToken) === null || _lastToken === void 0 ? void 0 : _lastToken.value) !== ',') {
+      lastToken = sourceCode.getTokenBefore(lastToken);
+    }
+    return fixer.removeRange([prevToken.range[1], lastToken.range[1]]);
+  }
+};
+export { ObjectEntry };

package/dist/esm/ast-nodes/object.js

@@ -27,7 +27,7 @@ var ASTObjectExpression = {
     });
   },
   /**
-   * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`.
+   * Returns the first Property node from an Object that matches the provided name.
    */
   getEntryByPropertyName: function getEntryByPropertyName(node, name) {
     return node.properties.find(function (property) {

package/dist/esm/presets/all.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::bcb633b9d5c2def00d43b11139433c5c>>
+ * @codegen <<SignedSource::d90c2cf5e100daf98915f9467f2e5663>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 export default {
@@ -35,6 +35,7 @@ export default {
     '@atlaskit/design-system/use-href-in-link-item': 'warn',
     '@atlaskit/design-system/use-primitives': 'warn',
     '@atlaskit/design-system/use-primitives-text': 'warn',
+    '@atlaskit/design-system/use-tokens-typography': 'warn',
     '@atlaskit/design-system/use-visually-hidden': 'error'
   }
 };

package/dist/esm/rules/ensure-design-token-usage/index.js

@@ -9,7 +9,7 @@ import { lintJSXIdentifierForColor, lintJSXLiteralForColor, lintJSXMemberForColo
 import { errorBoundary } from './error-boundary';
 import ruleMeta from './rule-meta';
 import { lintObjectForSpacing } from './spacing';
-import { convertHyphenatedNameToCamelCase, emToPixels, getDomainsForProperty, getFontSizeFromNode, getFontSizeValueInScope, getTokenReplacement, getValueFromShorthand, getValueFromTemplateLiteralRaw, includesTokenString, insertTokensImport, isAuto, isCalc, isTokenValueString, isValidSpacingValue, isZero, processCssNode, splitShorthandValues } from './utils';
+import { convertHyphenatedNameToCamelCase, emToPixels, getDomainsForProperty, getFontSizeValueInScope, getPropertyNodeFromParent, getTokenReplacement, getValueForPropertyNode, getValueFromShorthand, getValueFromTemplateLiteralRaw, includesTokenString, insertTokensImport, isAuto, isCalc, isTokenValueString, isValidSpacingValue, isZero, processCssNode, splitShorthandValues } from './utils';
 var defaultConfig = {
   domains: ['color', 'spacing'],
   applyImport: true,
@@ -104,11 +104,12 @@ var createWithConfig = function createWithConfig(initialConfig) {
             if (domains.includes('color')) {
               return lintObjectForColor(node, context, config);
             }
-            if (domains.includes('spacing') || domains.includes('shape') || domains.includes('typography')) {
+            if (domains.includes('spacing') || domains.includes('shape')) {
               /**
-               * We do this in case the fontSize for a style object is declared alongside the `em` or `lineHeight` declaration
+               * We do this in case the fontSize for a style object is declared alongside the `em` or `lineHeight` declaration.
                */
-              var fontSize = getFontSizeFromNode(parentNode, context);
+              var fontSizeNode = getPropertyNodeFromParent('fontSize', parentNode);
+              var fontSize = fontSizeNode && getValueForPropertyNode(fontSizeNode, context);
               return lintObjectForSpacing(node, context, config, fontSize, tokenNode);
             }
           }
@@ -166,7 +167,7 @@ var createWithConfig = function createWithConfig(initialConfig) {
                 return currentSource;
               }
             }
-            if (domains.includes('spacing') || domains.includes('typography') || domains.includes('shape')) {
+            if (domains.includes('spacing') || domains.includes('shape')) {
               if (!isValidSpacingValue(resolvedCssValues, globalFontSize)) {
                 // no changes should be made to the current property
                 return currentSource;

package/dist/esm/rules/ensure-design-token-usage/rule-meta.js

@@ -1,4 +1,4 @@
-var domainsToLint = ['color', 'spacing', 'typography', 'shape'];
+var domainsToLint = ['color', 'spacing', 'shape'];
 var ruleMeta = {
   name: 'ensure-design-token-usage',
   hasSuggestions: true,

package/dist/esm/rules/ensure-design-token-usage/spacing.js

@@ -69,7 +69,8 @@ export var lintObjectForSpacing = function lintObjectForSpacing(node, context, r
         payload: "".concat(propertyName, ":").concat(pixelValue)
       },
       fix: function fix(fixer) {
-        var replacementNode = getTokenReplacement(propertyName, pixelValue);
+        // Casting due to possibility of pixelValue being string | number from emToPixels
+        var replacementNode = pixelValue && getTokenReplacement(propertyName, pixelValue);
         if (!replacementNode) {
           return null;
         }
@@ -116,6 +117,8 @@ export var lintObjectForSpacing = function lintObjectForSpacing(node, context, r
         if (!allResolvableValues) {
           return null;
         }
+
+        // Casting due to possibility of value being string | number
         var valuesWithTokenReplacement = valuesForProperty.filter(function (value) {
           return findTokenNameByPropertyValue(propertyName, value);
         }).filter(function (value) {
@@ -149,6 +152,7 @@ export var lintObjectForSpacing = function lintObjectForSpacing(node, context, r
           var pixelValueString = "".concat(pixelValue, "px");
           // if there is a token we take it, otherwise we go with the original value
 
+          // Casting due to possibility of value being string | number
           return findTokenNameByPropertyValue(propertyName, value) ? "${".concat(getTokenNodeForValue(propertyName, pixelValueString), "}") : originalValues[index];
         }).join(' '), "`"))]);
       }