@atlaskit/eslint-plugin-design-system/dist/esm/rules/use-latest-xcss-syntax-typography/index.js

The essential plugin for use with the Atlassian Design System.

import { createLintRule } from '../utils/create-lint-rule';
import { errorBoundary } from '../utils/error-boundary';
import { getConfig } from './config/get-config';
import { PATTERNS } from './config/patterns';
import { RestrictedCapitalisation } from './linters/restricted-capitalisation';
import { RestrictedProperty } from './linters/restricted-property';
import { WrappedTokenValue } from './linters/wrapped-token-value';
var typescriptErrorMessage = 'There is ongoing work to make this a TypeScript error. Once that happens, you will have to delete/refactor anyway.';
var rule = createLintRule({
  meta: {
    name: 'use-latest-xcss-syntax-typography',
    type: 'problem',
    fixable: 'code',
    hasSuggestions: false,
    schema: [{
      type: 'object',
      properties: {
        failSilently: {
          type: 'boolean'
        },
        patterns: {
          maxLength: PATTERNS.length,
          type: 'array',
          items: {
            type: 'string',
            enum: PATTERNS
          },
          uniqueItems: true
        }
      },
      additionalProperties: false
    }],
    docs: {
      description: 'Prohibits use of unsafe styling properties in xcss. Please use Text/Heading primitives instead.',
      recommended: true,
      severity: 'warn'
    },
    messages: {
      noRestrictedTypographyProperties: "Don't set '{{ property }}' on xcss as it allows invalid combinations of typography tokens. ".concat(typescriptErrorMessage),
      noRestrictedTypographyPropertiesHeading: "Don't set '{{ property }}' on xcss in combination with 'font' heading tokens. ".concat(typescriptErrorMessage),
      noRestrictedCapitalisation: "Avoid using ALL CAPS as it reduces readability and is bad for accessibility.",
      noWrappedTokenTypographyValues: "Don't wrap typography tokens in xcss. ".concat(typescriptErrorMessage)
    }
  },
  create: function create(context) {
    // TODO: JFP-2823 - this type cast was added due to Jira's ESLint v9 migration
    var config = getConfig(context.options[0]);
    return errorBoundary({
      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Identifier[name=/(fontSize|lineHeight|fontWeight|letterSpacing)/]': function CallExpressionCalleeNameXcss_ObjectExpression__Property__IdentifierName_FontSizeLineHeightFontWeightLetterSpacing_(node) {
        return RestrictedProperty.lint(node, {
          context: context,
          config: config
        });
      },
      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Literal[value=/(fontSize|lineHeight|fontWeight|letterSpacing)/]': function CallExpressionCalleeNameXcss_ObjectExpression__Property__LiteralValue_FontSizeLineHeightFontWeightLetterSpacing_(node) {
        return RestrictedProperty.lint(node, {
          context: context,
          config: config
        });
      },
      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Identifier[name=textTransform]': function CallExpressionCalleeNameXcss_ObjectExpression__Property__IdentifierNameTextTransform(node) {
        return RestrictedCapitalisation.lint(node, {
          context: context,
          config: config
        });
      },
      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Literal[value=textTransform]': function CallExpressionCalleeNameXcss_ObjectExpression__Property__LiteralValueTextTransform(node) {
        return RestrictedCapitalisation.lint(node, {
          context: context,
          config: config
        });
      },
      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Identifier[name=/(font|fontFamily|fontWeight)/]': function CallExpressionCalleeNameXcss_ObjectExpression__Property__IdentifierName_FontFontFamilyFontWeight_(node) {
        return WrappedTokenValue.lint(node, {
          context: context,
          config: config
        });
      },
      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Literal[value=/(font|fontFamily|fontWeight)/]': function CallExpressionCalleeNameXcss_ObjectExpression__Property__LiteralValue_FontFontFamilyFontWeight_(node) {
        return WrappedTokenValue.lint(node, {
          context: context,
          config: config
        });
      }
    }, config);
  }
});
export default rule;