@atlaskit/eslint-plugin-design-system
Version:
The essential plugin for use with the Atlassian Design System.
186 lines (184 loc) • 9.61 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.getPrimitiveTokenUsage = getPrimitiveTokenUsage;
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
var _eslintCodemodUtils = require("eslint-codemod-utils");
var _contextCompat = require("@atlaskit/eslint-utils/context-compat");
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
var spacingTokens = new Set(['space.0', 'space.025', 'space.050', 'space.075', 'space.100', 'space.150', 'space.200', 'space.250', 'space.300', 'space.400', 'space.500', 'space.600', 'space.800', 'space.1000']);
var paddingProps = new Set(['padding', 'paddingBlock', 'paddingBlockStart', 'paddingBlockEnd', 'paddingInline', 'paddingInlineStart', 'paddingInlineEnd']);
var tokenProps = new Set([].concat((0, _toConsumableArray2.default)(paddingProps), ['backgroundColor', 'space', 'rowSpace', 'gap', 'rowGap', 'columnGap', 'color', 'size', 'weight', 'all', 'inline', 'block']));
var components = new Map([['Box', 'box'], ['Inline', 'inline'], ['Stack', 'stack'], ['Flex', 'flex'], ['Grid', 'grid'], ['Bleed', 'bleed'], ['Text', 'text'], ['MetricText', 'metric-text'], ['Pressable', 'pressable'], ['Anchor', 'anchor']]);
var textSizes = {
small: 'font.body.small',
medium: 'font.body',
large: 'font.body.large'
};
var metricSizes = {
small: 'font.metric.small',
medium: 'font.metric.medium',
large: 'font.metric.large'
};
var textWeights = {
regular: 'font.weight.regular',
medium: 'font.weight.medium',
semibold: 'font.weight.semibold',
bold: 'font.weight.bold'
};
var bleedTokens = {
'space.025': 'space.negative.025',
'space.050': 'space.negative.050',
'space.100': 'space.negative.100',
'space.150': 'space.negative.150',
'space.200': 'space.negative.200'
};
function fromMapping(value, mapping) {
if (!Object.prototype.hasOwnProperty.call(mapping, value)) {
return;
}
return {
tokenName: mapping[value],
getReplacementValue: function getReplacementValue(tokenName) {
return Object.keys(mapping).find(function (key) {
return mapping[key] === tokenName;
});
}
};
}
function getTokenMapping(component, compiled, prop, value) {
if (component === 'Text') {
if (prop === 'size') {
return fromMapping(value, textSizes);
}
if (prop === 'weight') {
return fromMapping(value, textWeights);
}
if (prop === 'color' && value !== 'inherit') {
return {
tokenName: value,
getReplacementValue: function getReplacementValue(name) {
return /^color\.(text|link)(\.|$)/.test(name) ? name : undefined;
}
};
}
}
if (component === 'MetricText' && prop === 'size') {
return fromMapping(value, metricSizes);
}
if (component === 'Bleed' && ['all', 'inline', 'block'].includes(prop)) {
return fromMapping(value, bleedTokens);
}
if (component === 'Box' || !compiled && ['Anchor', 'Pressable'].includes(component)) {
if (prop === 'backgroundColor') {
return {
tokenName: value,
getReplacementValue: function getReplacementValue(name) {
return /^(color\.(background|blanket|skeleton)|elevation\.surface)(\.|$)/.test(name) || name === 'utility.elevation.surface.current' ? name : undefined;
}
};
}
if (paddingProps.has(prop)) {
return {
tokenName: value,
getReplacementValue: function getReplacementValue(name) {
return spacingTokens.has(name) ? name : undefined;
}
};
}
}
if (component === 'Inline' && ['space', 'rowSpace'].includes(prop) || component === 'Stack' && prop === 'space' || ['Flex', 'Grid'].includes(component) && ['gap', 'rowGap', 'columnGap'].includes(prop)) {
return {
tokenName: value,
getReplacementValue: function getReplacementValue(name) {
return spacingTokens.has(name) ? name : undefined;
}
};
}
}
// Resolve only explicit string props on imported primitives, respecting aliases and shadowing.
function getPrimitiveTokenUsage(node, context) {
if (!(0, _eslintCodemodUtils.isNodeOfType)(node, 'JSXAttribute') || node.name.type !== 'JSXIdentifier' || !tokenProps.has(node.name.name) || !node.value) {
return;
}
var value = node.value.type === 'JSXExpressionContainer' ? node.value.expression : node.value;
if (value.type !== 'Literal' || typeof value.value !== 'string') {
return;
}
var opening = node.parent;
if (!(0, _eslintCodemodUtils.isNodeOfType)(opening, 'JSXOpeningElement')) {
return;
}
var tag = opening.name;
var namespace = tag.type === 'JSXMemberExpression';
var identifier = namespace ? tag.object : tag;
if (identifier.type !== 'JSXIdentifier') {
return;
}
var scope = (0, _contextCompat.getScope)(context, node);
while (scope) {
var variable = scope.set.get(identifier.name);
if (!variable) {
scope = scope.upper;
continue;
}
var _iterator = _createForOfIteratorHelper(variable.defs),
_step;
try {
var _loop = function _loop() {
var _def$parent;
var def = _step.value;
if (def.type !== 'ImportBinding' || ((_def$parent = def.parent) === null || _def$parent === void 0 ? void 0 : _def$parent.type) !== 'ImportDeclaration') {
return 0; // continue
}
var source = String(def.parent.source.value);
var compiled = source.startsWith('@atlaskit/primitives/compiled');
var barrel = source === '@atlaskit/primitives' || source === '@atlaskit/primitives/compiled';
var component;
if (namespace && def.node.type === 'ImportNamespaceSpecifier') {
component = tag.property.name;
} else if (!namespace && def.node.type === 'ImportSpecifier') {
component = def.node.imported.name;
} else if (!namespace && def.node.type === 'ImportDefaultSpecifier' && !compiled) {
var _find;
component = (_find = (0, _toConsumableArray2.default)(components).find(function (_ref) {
var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
name = _ref2[0],
path = _ref2[1];
return !['Grid', 'Bleed'].includes(name) && source === "@atlaskit/primitives/".concat(path);
})) === null || _find === void 0 ? void 0 : _find[0];
}
var path = component && components.get(component);
if (!component || !path || !barrel && source !== "@atlaskit/primitives/".concat(compiled ? 'compiled/' : '').concat(path) && !(component === 'Flex' && source === '@atlaskit/primitives/components/flex')) {
return 0; // continue
}
var mapping = getTokenMapping(component, compiled, node.name.name, value.value);
return {
v: mapping && _objectSpread(_objectSpread({}, mapping), {}, {
node: value
})
};
},
_ret;
for (_iterator.s(); !(_step = _iterator.n()).done;) {
_ret = _loop();
if (_ret === 0) continue;
if (_ret) return _ret.v;
}
// A local binding shadows any import in an outer scope.
} catch (err) {
_iterator.e(err);
} finally {
_iterator.f();
}
return;
}
}