@elastic/eslint-plugin-eui 2.15.0 → 2.16.0

package/lib/esm/utils/walk_jsx_children.js

@@ -0,0 +1,213 @@
+"use strict";
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.walkJsxChildren = walkJsxChildren;
+const flat_map_1 = require("./flat_map");
+const is_fragment_1 = require("./is_fragment");
+// A variable is only safely resolvable if it is never reassigned. A second
+// write means the value at the point of use can't be determined statically.
+function isReassigned(variable) {
+    return variable.references.filter((ref) => ref.isWrite()).length > 1;
+}
+/**
+ * Resolves an expression-context Identifier to the node its variable was
+ * initialized with (e.g. the `<EuiButton />` in `const btn = <EuiButton />`).
+ * Returns null for anything that can't be resolved safely: imports, function
+ * parameters, reassigned variables, or missing initializers.
+ */
+function resolveIdentifierValue(sourceCode, node) {
+    let scope = sourceCode.getScope(node);
+    while (scope) {
+        const ref = scope.references.find((r) => r.identifier === node);
+        if (ref) {
+            const variable = ref.resolved;
+            if (!variable || isReassigned(variable))
+                return null;
+            const def = variable.defs[0];
+            if (!def || def.type !== 'Variable' || !def.node.init)
+                return null;
+            return def.node.init;
+        }
+        scope = scope.upper;
+    }
+    return null;
+}
+/**
+ * Collects all return-statement arguments within a block body, recursing into
+ * `if`/`else` branches and `switch` cases. Does not recurse into nested
+ * functions - those have their own return scope. Used to validate block-body
+ * arrow functions.
+ */
+function collectReturnValues(node) {
+    switch (node.type) {
+        case 'BlockStatement':
+            return (0, flat_map_1.flatMap)(node.body, collectReturnValues);
+        case 'ReturnStatement':
+            return node.argument ? [node.argument] : [];
+        case 'IfStatement':
+            return [
+                ...collectReturnValues(node.consequent),
+                ...(node.alternate ? collectReturnValues(node.alternate) : []),
+            ];
+        case 'SwitchStatement':
+            return (0, flat_map_1.flatMap)(node.cases, (c) => (0, flat_map_1.flatMap)(c.consequent, collectReturnValues));
+        default:
+            return [];
+    }
+}
+/**
+ * Resolves a JSX component name (e.g. `Buttons` in `<Buttons />`) to the
+ * nodes returned by its local arrow-function definition, if one exists.
+ *
+ * Handles both expression-body (`() => <expr>`) and block-body
+ * (`() => { return <expr>; }`) arrow functions. Imports, class components,
+ * and reassigned variables return null — those stay opaque.
+ */
+function resolveLocalComponent(sourceCode, name, refNode) {
+    let scope = sourceCode.getScope(refNode);
+    while (scope) {
+        const variable = scope.variables.find((v) => v.name === name);
+        if (variable) {
+            if (isReassigned(variable))
+                return null;
+            const def = variable.defs[0];
+            if (!def || def.type !== 'Variable' || !def.node.init)
+                return null;
+            const init = def.node.init;
+            if (init.type !== 'ArrowFunctionExpression')
+                return null;
+            if (init.body.type !== 'BlockStatement')
+                return [init.body];
+            const returns = collectReturnValues(init.body);
+            return returns.length > 0 ? returns : null;
+        }
+        scope = scope.upper;
+    }
+    return null;
+}
+function walkJsxChild(node, visit, sourceCode, visited, shouldSkip) {
+    const walk = (n) => walkJsxChild(n, visit, sourceCode, visited, shouldSkip);
+    switch (node.type) {
+        case 'JSXElement': {
+            if ((0, is_fragment_1.isFragment)(node.openingElement)) {
+                node.children.forEach(walk);
+                return;
+            }
+            if (sourceCode) {
+                const { name } = node.openingElement;
+                if (name.type === 'JSXIdentifier' && !visited.has(name.name)) {
+                    const resolved = resolveLocalComponent(sourceCode, name.name, node.openingElement);
+                    if (resolved !== null) {
+                        visited.add(name.name);
+                        resolved.forEach(walk);
+                        visited.delete(name.name);
+                        return;
+                    }
+                }
+            }
+            if (shouldSkip?.(node)) {
+                node.children.forEach(walk);
+                return;
+            }
+            visit(node);
+            return;
+        }
+        case 'JSXFragment':
+            node.children.forEach(walk);
+            return;
+        case 'JSXExpressionContainer':
+            if (node.expression.type !== 'JSXEmptyExpression')
+                walk(node.expression);
+            return;
+        case 'LogicalExpression':
+            walk(node.left);
+            walk(node.right);
+            return;
+        case 'ConditionalExpression':
+            walk(node.consequent);
+            walk(node.alternate);
+            return;
+        case 'ArrayExpression':
+            node.elements.forEach((el) => {
+                if (el && el.type !== 'SpreadElement')
+                    walk(el);
+            });
+            return;
+        case 'Identifier':
+            if (sourceCode) {
+                const resolved = resolveIdentifierValue(sourceCode, node);
+                if (resolved) {
+                    walk(resolved);
+                    return;
+                }
+            }
+            return;
+        case 'ArrowFunctionExpression':
+            if (node.body.type !== 'BlockStatement') {
+                walk(node.body);
+            }
+            else {
+                collectReturnValues(node.body).forEach(walk);
+            }
+            return;
+        case 'CallExpression': {
+            const { callee, arguments: args } = node;
+            if (callee.type === 'MemberExpression' &&
+                callee.property.type === 'Identifier' &&
+                callee.property.name === 'map' &&
+                args.length >= 1 &&
+                args[0].type === 'ArrowFunctionExpression') {
+                const fn = args[0];
+                if (fn.body.type !== 'BlockStatement') {
+                    walk(fn.body);
+                }
+                else {
+                    collectReturnValues(fn.body).forEach(walk);
+                }
+            }
+            return;
+        }
+        case 'JSXText':
+        case 'Literal':
+        case 'TemplateLiteral':
+        case 'MemberExpression':
+            visit(node);
+            return;
+        default:
+            return;
+    }
+}
+/**
+ * Recursively walks JSX children, expanding structural nodes transparently
+ * and calling `visit` for each content node.
+ *
+ * Always expanded (structural nodes):
+ *  - `<>...</>`, `<Fragment>`, `<React.Fragment>` (transparent grouping)
+ *  - `{expr}`                              (JSXExpressionContainer)
+ *  - `{a && b}`, `{a || b}`, `{a ?? b}`   (LogicalExpression → both sides)
+ *  - `{c ? a : b}`                         (ConditionalExpression → both branches)
+ *  - `{[a, b]}`                            (ArrayExpression → each element)
+ *  - `{(arg) => <El />}`                   (ArrowFunctionExpression)
+ *  - `{arr.map(fn)}`                       (CallExpression `.map()` with arrow-fn callback)
+ *
+ * With `options.sourceCode`: Identifiers and local arrow-fn components are
+ * also expanded via scope lookup when resolvable.
+ *
+ * `options.shouldSkip` - when provided, called for each JSXElement reached
+ * (after fragment and local-component checks). Returning true skips the
+ * element itself and recurses into its children instead. Use this to make
+ * layout wrappers or non-interactive shells transparent to the visitor.
+ *
+ * `visit` is called for leaf nodes: JSXElement, JSXText, Literal,
+ * TemplateLiteral, MemberExpression.
+ */
+function walkJsxChildren(node, visit, options = {}) {
+    walkJsxChild(node, visit, options.sourceCode, new Set(), options.shouldSkip);
+}
+//# sourceMappingURL=walk_jsx_children.js.map

package/lib/esm/utils/walk_jsx_children.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"walk_jsx_children.js","sourceRoot":"","sources":["../../../src/utils/walk_jsx_children.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;AA6NH,0CAeC;AAzOD,yCAAqC;AACrC,+CAA2C;AAE3C,2EAA2E;AAC3E,4EAA4E;AAC5E,SAAS,YAAY,CAAC,QAAiC;IACrD,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AACvE,CAAC;AAED;;;;;GAKG;AACH,SAAS,sBAAsB,CAC7B,UAA+B,EAC/B,IAAyB;IAEzB,IAAI,KAAK,GAAgC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACnE,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC;QAChE,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;YAC9B,IAAI,CAAC,QAAQ,IAAI,YAAY,CAAC,QAAQ,CAAC;gBAAE,OAAO,IAAI,CAAC;YACrD,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI;gBAAE,OAAO,IAAI,CAAC;YACnE,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;QACvB,CAAC;QACD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IACtB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,IAAmB;IAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,gBAAgB;YACnB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;QACjD,KAAK,iBAAiB;YACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,KAAK,aAAa;YAChB,OAAO;gBACL,GAAG,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;gBACvC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;aAC/D,CAAC;QACJ,KAAK,iBAAiB;YACpB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAC/B,IAAA,kBAAO,EAAC,CAAC,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAC3C,CAAC;QACJ;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,qBAAqB,CAC5B,UAA+B,EAC/B,IAAY,EACZ,OAAsB;IAEtB,IAAI,KAAK,GAAgC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACtE,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,YAAY,CAAC,QAAQ,CAAC;gBAAE,OAAO,IAAI,CAAC;YACxC,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI;gBAAE,OAAO,IAAI,CAAC;YACnE,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAyB;gBAAE,OAAO,IAAI,CAAC;YACzD,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,gBAAgB;gBAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5D,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/C,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7C,CAAC;QACD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IACtB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,YAAY,CACnB,IAAmB,EACnB,KAAoC,EACpC,UAA2C,EAC3C,OAAoB,EACpB,UAA8D;IAE9D,MAAM,IAAI,GAAG,CAAC,CAAgB,EAAE,EAAE,CAChC,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IAE1D,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,IAAI,IAAA,wBAAU,EAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;gBACpC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC5B,OAAO;YACT,CAAC;YACD,IAAI,UAAU,EAAE,CAAC;gBACf,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC;gBACrC,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC7D,MAAM,QAAQ,GAAG,qBAAqB,CACpC,UAAU,EACV,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,cAAc,CACpB,CAAC;oBACF,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;wBACtB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACvB,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;wBACvB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBAC1B,OAAO;oBACT,CAAC;gBACH,CAAC;YACH,CAAC;YACD,IAAI,UAAU,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC5B,OAAO;YACT,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,CAAC;YACZ,OAAO;QACT,CAAC;QACD,KAAK,aAAa;YAChB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5B,OAAO;QACT,KAAK,wBAAwB;YAC3B,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,oBAAoB;gBAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACzE,OAAO;QACT,KAAK,mBAAmB;YACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACjB,OAAO;QACT,KAAK,uBAAuB;YAC1B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACrB,OAAO;QACT,KAAK,iBAAiB;YACpB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;gBAC3B,IAAI,EAAE,IAAI,EAAE,CAAC,IAAI,KAAK,eAAe;oBAAE,IAAI,CAAC,EAAE,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;YACH,OAAO;QACT,KAAK,YAAY;YACf,IAAI,UAAU,EAAE,CAAC;gBACf,MAAM,QAAQ,GAAG,sBAAsB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;gBAC1D,IAAI,QAAQ,EAAE,CAAC;oBACb,IAAI,CAAC,QAAQ,CAAC,CAAC;oBACf,OAAO;gBACT,CAAC;YACH,CAAC;YACD,OAAO;QACT,KAAK,yBAAyB;YAC5B,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;gBACxC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC;iBAAM,CAAC;gBACN,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC/C,CAAC;YACD,OAAO;QACT,KAAK,gBAAgB,CAAC,CAAC,CAAC;YACtB,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YACzC,IACE,MAAM,CAAC,IAAI,KAAK,kBAAkB;gBAClC,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY;gBACrC,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK;gBAC9B,IAAI,CAAC,MAAM,IAAI,CAAC;gBAChB,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,yBAAyB,EAC1C,CAAC;gBACD,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACnB,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;oBACtC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC;qBAAM,CAAC;oBACN,mBAAmB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC7C,CAAC;YACH,CAAC;YACD,OAAO;QACT,CAAC;QACD,KAAK,SAAS,CAAC;QACf,KAAK,SAAS,CAAC;QACf,KAAK,iBAAiB,CAAC;QACvB,KAAK,kBAAkB;YACrB,KAAK,CAAC,IAAI,CAAC,CAAC;YACZ,OAAO;QACT;YACE,OAAO;IACX,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,eAAe,CAC7B,IAAmB,EACnB,KAAoC,EACpC,UAGI,EAAE;IAEN,YAAY,CACV,IAAI,EACJ,KAAK,EACL,OAAO,CAAC,UAAU,EAClB,IAAI,GAAG,EAAU,EACjB,OAAO,CAAC,UAAU,CACnB,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/eslint-plugin-eui",
-  "version": "2.15.0",
+  "version": "2.16.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",