@atlaskit/eslint-plugin-platform 2.9.0 → 2.9.2

package/dist/esm/rules/no-xcss-in-cx/index.js

@@ -0,0 +1,216 @@
+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; }
+import { getImportSources, isCxFunction, isXcss } from '@atlaskit/eslint-utils/is-supported-import';
+import { getScope } from '../util/context-compat';
+
+/**
+ * Disallows passing xcss() results into cx() when used in an xcss prop.
+ *
+ * xcss() from @atlaskit/primitives and cx() from @atlaskit/css / @compiled/react
+ * are incompatible — xcss() produces an opaque StyleRule object, while cx()
+ * expects Compiled atomic class name strings. Mixing them causes runtime errors.
+ * xcss() results must never be passed to cx(), whether inline or pre-defined.
+ *
+ * ❌ Wrong — xcss() called inline inside cx():
+ *   xcss={cx(xcss({ color: 'red' }), xcss({ fontWeight: 'bold' }))}
+ *
+ * ❌ Also wrong — xcss() results pre-defined but still passed into cx():
+ *   const baseStyles = xcss({ color: 'red' });
+ *   const boldStyles = xcss({ fontWeight: 'bold' });
+ *   xcss={cx(baseStyles, boldStyles)}
+ *
+ * ✅ Correct — pass xcss() results directly to the xcss prop (no cx()):
+ *   const baseStyles = xcss({ color: 'red' });
+ *   xcss={baseStyles}
+ *
+ * ✅ Correct — use cssMap() + cx() (cssMap is compatible with cx()):
+ *   const styles = cssMap({ base: { color: 'red' } });
+ *   xcss={cx(styles.base, condition && styles.focused)}
+ *
+ * This rule is import-aware: it only flags xcss() calls (inline or via variable)
+ * imported from @atlaskit/primitives inside cx() calls imported from @atlaskit/css
+ * or @compiled/react that appear inside an xcss prop.
+ */
+var rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Disallow calling xcss() inline inside cx() in an xcss prop. Define styles at module level instead.'
+    },
+    messages: {
+      noXcssInCx: 'Do not pass xcss() results into cx(). ' + 'xcss() produces a StyleRule object that is incompatible with cx(), which expects Compiled atomic class names. ' + 'Pass xcss() results directly to the xcss prop instead: xcss={myStyles}. ' + 'To conditionally combine styles, use cssMap() + cx(): const styles = cssMap({...}); xcss={cx(styles.base, cond && styles.active)}'
+    },
+    schema: []
+  },
+  create: function create(context) {
+    return {
+      JSXAttribute: function JSXAttribute(node) {
+        // Narrow Rule.Node to JSXAttribute (estree-jsx augments the `estree` Node
+        // union with JSX members, so this discriminated narrowing is safe).
+        if (node.type !== 'JSXAttribute') {
+          return;
+        }
+
+        // Only check `xcss` props
+        if (node.name.type !== 'JSXIdentifier' || node.name.name !== 'xcss') {
+          return;
+        }
+        if (!node.value || node.value.type !== 'JSXExpressionContainer') {
+          return;
+        }
+        var expression = node.value.expression;
+        if (expression.type === 'JSXEmptyExpression') {
+          return;
+        }
+
+        // Early-return if the expression cannot possibly contain a cx() call —
+        // avoids the cost of getImportSources/getScope on simple references like xcss={baseStyles}.
+        var isCallOrArray = expression.type === 'CallExpression' || expression.type === 'ArrayExpression';
+        if (!isCallOrArray) {
+          return;
+        }
+        var importSources = getImportSources(context);
+        var _getScope = getScope(context, node),
+          references = _getScope.references;
+
+        /**
+         * Returns true if an Identifier node resolves to a variable whose
+         * initializer is a call to xcss() imported from @atlaskit/primitives.
+         *
+         * Walks up the scope chain from the current JSXAttribute scope to find
+         * the variable definition, since module-level variables are not in the
+         * local scope's references list.
+         *
+         * e.g. `const baseStyles = xcss({ color: 'red' })` — passing `baseStyles`
+         * here returns true.
+         */
+        var isXcssVariable = function isXcssVariable(identNode) {
+          if (identNode.type !== 'Identifier') {
+            return false;
+          }
+          var name = identNode.name;
+          // Walk up the scope chain to find the variable definition
+          var currentScope = getScope(context, node);
+          while (currentScope) {
+            var variable = currentScope.set.get(name);
+            if (variable) {
+              var _iterator = _createForOfIteratorHelper(variable.defs),
+                _step;
+              try {
+                for (_iterator.s(); !(_step = _iterator.n()).done;) {
+                  var _def$node$init;
+                  var def = _step.value;
+                  if (def.type === 'Variable' && def.node.type === 'VariableDeclarator' && ((_def$node$init = def.node.init) === null || _def$node$init === void 0 ? void 0 : _def$node$init.type) === 'CallExpression') {
+                    // isXcss checks the callee identifier against referencesInScope to
+                    // find the import binding. The callee lives in the same scope as the
+                    // variable definition, so use all references from that scope.
+                    var defScopeRefs = currentScope.references;
+                    if (isXcss(def.node.init.callee, defScopeRefs, importSources)) {
+                      return true;
+                    }
+                  }
+                }
+                // Found the variable but it's not an xcss() call
+              } catch (err) {
+                _iterator.e(err);
+              } finally {
+                _iterator.f();
+              }
+              return false;
+            }
+            currentScope = currentScope.upper;
+          }
+          return false;
+        };
+
+        /**
+         * Recursively check a node that is an argument to cx() for xcss() results —
+         * both inline calls and references to variables initialised with xcss().
+         * Recurses into LogicalExpression (&&, ||) and ConditionalExpression (? :) so that
+         * patterns like cx(cond && xcss({...})) and cx(cond ? baseStyles : a) are caught.
+         */
+        var _checkArgForXcss = function checkArgForXcss(argNode) {
+          if (!argNode) {
+            return;
+          }
+          // Inline: cx(xcss({ color: 'red' }))
+          if (argNode.type === 'CallExpression' && isXcss(argNode.callee, references, importSources)) {
+            context.report({
+              node: argNode,
+              messageId: 'noXcssInCx'
+            });
+            return;
+          }
+          // Variable reference: cx(baseStyles) where baseStyles = xcss({...})
+          if (isXcssVariable(argNode)) {
+            context.report({
+              node: argNode,
+              messageId: 'noXcssInCx'
+            });
+            return;
+          }
+          // Recurse into `cond && xcss({...})` or `cond || xcss({...})`
+          if (argNode.type === 'LogicalExpression') {
+            _checkArgForXcss(argNode.left);
+            _checkArgForXcss(argNode.right);
+          }
+          // Recurse into `cond ? xcss({...}) : fallback`
+          if (argNode.type === 'ConditionalExpression') {
+            _checkArgForXcss(argNode.consequent);
+            _checkArgForXcss(argNode.alternate);
+          }
+        };
+
+        /**
+         * Check all arguments of a cx() call for inline xcss() calls.
+         * Reports each xcss() call found as a violation.
+         */
+        var checkCxArgs = function checkCxArgs(callNode) {
+          if (callNode.type !== 'CallExpression') {
+            return;
+          }
+          if (!isCxFunction(callNode.callee, references, importSources)) {
+            return;
+          }
+          var _iterator2 = _createForOfIteratorHelper(callNode.arguments),
+            _step2;
+          try {
+            for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+              var arg = _step2.value;
+              if (arg) {
+                _checkArgForXcss(arg.type === 'SpreadElement' ? arg.argument : arg);
+              }
+            }
+          } catch (err) {
+            _iterator2.e(err);
+          } finally {
+            _iterator2.f();
+          }
+        };
+
+        // Case 1: xcss={cx(...)} — cx() directly as the xcss value
+        checkCxArgs(expression);
+
+        // Case 2: xcss={[..., cx(...), ...]} — cx() inside an xcss array
+        if (expression.type === 'ArrayExpression') {
+          var _iterator3 = _createForOfIteratorHelper(expression.elements),
+            _step3;
+          try {
+            for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+              var element = _step3.value;
+              if (element) {
+                checkCxArgs(element.type === 'SpreadElement' ? element.argument : element);
+              }
+            }
+          } catch (err) {
+            _iterator3.e(err);
+          } finally {
+            _iterator3.f();
+          }
+        }
+      }
+    };
+  }
+};
+export default rule;

package/dist/esm/rules/visit-example-type-import-required/index.js

@@ -17,7 +17,7 @@ var messages = {
   suggestFixPath: 'Update import path to match visitExample arguments'
 };
 function isTargetFile(filename) {
-  return filename.endsWith('.spec.tsx');
+  return filename.endsWith('.spec.tsx') || filename.endsWith('.spec.ts');
 }
 
 /**
@@ -111,7 +111,8 @@ function resolveVariableToConstant(programBody, variableName, cache) {
  * Returns null for any argument that can't be statically resolved.
  */
 function extractCallArgs(node, programBody, variableCache) {
-  if (node.arguments.length < 3) {
+  var argOffset = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 0;
+  if (node.arguments.length < argOffset + 3) {
     return null;
   }
   function resolveArg(arg) {
@@ -123,9 +124,9 @@ function extractCallArgs(node, programBody, variableCache) {
     }
     return null;
   }
-  var groupId = resolveArg(node.arguments[0]);
-  var packageId = resolveArg(node.arguments[1]);
-  var exampleId = resolveArg(node.arguments[2]);
+  var groupId = resolveArg(node.arguments[argOffset]);
+  var packageId = resolveArg(node.arguments[argOffset + 1]);
+  var exampleId = resolveArg(node.arguments[argOffset + 2]);
   if (!groupId || !packageId || !exampleId) {
     return null;
   }
@@ -173,8 +174,13 @@ function resolveExamplePathFromArgs(groupId, packageId, exampleId, testFilePath)
   var examplesDir = path.resolve(packagesBase.basePath, groupId, packageId, 'examples');
   var fallback = path.resolve(examplesDir, "".concat(exampleId, ".tsx"));
 
-  // Match: exact name OR numeric-prefixed variant, with optional `.examples` infix
-  var candidateRe = new RegExp("^(?:\\d+-)?".concat(exampleId, "(?:\\.examples?)?\\.tsx$"));
+  // Phase 4: loosen candidateRe to match both pre- and post-rename filename shapes.
+  // Pre-rename:  ^(\d+-)?<id>(\.(examples?))?\.tsx$
+  // Post-rename: ^(\d+-)?<id>(\.<ident>){0,3}\.tsx$   (Volt prefix, optional .dup<N>, optional role)
+  // The {0,3} cap prevents matching arbitrary strings (e.g. 4-component names).
+  // Escape regex metacharacters in exampleId (ids are kebab-case today, but defensive).
+  var escapedId = exampleId.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+  var candidateRe = new RegExp("^(?:\\d+-)?".concat(escapedId, "(?:\\.[A-Za-z][A-Za-z0-9_]*){0,3}\\.tsx$"));
   try {
     var match = fs.readdirSync(examplesDir).find(function (f) {
       return candidateRe.test(f);
@@ -272,20 +278,24 @@ var rule = {
           return;
         }
         var node = estreeNode;
-        // Only handle `<anything>.visitExample(...)` calls
-        if (node.callee.type !== AST_NODE_TYPES.MemberExpression || node.callee.property.type !== AST_NODE_TYPES.Identifier || node.callee.property.name !== 'visitExample') {
+        var calleeIdentifier = null;
+        var argOffset = 0;
+        if (node.callee.type === AST_NODE_TYPES.MemberExpression && node.callee.property.type === AST_NODE_TYPES.Identifier && node.callee.property.name === 'visitExample') {
+          calleeIdentifier = node.callee.property;
+        } else if (node.callee.type === AST_NODE_TYPES.Identifier && node.callee.name === 'visitMockedExample') {
+          calleeIdentifier = node.callee;
+          argOffset = 1; // first arg is `page`
+        } else {
           return;
         }
 
-        // Narrow callee — we've confirmed property is an Identifier above
-        var callee = node.callee;
         // reportCallee is typed as estree.Node for context.report compatibility
         var reportCallee = estreeNode.callee;
         var genericType = extractGenericType(node);
 
         // ── Case 1: No generic type parameter ────────────────────────────────
         if (genericType === null) {
-          var _args = extractCallArgs(node, programBody, variableCache);
+          var _args = extractCallArgs(node, programBody, variableCache, argOffset);
           context.report({
             node: reportCallee,
             messageId: 'missingTypeofImport',
@@ -298,7 +308,7 @@ var rule = {
                 return null;
               }
               var importPath = computeRelativeImportPath(filename, examplePath);
-              var _ref2 = callee.property.range,
+              var _ref2 = calleeIdentifier.range,
                 _ref3 = _slicedToArray(_ref2, 2),
                 start = _ref3[0],
                 end = _ref3[1];
@@ -360,7 +370,7 @@ var rule = {
         }
 
         // Validate that the import path matches the arguments
-        var args = extractCallArgs(node, programBody, variableCache);
+        var args = extractCallArgs(node, programBody, variableCache, argOffset);
         if (!args) {
           // Dynamic arguments — can't validate statically
           return;