@lvce-editor/eslint-plugin-virtual-dom 17.5.0 → 17.7.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$p = {
+const meta$q = {
   docs: {
     description: 'Require a statically determinable accessible name for virtual-dom controls'
   },
@@ -102,7 +102,7 @@ const meta$p = {
   },
   type: 'problem'
 };
-const create$p = context => {
+const create$q = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node) || hasDirectName(node)) {
@@ -144,11 +144,11 @@ const create$p = context => {
 
 const accessibleControlName = {
   __proto__: null,
-  create: create$p,
-  meta: meta$p
+  create: create$q,
+  meta: meta$q
 };
 
-const meta$o = {
+const meta$p = {
   docs: {
     description: 'Require an explicit role on clickable virtual-dom div nodes'
   },
@@ -157,7 +157,7 @@ const meta$o = {
   },
   type: 'problem'
 };
-const create$o = context => {
+const create$p = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node)) {
@@ -179,11 +179,11 @@ const create$o = context => {
 
 const clickableDivNeedsRole = {
   __proto__: null,
-  create: create$o,
-  meta: meta$o
+  create: create$p,
+  meta: meta$p
 };
 
-const meta$n = {
+const meta$o = {
   docs: {
     description: 'Require static virtual-dom nodes created inside functions to be hoisted to module scope'
   },
@@ -221,6 +221,28 @@ const isStaticIdentifier = (sourceCode, node) => {
   const variable = findVariable(sourceCode, node);
   return Boolean(variable && isStaticModuleVariable(variable));
 };
+const isMergeClassNamesImport = variable => {
+  return variable.defs.some(definition => {
+    if (definition.type !== 'ImportBinding' || definition.node.type !== 'ImportSpecifier') {
+      return false;
+    }
+    return (definition.node.imported.type === 'Identifier' ? definition.node.imported.name : definition.node.imported.value) === 'mergeClassNames';
+  });
+};
+const isNamespaceImport = variable => {
+  return variable.defs.some(definition => definition.type === 'ImportBinding' && definition.node.type === 'ImportNamespaceSpecifier');
+};
+const isMergeClassNamesCallee = (sourceCode, node) => {
+  if (node.type === 'Identifier') {
+    const variable = findVariable(sourceCode, node);
+    return Boolean(variable && isMergeClassNamesImport(variable));
+  }
+  if (node.type !== 'MemberExpression' || node.computed || node.object.type !== 'Identifier' || node.property.type !== 'Identifier' || node.property.name !== 'mergeClassNames') {
+    return false;
+  }
+  const variable = findVariable(sourceCode, node.object);
+  return Boolean(variable && isNamespaceImport(variable));
+};
 const isPropertyMutation = (sourceCode, identifier) => {
   const ancestors = sourceCode.getAncestors(identifier);
   let current = identifier;
@@ -276,6 +298,8 @@ const isStaticExpression = (sourceCode, node) => {
     case 'BinaryExpression':
     case 'LogicalExpression':
       return isStaticExpression(sourceCode, node.left) && isStaticExpression(sourceCode, node.right);
+    case 'CallExpression':
+      return isMergeClassNamesCallee(sourceCode, node.callee) && node.arguments.every(argument => argument.type !== 'SpreadElement' && isStaticExpression(sourceCode, argument));
     case 'ConditionalExpression':
       return isStaticExpression(sourceCode, node.test) && isStaticExpression(sourceCode, node.consequent) && isStaticExpression(sourceCode, node.alternate);
     case 'Identifier':
@@ -294,7 +318,7 @@ const isStaticExpression = (sourceCode, node) => {
       return false;
   }
 };
-const create$n = context => {
+const create$o = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomElement(node)) {
@@ -319,11 +343,11 @@ const create$n = context => {
 
 const hoistStaticNodes = {
   __proto__: null,
-  create: create$n,
-  meta: meta$n
+  create: create$o,
+  meta: meta$o
 };
 
-const meta$m = {
+const meta$n = {
   docs: {
     description: 'Disallow conditional spreads in virtual-dom arrays'
   },
@@ -341,7 +365,7 @@ const isVirtualDomArray$1 = node => {
 const addsVirtualDomChildren = spread => {
   return isVirtualDomArray$1(spread.argument.consequent) || isVirtualDomArray$1(spread.argument.alternate);
 };
-const create$m = context => {
+const create$n = context => {
   return {
     ArrayExpression(node) {
       const conditionalSpreads = node.elements.filter(isConditionalSpread);
@@ -360,11 +384,11 @@ const create$m = context => {
 
 const noConditionalSpread = {
   __proto__: null,
-  create: create$m,
-  meta: meta$m
+  create: create$n,
+  meta: meta$n
 };
 
-const meta$l = {
+const meta$m = {
   docs: {
     description: 'Disallow empty ARIA values in virtual-dom nodes'
   },
@@ -376,7 +400,7 @@ const meta$l = {
 const isAriaProperty = name => {
   return /^aria[A-Z]/.test(name);
 };
-const create$l = context => {
+const create$m = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node)) {
@@ -401,11 +425,11 @@ const create$l = context => {
 
 const noEmptyAria = {
   __proto__: null,
-  create: create$l,
-  meta: meta$l
+  create: create$m,
+  meta: meta$m
 };
 
-const meta$k = {
+const meta$l = {
   docs: {
     description: 'Disallow empty className values in virtual-dom nodes'
   },
@@ -414,7 +438,7 @@ const meta$k = {
   },
   type: 'problem'
 };
-const create$k = context => {
+const create$l = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node)) {
@@ -434,11 +458,11 @@ const create$k = context => {
 
 const noEmptyClassName = {
   __proto__: null,
-  create: create$k,
-  meta: meta$k
+  create: create$l,
+  meta: meta$l
 };
 
-const meta$j = {
+const meta$k = {
   docs: {
     description: 'Disallow inline event handlers in virtual-dom nodes'
   },
@@ -453,7 +477,7 @@ const isEventPropertyName = name => {
 const isInlineEventHandler = node => {
   return isStringLiteral(node) || isTemplateLiteralNode(node) || isArrowFunctionExpressionNode(node) || isFunctionExpressionNode(node);
 };
-const create$j = context => {
+const create$k = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node)) {
@@ -478,11 +502,11 @@ const create$j = context => {
 
 const noInlineEventHandlers = {
   __proto__: null,
-  create: create$j,
-  meta: meta$j
+  create: create$k,
+  meta: meta$k
 };
 
-const meta$i = {
+const meta$j = {
   docs: {
     description: 'Disallow inline style attributes in virtual-dom nodes'
   },
@@ -491,7 +515,7 @@ const meta$i = {
   },
   type: 'problem'
 };
-const create$i = context => {
+const create$j = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node)) {
@@ -511,8 +535,8 @@ const create$i = context => {
 
 const noInlineStyle = {
   __proto__: null,
-  create: create$i,
-  meta: meta$i
+  create: create$j,
+  meta: meta$j
 };
 
 const ignoredProperties$1 = new Set(['childCount', 'type']);
@@ -522,7 +546,7 @@ const isOptionalExpression = node => {
 const isNullish = node => {
   return isLiteralNode(node) && node.value === null || isIdentifierNode(node) && node.name === 'undefined' || isOptionalExpression(node);
 };
-const meta$h = {
+const meta$i = {
   docs: {
     description: 'Disallow nullish virtual-dom attribute values'
   },
@@ -531,7 +555,7 @@ const meta$h = {
   },
   type: 'problem'
 };
-const create$h = context => {
+const create$i = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node)) {
@@ -559,11 +583,11 @@ const create$h = context => {
 
 const noNullishAttributeValues = {
   __proto__: null,
-  create: create$h,
-  meta: meta$h
+  create: create$i,
+  meta: meta$i
 };
 
-const meta$g = {
+const meta$h = {
   docs: {
     description: 'Disallow object-like attribute values in virtual-dom nodes'
   },
@@ -576,7 +600,7 @@ const ignoredProperties = new Set(['childCount', 'type']);
 const isObjectLikeAttributeValue = node => {
   return isObjectExpressionNode(node) || isArrayExpressionNode(node) || isArrowFunctionExpressionNode(node) || isFunctionExpressionNode(node);
 };
-const create$g = context => {
+const create$h = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node)) {
@@ -601,11 +625,11 @@ const create$g = context => {
 
 const noObjectAttributeValues = {
   __proto__: null,
-  create: create$g,
-  meta: meta$g
+  create: create$h,
+  meta: meta$h
 };
 
-const meta$f = {
+const meta$g = {
   docs: {
     description: 'Disallow positive virtual-dom tabIndex values'
   },
@@ -614,7 +638,7 @@ const meta$f = {
   },
   type: 'problem'
 };
-const create$f = context => {
+const create$g = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node)) {
@@ -635,11 +659,11 @@ const create$f = context => {
 
 const noPositiveTabIndex = {
   __proto__: null,
-  create: create$f,
-  meta: meta$f
+  create: create$g,
+  meta: meta$g
 };
 
-const meta$e = {
+const meta$f = {
   docs: {
     description: 'Disallow raw string children in virtual-dom arrays'
   },
@@ -651,7 +675,7 @@ const meta$e = {
 const isVirtualDomArray = node => {
   return isArrayExpressionNode(node) && node.elements.some(element => isVirtualDomNode(element) || isTextCall(element));
 };
-const create$e = context => {
+const create$f = context => {
   return {
     ArrayExpression(node) {
       if (!isVirtualDomArray(node)) {
@@ -672,11 +696,11 @@ const create$e = context => {
 
 const noRawTextChildren = {
   __proto__: null,
-  create: create$e,
-  meta: meta$e
+  create: create$f,
+  meta: meta$f
 };
 
-const meta$d = {
+const meta$e = {
   docs: {
     description: 'Require each virtual-dom event listener to call its dedicated handler'
   },
@@ -685,7 +709,7 @@ const meta$d = {
   },
   type: 'problem'
 };
-const create$d = context => {
+const create$e = context => {
   return {
     ObjectExpression(node) {
       if (!isObjectExpressionNode(node)) {
@@ -715,11 +739,11 @@ const create$d = context => {
 
 const noSharedEventListenerHandlers = {
   __proto__: null,
-  create: create$d,
-  meta: meta$d
+  create: create$e,
+  meta: meta$e
 };
 
-const meta$c = {
+const meta$d = {
   docs: {
     description: 'Prefer constants for single literal virtual-dom class names'
   },
@@ -728,7 +752,7 @@ const meta$c = {
   },
   type: 'suggestion'
 };
-const create$c = context => {
+const create$d = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node)) {
@@ -748,11 +772,11 @@ const create$c = context => {
 
 const preferClassNameConstants = {
   __proto__: null,
-  create: create$c,
-  meta: meta$c
+  create: create$d,
+  meta: meta$d
 };
 
-const meta$b = {
+const meta$c = {
   docs: {
     description: 'Prefer virtual-dom constants over raw type, role, aria boolean, and tabIndex values'
   },
@@ -768,7 +792,7 @@ const meta$b = {
 const isAriaBooleanProperty = name => {
   return /^aria[A-Z]/.test(name);
 };
-const create$b = context => {
+const create$c = context => {
   return {
     ObjectExpression(node) {
       if (!isVirtualDomNode(node)) {
@@ -822,6 +846,65 @@ const create$b = context => {
 };
 
 const preferConstants = {
+  __proto__: null,
+  create: create$c,
+  meta: meta$c
+};
+
+const meta$b = {
+  docs: {
+    description: 'Prefer destructuring layout properties before use'
+  },
+  messages: {
+    preferLayoutDestructuring: 'Prefer destructuring from layout instead of using layout.{{property}}.'
+  },
+  type: 'suggestion'
+};
+const isIdentifier$1 = node => {
+  return node?.type === 'Identifier';
+};
+const isWriteExpression$1 = node => {
+  const {
+    parent
+  } = node;
+  if (!parent) {
+    return false;
+  }
+  if (parent.type === 'AssignmentExpression' && parent.left === node) {
+    return true;
+  }
+  if (parent.type === 'UpdateExpression' && parent.argument === node) {
+    return true;
+  }
+  return parent.type === 'UnaryExpression' && parent.operator === 'delete' && parent.argument === node;
+};
+const create$b = context => {
+  return {
+    MemberExpression(node) {
+      if (node.computed) {
+        return;
+      }
+      if (!isIdentifier$1(node.object) || node.object.name !== 'layout') {
+        return;
+      }
+      if (!isIdentifier$1(node.property)) {
+        return;
+      }
+      if (isWriteExpression$1(node)) {
+        return;
+      }
+      context.report({
+        data: {
+          property: node.property.name
+        },
+        messageId: 'preferLayoutDestructuring',
+        node
+      });
+    }
+  };
+};
+
+const preferLayoutDestructuring = {
   __proto__: null,
   create: create$b,
   meta: meta$b
@@ -1450,6 +1533,7 @@ const plugin = {
     'no-shared-event-listener-handlers': noSharedEventListenerHandlers,
     'prefer-class-name-constants': preferClassNameConstants,
     'prefer-constants': preferConstants,
+    'prefer-layout-destructuring': preferLayoutDestructuring,
     'prefer-lazy-date-time-format': preferLazyDateTimeFormat,
     'prefer-merge-class-names': preferMergeClassNames,
     'prefer-state-destructuring': preferStateDestructuring,
@@ -1480,6 +1564,7 @@ const recommended = [{
     'virtual-dom/no-raw-text-children': 'error',
     'virtual-dom/no-shared-event-listener-handlers': 'error',
     'virtual-dom/prefer-constants': 'error',
+    'virtual-dom/prefer-layout-destructuring': 'error',
     'virtual-dom/prefer-lazy-date-time-format': 'error',
     'virtual-dom/prefer-merge-class-names': 'error',
     'virtual-dom/prefer-state-destructuring': 'error',

package/package.json

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