@lvce-editor/eslint-plugin-e2e 13.2.0 → 13.4.0

package/dist/index.js

@@ -1,4 +1,4 @@
-const meta$4 = {
+const meta$5 = {
   docs: {
     description: 'Disallow direct click calls in E2E tests'
   },
@@ -10,7 +10,7 @@ const meta$4 = {
 const isDirectClickCall = node => {
   return node.callee.type === 'MemberExpression' && node.callee.property.type === 'Identifier' && node.callee.property.name === 'click';
 };
-const create$4 = context => {
+const create$5 = context => {
   return {
     CallExpression(node) {
       if (!isDirectClickCall(node)) {
@@ -26,11 +26,11 @@ const create$4 = context => {
 
 const noDirectClick = {
   __proto__: null,
-  create: create$4,
-  meta: meta$4
+  create: create$5,
+  meta: meta$5
 };
 
-const meta$3 = {
+const meta$4 = {
   docs: {
     description: 'Disallow inline locator expressions inside expect calls'
   },
@@ -42,7 +42,7 @@ const meta$3 = {
 const isCallExpressionNode$2 = node => {
   return typeof node === 'object' && node !== null && 'type' in node && node.type === 'CallExpression' && 'callee' in node && 'arguments' in node;
 };
-const isIdentifierNode$2 = node => {
+const isIdentifierNode$3 = node => {
   return typeof node === 'object' && node !== null && 'type' in node && node.type === 'Identifier' && 'name' in node;
 };
 const isMemberExpressionNode$2 = node => {
@@ -58,7 +58,7 @@ const isTsNonNullExpression = node => {
   return typeof node === 'object' && node !== null && 'type' in node && node.type === 'TSNonNullExpression' && 'expression' in node;
 };
 const isLocatorCall = node => {
-  return isCallExpressionNode$2(node) && isIdentifierNode$2(node.callee) && node.callee.name === 'Locator';
+  return isCallExpressionNode$2(node) && isIdentifierNode$3(node.callee) && node.callee.name === 'Locator';
 };
 const containsInlineLocatorCall = node => {
   if (!node) {
@@ -87,7 +87,7 @@ const containsInlineLocatorCall = node => {
 const isExpectCall$1 = node => {
   return node.callee.type === 'Identifier' && node.callee.name === 'expect';
 };
-const create$3 = context => {
+const create$4 = context => {
   return {
     CallExpression(node) {
       if (!isExpectCall$1(node)) {
@@ -107,11 +107,11 @@ const create$3 = context => {
 
 const noInlineLocatorInExpect = {
   __proto__: null,
-  create: create$3,
-  meta: meta$3
+  create: create$4,
+  meta: meta$4
 };
 
-const meta$2 = {
+const meta$3 = {
   docs: {
     description: 'Disallow inline nth locator expressions inside expect calls'
   },
@@ -123,7 +123,7 @@ const meta$2 = {
 const isCallExpressionNode$1 = node => {
   return typeof node === 'object' && node !== null && 'type' in node && node.type === 'CallExpression' && 'callee' in node && 'arguments' in node;
 };
-const isIdentifierNode$1 = node => {
+const isIdentifierNode$2 = node => {
   return typeof node === 'object' && node !== null && 'type' in node && node.type === 'Identifier' && 'name' in node;
 };
 const isMemberExpressionNode$1 = node => {
@@ -142,7 +142,7 @@ const isTsNonNullExpressionNode$1 = node => {
   return typeof node === 'object' && node !== null && 'type' in node && node.type === 'TSNonNullExpression' && 'expression' in node;
 };
 const isNthCall$1 = node => {
-  return isCallExpressionNode$1(node) && isMemberExpressionNode$1(node.callee) && !node.callee.computed && isIdentifierNode$1(node.callee.property) && node.callee.property.name === 'nth';
+  return isCallExpressionNode$1(node) && isMemberExpressionNode$1(node.callee) && !node.callee.computed && isIdentifierNode$2(node.callee.property) && node.callee.property.name === 'nth';
 };
 const containsInlineNthCall = node => {
   if (!node) {
@@ -174,7 +174,7 @@ const containsInlineNthCall = node => {
 const isExpectCall = node => {
   return node.callee.type === 'Identifier' && node.callee.name === 'expect';
 };
-const create$2 = context => {
+const create$3 = context => {
   return {
     CallExpression(node) {
       if (!isExpectCall(node)) {
@@ -194,11 +194,11 @@ const create$2 = context => {
 
 const noInlineNthInExpect = {
   __proto__: null,
-  create: create$2,
-  meta: meta$2
+  create: create$3,
+  meta: meta$3
 };
 
-const meta$1 = {
+const meta$2 = {
   docs: {
     description: 'Disallow lazy nth-based variable names for locator variables'
   },
@@ -208,10 +208,10 @@ const meta$1 = {
   type: 'problem'
 };
 const lazyNthVariableNamePattern = /nth\d+/i;
-const isIdentifierNode = node => {
+const isIdentifierNode$1 = node => {
   return typeof node === 'object' && node !== null && 'type' in node && node.type === 'Identifier' && 'name' in node;
 };
-const isVariableDeclaratorNode = node => {
+const isVariableDeclaratorNode$1 = node => {
   return typeof node === 'object' && node !== null && 'type' in node && node.type === 'VariableDeclarator' && 'id' in node && 'init' in node;
 };
 const isCallExpressionNode = node => {
@@ -230,7 +230,7 @@ const isTsNonNullExpressionNode = node => {
   return typeof node === 'object' && node !== null && 'type' in node && node.type === 'TSNonNullExpression' && 'expression' in node;
 };
 const isNthCall = node => {
-  return isCallExpressionNode(node) && isMemberExpressionNode(node.callee) && !node.callee.computed && isIdentifierNode(node.callee.property) && node.callee.property.name === 'nth';
+  return isCallExpressionNode(node) && isMemberExpressionNode(node.callee) && !node.callee.computed && isIdentifierNode$1(node.callee.property) && node.callee.property.name === 'nth';
 };
 const containsNthCall = node => {
   if (!node) {
@@ -257,12 +257,12 @@ const containsNthCall = node => {
   return false;
 };
 const hasLazyNthVariableName = node => {
-  return isIdentifierNode(node) && lazyNthVariableNamePattern.test(node.name);
+  return isIdentifierNode$1(node) && lazyNthVariableNamePattern.test(node.name);
 };
-const create$1 = context => {
+const create$2 = context => {
   return {
     VariableDeclarator(node) {
-      if (!isVariableDeclaratorNode(node)) {
+      if (!isVariableDeclaratorNode$1(node)) {
         return;
       }
       if (!hasLazyNthVariableName(node.id)) {
@@ -280,6 +280,67 @@ const create$1 = context => {
 };
 
 const noLazyNthVariableName = {
+  __proto__: null,
+  create: create$2,
+  meta: meta$2
+};
+
+const meta$1 = {
+  docs: {
+    description: 'Prefer destructuring e2e test api parameters directly'
+  },
+  messages: {
+    preferDirectApiDestructuring: 'Destructure the e2e test api in the parameter list instead of from api inside the function body.'
+  },
+  type: 'problem'
+};
+const isIdentifierNode = node => {
+  return typeof node === 'object' && node !== null && 'type' in node && node.type === 'Identifier' && 'name' in node;
+};
+const isObjectPatternNode = node => {
+  return typeof node === 'object' && node !== null && 'type' in node && node.type === 'ObjectPattern';
+};
+const isVariableDeclaratorNode = node => {
+  return typeof node === 'object' && node !== null && 'type' in node && node.type === 'VariableDeclarator' && 'id' in node && 'init' in node;
+};
+const getParameterNames = node => {
+  return node.params.filter(isIdentifierNode).map(param => param.name);
+};
+const create$1 = context => {
+  const functionParameterNames = [];
+  const enterFunction = node => {
+    functionParameterNames.push([...getParameterNames(node)]);
+  };
+  const exitFunction = () => {
+    functionParameterNames.pop();
+  };
+  return {
+    ArrowFunctionExpression: enterFunction,
+    'ArrowFunctionExpression:exit': exitFunction,
+    FunctionDeclaration: enterFunction,
+    'FunctionDeclaration:exit': exitFunction,
+    FunctionExpression: enterFunction,
+    'FunctionExpression:exit': exitFunction,
+    VariableDeclarator(node) {
+      if (!isVariableDeclaratorNode(node)) {
+        return;
+      }
+      if (!isObjectPatternNode(node.id) || !isIdentifierNode(node.init)) {
+        return;
+      }
+      const currentFunctionParameterNames = functionParameterNames.at(-1);
+      if (!currentFunctionParameterNames?.includes(node.init.name)) {
+        return;
+      }
+      context.report({
+        messageId: 'preferDirectApiDestructuring',
+        node: node.id
+      });
+    }
+  };
+};
+
+const preferDirectApiDestructuring = {
   __proto__: null,
   create: create$1,
   meta: meta$1
@@ -340,6 +401,7 @@ const plugin = {
     'no-inline-locator-in-expect': noInlineLocatorInExpect,
     'no-inline-nth-in-expect': noInlineNthInExpect,
     'no-lazy-nth-variable-name': noLazyNthVariableName,
+    'prefer-direct-api-destructuring': preferDirectApiDestructuring,
     'prefer-import-meta-resolve': preferImportMetaResolve
   }
 };
@@ -353,6 +415,7 @@ const recommended = [{
     'e2e/no-inline-locator-in-expect': 'error',
     'e2e/no-inline-nth-in-expect': 'error',
     'e2e/no-lazy-nth-variable-name': 'error',
+    'e2e/prefer-direct-api-destructuring': 'error',
     'e2e/prefer-import-meta-resolve': 'error'
   }
 }];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/eslint-plugin-e2e",
-  "version": "13.2.0",
+  "version": "13.4.0",
   "main": "dist/index.js",
   "repository": {
     "type": "git",