@atlaskit/eslint-plugin-design-system
Version:
The essential plugin for use with the Atlassian Design System.
73 lines • 2.71 kB
JavaScript
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';
const 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(context) {
const deprecatedTokens = new Map(renameMapping.filter(t => t.state === 'deprecated').map(t => [getTokenId(t.path), t]));
const reportDeprecation = (tokenKey, node, argument, getReplacementValue) => {
const migrationMeta = deprecatedTokens.get(tokenKey);
if (!migrationMeta) {
return;
}
if (migrationMeta.replacement) {
const replacement = getTokenId(migrationMeta.replacement);
const value = getReplacementValue ? replacement in tokens ? getReplacementValue(replacement) : undefined : replacement;
context.report({
messageId: 'tokenRenamed',
node,
data: {
name: tokenKey,
replacement
},
suggest: value ? [{
desc: `Replace with '${value}'`,
fix: fixer => fixer.replaceText(argument, `'${value}'`)
}] : undefined
});
} else {
context.report({
messageId: 'tokenDeprecated',
node,
data: {
name: tokenKey
}
});
}
};
return {
JSXAttribute: node => {
const usage = getPrimitiveTokenUsage(node, context);
if (usage) {
reportDeprecation(usage.tokenName, usage.node, usage.node, usage.getReplacementValue);
}
},
'CallExpression[callee.name="token"]': 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;
}
const tokenKey = node.arguments[0].value;
if (typeof tokenKey === 'string') {
reportDeprecation(tokenKey, node, node.arguments[0]);
}
}
};
}
});
export default rule;