@lvce-editor/eslint-plugin-virtual-dom 18.10.0 → 18.11.0

package/dist/index.js

@@ -93,7 +93,7 @@ const controlsAllowingChildren = new Set(['A', 'Button']);
 const hasDirectName = node => {
   return Boolean(getProperty(node, 'ariaLabel') || getProperty(node, 'ariaLabelledBy') || getProperty(node, 'title'));
 };
-const meta$u = {
+const meta$v = {
   docs: {
     description: 'Require a statically determinable accessible name for virtual-dom controls'
   },
@@ -102,7 +102,7 @@ const meta$u = {
   },
   type: 'problem'
 };
-const create$u = context => {
+const create$v = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node) || hasDirectName(node)) {
@@ -144,11 +144,11 @@ const create$u = context => {
 
 const accessibleControlName = {
   __proto__: null,
-  create: create$u,
-  meta: meta$u
+  create: create$v,
+  meta: meta$v
 };
 
-const meta$t = {
+const meta$u = {
   docs: {
     description: 'Require an explicit role on clickable virtual-dom div nodes'
   },
@@ -157,7 +157,7 @@ const meta$t = {
   },
   type: 'problem'
 };
-const create$t = context => {
+const create$u = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node)) {
@@ -178,6 +178,108 @@ const create$t = context => {
 };
 
 const clickableDivNeedsRole = {
+  __proto__: null,
+  create: create$u,
+  meta: meta$u
+};
+
+const meta$t = {
+  docs: {
+    description: 'Require static mergeClassNames calls inside functions to be hoisted to module scope'
+  },
+  messages: {
+    hoistClassNames: 'Hoist this static mergeClassNames call to module scope.'
+  },
+  type: 'suggestion'
+};
+const findVariable$1 = (sourceCode, node) => {
+  let scope = sourceCode.getScope(node);
+  while (scope) {
+    const variable = scope.set.get(node.name);
+    if (variable) {
+      return variable;
+    }
+    scope = scope.upper;
+  }
+  return undefined;
+};
+const isMergeClassNames = (sourceCode, node) => {
+  if (node.type === 'Identifier') {
+    return Boolean(findVariable$1(sourceCode, node)?.defs.some(definition => {
+      return definition.type === 'ImportBinding' && definition.node.type === 'ImportSpecifier' && (definition.node.imported.type === 'Identifier' ? definition.node.imported.name : definition.node.imported.value) === 'mergeClassNames';
+    }));
+  }
+  if (node.type !== 'MemberExpression' || node.computed || node.optional || node.object.type !== 'Identifier' || node.property.type !== 'Identifier' || node.property.name !== 'mergeClassNames') {
+    return false;
+  }
+  return Boolean(findVariable$1(sourceCode, node.object)?.defs.some(definition => {
+    return definition.type === 'ImportBinding' && definition.node.type === 'ImportNamespaceSpecifier';
+  }));
+};
+const isStatic = (sourceCode, node, seen = new Set()) => {
+  switch (node.type) {
+    case 'BinaryExpression':
+      return node.operator === '+' && isStatic(sourceCode, node.left, seen) && isStatic(sourceCode, node.right, seen);
+    case 'Identifier':
+      {
+        const variable = findVariable$1(sourceCode, node);
+        if (!variable || variable.scope.type !== 'module' || seen.has(variable)) {
+          return false;
+        }
+        const definition = variable.defs[0];
+        if (definition?.type !== 'Variable' || definition.parent.kind !== 'const' || !definition.node.init) {
+          return false;
+        }
+        return isStatic(sourceCode, definition.node.init, new Set([...seen, variable]));
+      }
+    case 'Literal':
+      return typeof node.value === 'string';
+    case 'MemberExpression':
+      {
+        // Class-name modules export constants. Do not assume arbitrary object properties are immutable.
+        if (node.computed || node.optional || node.object.type !== 'Identifier') {
+          return false;
+        }
+        const variable = findVariable$1(sourceCode, node.object);
+        return Boolean(variable?.defs.some(definition => {
+          if (definition.type !== 'ImportBinding') {
+            return false;
+          }
+          if (definition.node.type === 'ImportNamespaceSpecifier') {
+            return /(?:^|\/)ClassNames\.(?:js|ts)$/.test(String(definition.parent.source.value));
+          }
+          return definition.node.type === 'ImportSpecifier' && definition.node.imported.type === 'Identifier' && definition.node.imported.name === 'ClassNames' && definition.parent.source.value === '@lvce-editor/virtual-dom-worker';
+        }));
+      }
+    case 'TemplateLiteral':
+      return node.expressions.every(expression => isStatic(sourceCode, expression, seen));
+    default:
+      return false;
+  }
+};
+const create$t = context => {
+  return {
+    CallExpression(node) {
+      if (node.type !== 'CallExpression' || node.optional || !isMergeClassNames(context.sourceCode, node.callee)) {
+        return;
+      }
+      if (context.sourceCode.getAncestors(node).every(ancestor => {
+        return !['ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression'].includes(ancestor.type);
+      })) {
+        return;
+      }
+      if (node.arguments.some(argument => !isStatic(context.sourceCode, argument))) {
+        return;
+      }
+      context.report({
+        messageId: 'hoistClassNames',
+        node
+      });
+    }
+  };
+};
+
+const hoistClassNames = {
   __proto__: null,
   create: create$t,
   meta: meta$t
@@ -1664,6 +1766,7 @@ const plugin = {
   rules: {
     'accessible-control-name': accessibleControlName,
     'clickable-div-needs-role': clickableDivNeedsRole,
+    'hoist-class-names': hoistClassNames,
     'hoist-static-nodes': hoistStaticNodes,
     'no-conditional-spread': noConditionalSpread,
     'no-element-helper': noElementHelper,
@@ -1702,6 +1805,7 @@ const recommended = [{
   },
   rules: {
     'virtual-dom/clickable-div-needs-role': 'error',
+    'virtual-dom/hoist-class-names': 'error',
     'virtual-dom/hoist-static-nodes': 'error',
     'virtual-dom/no-conditional-spread': 'error',
     'virtual-dom/no-element-helper': 'error',
@@ -1727,6 +1831,7 @@ const recommended = [{
 }, {
   files: ['**/test/**/*.{js,mjs,cjs,ts,mts,cts}', '**/tests/**/*.{js,mjs,cjs,ts,mts,cts}', '**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts}'],
   rules: {
+    'virtual-dom/hoist-class-names': 'off',
     'virtual-dom/hoist-static-nodes': 'off',
     'virtual-dom/prefer-merge-class-names': 'off'
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/eslint-plugin-virtual-dom",
-  "version": "18.10.0",
+  "version": "18.11.0",
   "main": "dist/index.js",
   "repository": {
     "type": "git",