@atlaskit/eslint-plugin-platform 2.9.1 → 2.9.3

package/dist/es2019/rules/compiled/use-motion-token-values/index.js

@@ -0,0 +1,444 @@
+import tokenDefaultValues from '@atlaskit/tokens/token-default-values';
+const DURATION_TOKEN_NAMES = ['motion.duration.instant', 'motion.duration.xxshort', 'motion.duration.xshort', 'motion.duration.short', 'motion.duration.medium', 'motion.duration.long', 'motion.duration.xlong', 'motion.duration.xxlong'];
+function parseDurationMs(value) {
+  const ms = value.match(/^(\d+(?:\.\d+)?)ms$/);
+  if (ms) {
+    return parseFloat(ms[1]);
+  }
+  const s = value.match(/^(\d+(?:\.\d+)?)s$/);
+  if (s) {
+    return parseFloat(s[1]) * 1000;
+  }
+  return null;
+}
+const DURATION_TOKENS = DURATION_TOKEN_NAMES.map(name => {
+  const rawValue = tokenDefaultValues[name];
+  const ms = parseDurationMs(rawValue);
+  if (ms === null) {
+    throw new Error(`use-motion-token-values: could not parse duration for token ${name}: ${rawValue}`);
+  }
+  return {
+    ms,
+    token: name
+  };
+}).sort((a, b) => a.ms - b.ms);
+const EASING_TOKEN_NAMES = ['motion.easing.in.practical', 'motion.easing.inout.bold', 'motion.easing.out.practical', 'motion.easing.out.bold'];
+function parseCubicBezierParams(value) {
+  const match = value.match(/^cubic-bezier\(\s*([\d.]+)\s*,\s*([\d.]+)\s*,\s*([\d.]+)\s*,\s*([\d.]+)\s*\)$/);
+  if (!match) {
+    return null;
+  }
+  return [parseFloat(match[1]), parseFloat(match[2]), parseFloat(match[3]), parseFloat(match[4])];
+}
+const EASING_TOKENS = EASING_TOKEN_NAMES.map(name => {
+  const rawValue = tokenDefaultValues[name];
+  const params = parseCubicBezierParams(rawValue);
+  if (!params) {
+    throw new Error(`use-motion-token-values: could not parse cubic-bezier for token ${name}: ${rawValue}`);
+  }
+  return {
+    value: rawValue,
+    token: name,
+    params
+  };
+});
+
+// Splits on top-level commas (outside function parens) — preserves cubic-bezier(...) commas.
+function splitOnTopLevelCommas(value) {
+  const parts = [];
+  let depth = 0;
+  let current = '';
+  for (const ch of value) {
+    if (ch === '(') {
+      depth++;
+      current += ch;
+    } else if (ch === ')') {
+      depth--;
+      current += ch;
+    } else if (ch === ',' && depth === 0) {
+      parts.push(current.trim());
+      current = '';
+    } else {
+      current += ch;
+    }
+  }
+  if (current.trim().length > 0) {
+    parts.push(current.trim());
+  }
+  return parts;
+}
+const DURATION_PROPERTIES = new Set(['transitionDuration', 'animationDuration']);
+const EASING_PROPERTIES = new Set(['transitionTimingFunction', 'animationTimingFunction']);
+
+// Explicit semantic mappings for CSS keyword easings to motion tokens.
+// Pinned by design intent, confirmed with design system team (Alex + Akshay).
+const CSS_KEYWORD_EASING_TOKEN_MAP = {
+  ease: 'motion.easing.out.practical',
+  'ease-out': 'motion.easing.out.practical',
+  'ease-in': 'motion.easing.in.practical',
+  'ease-in-out': 'motion.easing.inout.bold'
+  // linear (0,0,1,1) — warn only, no autofix (per Akshay: too generic, no good token match)
+};
+
+// Non-curve easing values with no meaningful cubic-bezier representation — skip entirely
+const SKIP_EASING_VALUES = new Set(['step-start', 'step-end', 'inherit', 'initial', 'unset', 'none']);
+function euclideanDistance(a, b) {
+  return Math.sqrt(a.reduce((sum, val, i) => sum + Math.pow(val - b[i], 2), 0));
+}
+
+// Maximum Euclidean distance for easing autofix — beyond this threshold, we report-only
+const EASING_AUTOFIX_THRESHOLD = 0.5;
+function findClosestEasingToken(params) {
+  let minDist = Infinity;
+  let closest = EASING_TOKENS[0];
+  for (const entry of EASING_TOKENS) {
+    const dist = euclideanDistance(params, entry.params);
+    if (dist < minDist) {
+      minDist = dist;
+      closest = entry;
+    }
+  }
+  if (minDist > EASING_AUTOFIX_THRESHOLD) {
+    return null;
+  }
+  return {
+    token: closest.token,
+    value: closest.value,
+    dist: minDist
+  };
+}
+function findClosestDurationTokens(ms) {
+  const exact = DURATION_TOKENS.find(t => t.ms === ms);
+  if (exact) {
+    return [exact];
+  }
+  let minDist = Infinity;
+  for (const entry of DURATION_TOKENS) {
+    const dist = Math.abs(entry.ms - ms);
+    if (dist < minDist) {
+      minDist = dist;
+    }
+  }
+  const closest = DURATION_TOKENS.filter(t => Math.abs(t.ms - ms) === minDist);
+  return closest;
+}
+export const useMotionTokenValues = {
+  meta: {
+    type: 'suggestion',
+    fixable: 'code',
+    docs: {
+      url: 'https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master/platform/packages/platform/eslint-plugin/src/rules/compiled/use-motion-token-values/'
+    },
+    messages: {
+      useMotionDurationToken: "Use a motion duration token instead of the hard-coded value '{{ value }}'. Replace with {{ suggestion }}.",
+      useMotionDurationTokenNearest: "No exact token match for '{{ value }}'. Nearest: {{ suggestion1 }} or {{ suggestion2 }}.",
+      useMotionEasingToken: "Use a motion easing token instead of the hard-coded value '{{ value }}'. Replace with {{ suggestion }}.",
+      useMotionEasingTokenUnknown: "Use a motion easing token from @atlaskit/tokens instead of the hard-coded value '{{ value }}'."
+    }
+  },
+  create(context) {
+    let tokensImportNode = null;
+    let hasTokenSpecifier = false;
+    function buildTokenCall(tokenName, fallback) {
+      return `token('${tokenName}', '${fallback}')`;
+    }
+    function getImportFix(fixer) {
+      var _context$sourceCode;
+      if (hasTokenSpecifier) {
+        return [];
+      }
+      if (tokensImportNode) {
+        // @atlaskit/tokens is imported but without `token` — add `token` to existing import
+        const lastSpecifier = tokensImportNode.specifiers[tokensImportNode.specifiers.length - 1];
+        if (lastSpecifier) {
+          return [fixer.insertTextAfter(lastSpecifier, ', token')];
+        }
+        // Empty import — replace the whole declaration
+        return [fixer.replaceText(tokensImportNode, `import { token } from '@atlaskit/tokens';`)];
+      }
+      const sourceCode = (_context$sourceCode = context.sourceCode) !== null && _context$sourceCode !== void 0 ? _context$sourceCode : context.getSourceCode();
+      const programBody = sourceCode.ast.body;
+      // Insert after the last existing import, or at top if no imports exist
+      const lastImport = [...programBody].reverse().find(n => n.type === 'ImportDeclaration');
+      if (lastImport) {
+        return [fixer.insertTextAfter(lastImport, `\nimport { token } from '@atlaskit/tokens';`)];
+      }
+      if (programBody.length > 0) {
+        return [fixer.insertTextBefore(programBody[0], `import { token } from '@atlaskit/tokens';\n`)];
+      }
+      return [];
+    }
+
+    // Returns autofix string for a single duration value, or null if ambiguous (equidistant)
+    function resolveDurationToken(value) {
+      const ms = parseDurationMs(value);
+      if (ms === null) {
+        return null;
+      }
+      const result = findClosestDurationTokens(ms);
+      if (result.length === 1) {
+        return buildTokenCall(result[0].token, value);
+      }
+      return null;
+    }
+    function handleDurationProperty(node, rawValue) {
+      const segments = splitOnTopLevelCommas(rawValue);
+
+      // Single value path keeps the existing equidistant message
+      if (segments.length === 1) {
+        const ms = parseDurationMs(rawValue);
+        if (ms === null) {
+          return;
+        }
+        const result = findClosestDurationTokens(ms);
+        if (result.length === 1) {
+          const suggestion = buildTokenCall(result[0].token, rawValue);
+          context.report({
+            node,
+            messageId: 'useMotionDurationToken',
+            data: {
+              value: rawValue,
+              suggestion
+            },
+            fix(fixer) {
+              return [...getImportFix(fixer), fixer.replaceText(node.value, suggestion)];
+            }
+          });
+        } else {
+          const suggestion1 = buildTokenCall(result[0].token, rawValue);
+          const suggestion2 = buildTokenCall(result[1].token, rawValue);
+          context.report({
+            node,
+            messageId: 'useMotionDurationTokenNearest',
+            data: {
+              value: rawValue,
+              suggestion1: `${suggestion1} (${result[0].ms}ms)`,
+              suggestion2: `${suggestion2} (${result[1].ms}ms)`
+            }
+          });
+        }
+        return;
+      }
+
+      // Multi-value path: every segment must resolve to a single token for autofix
+      const resolved = segments.map(resolveDurationToken);
+      if (resolved.some(s => s === null)) {
+        return;
+      }
+      // Build a template literal: `${token(...)}, ${token(...)}`
+      const templateLiteral = '`' + resolved.map(s => `\${${s}}`).join(', ') + '`';
+      context.report({
+        node,
+        messageId: 'useMotionDurationToken',
+        data: {
+          value: rawValue,
+          suggestion: templateLiteral
+        },
+        fix(fixer) {
+          return [...getImportFix(fixer), fixer.replaceText(node.value, templateLiteral)];
+        }
+      });
+    }
+
+    // Returns autofix string for a single easing value, or null if no token suggestion is possible
+    function resolveEasingToken(value) {
+      const trimmed = value.trim();
+      if (SKIP_EASING_VALUES.has(trimmed)) {
+        return null;
+      }
+      if (trimmed in CSS_KEYWORD_EASING_TOKEN_MAP) {
+        return buildTokenCall(CSS_KEYWORD_EASING_TOKEN_MAP[trimmed], trimmed);
+      }
+      // linear has no curve (0,0,1,1) — warn only, no autofix
+      if (trimmed === 'linear') {
+        return null;
+      }
+      if (trimmed.startsWith('linear(')) {
+        // linear() is used for spring animations — motion.easing.spring is experimental, skip
+        return null;
+      }
+      const params = parseCubicBezierParams(trimmed);
+      if (!params) {
+        return null;
+      }
+      const exact = EASING_TOKENS.find(t => t.value === trimmed);
+      if (exact) {
+        return buildTokenCall(exact.token, trimmed);
+      }
+      const closest = findClosestEasingToken(params);
+      return closest ? buildTokenCall(closest.token, trimmed) : null;
+    }
+    function handleEasingProperty(node, rawValue) {
+      const segments = splitOnTopLevelCommas(rawValue);
+
+      // Multi-value path: resolve each segment, autofix only if all resolve cleanly
+      if (segments.length > 1) {
+        const resolved = segments.map(resolveEasingToken);
+        if (resolved.some(s => s === null)) {
+          return;
+        }
+        const templateLiteral = '`' + resolved.map(s => `\${${s}}`).join(', ') + '`';
+        context.report({
+          node,
+          messageId: 'useMotionEasingToken',
+          data: {
+            value: rawValue,
+            suggestion: templateLiteral
+          },
+          fix(fixer) {
+            return [...getImportFix(fixer), fixer.replaceText(node.value, templateLiteral)];
+          }
+        });
+        return;
+      }
+      const trimmed = rawValue.trim();
+      if (SKIP_EASING_VALUES.has(trimmed)) {
+        return;
+      }
+
+      // CSS keyword easings: convert to cubic-bezier equivalent and find closest token
+      if (trimmed in CSS_KEYWORD_EASING_TOKEN_MAP) {
+        const suggestion = buildTokenCall(CSS_KEYWORD_EASING_TOKEN_MAP[trimmed], trimmed);
+        context.report({
+          node,
+          messageId: 'useMotionEasingToken',
+          data: {
+            value: trimmed,
+            suggestion
+          },
+          fix(fixer) {
+            return [...getImportFix(fixer), fixer.replaceText(node.value, suggestion)];
+          }
+        });
+        return;
+      }
+      // linear has no curve (0,0,1,1) — warn only, no autofix
+      if (trimmed === 'linear') {
+        context.report({
+          node,
+          messageId: 'useMotionEasingTokenUnknown',
+          data: {
+            value: trimmed
+          }
+        });
+        return;
+      }
+      if (trimmed.startsWith('linear(')) {
+        // linear() is used for spring animations — motion.easing.spring is experimental, skip
+        return;
+      }
+      const params = parseCubicBezierParams(trimmed);
+      if (!params) {
+        context.report({
+          node,
+          messageId: 'useMotionEasingTokenUnknown',
+          data: {
+            value: rawValue
+          }
+        });
+        return;
+      }
+      const exact = EASING_TOKENS.find(t => t.value === trimmed);
+      if (exact) {
+        const suggestion = buildTokenCall(exact.token, rawValue);
+        context.report({
+          node,
+          messageId: 'useMotionEasingToken',
+          data: {
+            value: rawValue,
+            suggestion
+          },
+          fix(fixer) {
+            return [...getImportFix(fixer), fixer.replaceText(node.value, suggestion)];
+          }
+        });
+        return;
+      }
+      const closest = findClosestEasingToken(params);
+      if (closest) {
+        const suggestion = buildTokenCall(closest.token, rawValue);
+        context.report({
+          node,
+          messageId: 'useMotionEasingToken',
+          data: {
+            value: rawValue,
+            suggestion
+          },
+          fix(fixer) {
+            return [...getImportFix(fixer), fixer.replaceText(node.value, suggestion)];
+          }
+        });
+      } else {
+        context.report({
+          node,
+          messageId: 'useMotionEasingTokenUnknown',
+          data: {
+            value: rawValue
+          }
+        });
+      }
+    }
+    function handleProperty(node) {
+      const key = node.key;
+      if (key.type !== 'Identifier') {
+        return;
+      }
+      const isDuration = DURATION_PROPERTIES.has(key.name);
+      const isEasing = EASING_PROPERTIES.has(key.name);
+      if (!isDuration && !isEasing) {
+        return;
+      }
+      const value = node.value;
+      if (value.type === 'TemplateLiteral') {
+        // Only handle no-interpolation template literals (e.g. `200ms`) — treat as string
+        const tl = value;
+        if (tl.expressions.length === 0 && tl.quasis.length === 1) {
+          var _tl$quasis$0$value$co;
+          const rawValue = (_tl$quasis$0$value$co = tl.quasis[0].value.cooked) !== null && _tl$quasis$0$value$co !== void 0 ? _tl$quasis$0$value$co : tl.quasis[0].value.raw;
+          if (isDuration) {
+            handleDurationProperty(node, rawValue);
+          } else {
+            handleEasingProperty(node, rawValue);
+          }
+        }
+        return;
+      }
+      if (value.type === 'CallExpression') {
+        const ce = value;
+        if (ce.callee.type === 'Identifier' && ce.callee.name === 'token') {
+          return;
+        }
+        return;
+      }
+      if (value.type === 'Literal') {
+        const lit = value;
+        let rawValue;
+        if (typeof lit.value === 'string') {
+          rawValue = lit.value;
+        } else if (typeof lit.value === 'number') {
+          // Treat bare numbers as ms
+          rawValue = `${lit.value}ms`;
+        } else {
+          return;
+        }
+        if (isDuration) {
+          handleDurationProperty(node, rawValue);
+        } else {
+          handleEasingProperty(node, rawValue);
+        }
+      }
+    }
+    return {
+      ImportDeclaration(node) {
+        if (node.source.value === '@atlaskit/tokens') {
+          tokensImportNode = node;
+          hasTokenSpecifier = node.specifiers.some(s => s.type === 'ImportSpecifier' && s.local.name === 'token');
+        }
+      },
+      Property(node) {
+        handleProperty(node);
+      }
+    };
+  }
+};
+export default useMotionTokenValues;