UNPKG

@atlaskit/eslint-plugin-design-system

Version:

The essential plugin for use with the Atlassian Design System.

79 lines • 2.94 kB
import renameMapping from '@atlaskit/tokens/rename-mapping'; import tokens from '@atlaskit/tokens/token-names'; import { getTokenId } from '@atlaskit/tokens/utils/get-token-id'; import { createLintRule } from '../utils/create-lint-rule'; import { getPrimitiveTokenUsage } from '../utils/get-primitive-token-usage'; var rule = createLintRule({ meta: { name: 'no-deprecated-design-token-usage', docs: { description: 'Disallow using deprecated design tokens.', recommended: true, severity: 'warn' }, hasSuggestions: true, type: 'problem', messages: { tokenDeprecated: 'The token "{{name}}" is deprecated, Please refer to the changelog for guidance on how to migrate. https://atlassian.design/components/tokens/changelog', tokenRenamed: 'The token "{{name}}" is deprecated in favour of "{{replacement}}".' } }, create: function create(context) { var deprecatedTokens = new Map(renameMapping.filter(function (t) { return t.state === 'deprecated'; }).map(function (t) { return [getTokenId(t.path), t]; })); var reportDeprecation = function reportDeprecation(tokenKey, node, argument, getReplacementValue) { var migrationMeta = deprecatedTokens.get(tokenKey); if (!migrationMeta) { return; } if (migrationMeta.replacement) { var replacement = getTokenId(migrationMeta.replacement); var value = getReplacementValue ? replacement in tokens ? getReplacementValue(replacement) : undefined : replacement; context.report({ messageId: 'tokenRenamed', node: node, data: { name: tokenKey, replacement: replacement }, suggest: value ? [{ desc: "Replace with '".concat(value, "'"), fix: function fix(fixer) { return fixer.replaceText(argument, "'".concat(value, "'")); } }] : undefined }); } else { context.report({ messageId: 'tokenDeprecated', node: node, data: { name: tokenKey } }); } }; return { JSXAttribute: function JSXAttribute(node) { var usage = getPrimitiveTokenUsage(node, context); if (usage) { reportDeprecation(usage.tokenName, usage.node, usage.node, usage.getReplacementValue); } }, 'CallExpression[callee.name="token"]': function CallExpressionCalleeNameToken(node) { var _node$arguments$; if (node.type !== 'CallExpression' || ((_node$arguments$ = node.arguments[0]) === null || _node$arguments$ === void 0 ? void 0 : _node$arguments$.type) !== 'Literal') { return; } var tokenKey = node.arguments[0].value; if (typeof tokenKey === 'string') { reportDeprecation(tokenKey, node, node.arguments[0]); } } }; } }); export default rule;