@atlaskit/eslint-plugin-design-system
Version:
The essential plugin for use with the Atlassian Design System.
86 lines (85 loc) • 3.32 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _renameMapping = _interopRequireDefault(require("@atlaskit/tokens/rename-mapping"));
var _tokenNames = _interopRequireDefault(require("@atlaskit/tokens/token-names"));
var _getTokenId = require("@atlaskit/tokens/utils/get-token-id");
var _createLintRule = require("../utils/create-lint-rule");
var _getPrimitiveTokenUsage = require("../utils/get-primitive-token-usage");
var rule = (0, _createLintRule.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.default.filter(function (t) {
return t.state === 'deprecated';
}).map(function (t) {
return [(0, _getTokenId.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 = (0, _getTokenId.getTokenId)(migrationMeta.replacement);
var value = getReplacementValue ? replacement in _tokenNames.default ? 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 = (0, _getPrimitiveTokenUsage.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]);
}
}
};
}
});
var _default = exports.default = rule;