@lvce-editor/eslint-plugin-e2e 18.2.0 → 18.4.0

package/dist/index.js

@@ -1,4 +1,4 @@
-const meta$a = {
+const meta$d = {
   docs: {
     description: 'Disallow direct click calls in E2E tests'
   },
@@ -10,7 +10,7 @@ const meta$a = {
 const isDirectClickCall = node => {
   return node.callee.type === 'MemberExpression' && node.callee.property.type === 'Identifier' && node.callee.property.name === 'click';
 };
-const create$a = context => {
+const create$d = context => {
   return {
     CallExpression(node) {
       if (!isDirectClickCall(node)) {
@@ -26,12 +26,59 @@ const create$a = context => {
 
 const noDirectClick = {
   __proto__: null,
-  create: create$a,
-  meta: meta$a
+  create: create$d,
+  meta: meta$d
+};
+
+const meta$c = {
+  docs: {
+    description: 'Disallow disabling the memory clipboard in finally blocks'
+  },
+  messages: {
+    noDisableMemoryClipBoardInFinally: 'Do not call ClipBoard.disableMemoryClipBoard() in a finally block. The memory clipboard is disabled automatically after each test.'
+  },
+  type: 'problem'
+};
+const isDisableMemoryClipBoardCall = node => {
+  const {
+    callee
+  } = node;
+  return callee.type === 'MemberExpression' && callee.object.type === 'Identifier' && callee.object.name === 'ClipBoard' && callee.property.type === 'Identifier' && callee.property.name === 'disableMemoryClipBoard';
+};
+const isInFinallyBlock = (context, node) => {
+  const ancestors = context.sourceCode.getAncestors(node);
+  return ancestors.some(ancestor => {
+    if (ancestor.type !== 'TryStatement') {
+      return false;
+    }
+    const {
+      finalizer
+    } = ancestor;
+    return finalizer !== null && finalizer !== undefined && ancestors.includes(finalizer);
+  });
+};
+const create$c = context => {
+  return {
+    CallExpression(node) {
+      if (!isDisableMemoryClipBoardCall(node) || !isInFinallyBlock(context, node)) {
+        return;
+      }
+      context.report({
+        messageId: 'noDisableMemoryClipBoardInFinally',
+        node
+      });
+    }
+  };
+};
+
+const noDisableMemoryClipBoardInFinally = {
+  __proto__: null,
+  create: create$c,
+  meta: meta$c
 };
 
 const allowedTypeImportSource = '@lvce-editor/test-with-playwright';
-const meta$9 = {
+const meta$b = {
   docs: {
     description: 'Disallow imports in e2e tests except type imports from @lvce-editor/test-with-playwright'
   },
@@ -49,7 +96,7 @@ const isAllowedTypeImport = node => {
   }
   return node.specifiers.length > 0 && node.specifiers.every(specifier => specifier.importKind === 'type');
 };
-const create$9 = context => {
+const create$b = context => {
   return {
     ImportDeclaration(node) {
       if (isAllowedTypeImport(node)) {
@@ -65,11 +112,53 @@ const create$9 = context => {
 
 const noImports = {
   __proto__: null,
-  create: create$9,
-  meta: meta$9
+  create: create$b,
+  meta: meta$b
 };
 
-const meta$8 = {
+const meta$a = {
+  docs: {
+    description: 'Disallow inline import.meta.resolve calls in Main.openUri calls'
+  },
+  messages: {
+    noInlineImportMetaResolveInOpenUri: 'Assign import.meta.resolve(...) to a variable before passing the URI to Main.openUri(...).'
+  },
+  type: 'problem'
+};
+const isIdentifier$3 = (node, name) => {
+  return node.type === 'Identifier' && node.name === name;
+};
+const isImportMeta$1 = node => {
+  return node.type === 'MetaProperty' && isIdentifier$3(node.meta, 'import') && isIdentifier$3(node.property, 'meta');
+};
+const isImportMetaResolveCall = node => {
+  return node.type === 'CallExpression' && node.callee.type === 'MemberExpression' && !node.callee.computed && isImportMeta$1(node.callee.object) && isIdentifier$3(node.callee.property, 'resolve');
+};
+const isMainOpenUriCall = node => {
+  return node.callee.type === 'MemberExpression' && !node.callee.computed && isIdentifier$3(node.callee.object, 'Main') && isIdentifier$3(node.callee.property, 'openUri');
+};
+const create$a = context => {
+  return {
+    CallExpression(node) {
+      const [uri] = node.arguments;
+      if (!isMainOpenUriCall(node) || !uri || !isImportMetaResolveCall(uri)) {
+        return;
+      }
+      context.report({
+        messageId: 'noInlineImportMetaResolveInOpenUri',
+        node: uri
+      });
+    }
+  };
+};
+
+const noInlineImportMetaResolveInOpenUri = {
+  __proto__: null,
+  create: create$a,
+  meta: meta$a
+};
+
+const meta$9 = {
   docs: {
     description: 'Disallow inline locator expressions inside expect calls'
   },
@@ -126,7 +215,7 @@ const containsInlineLocatorCall = node => {
 const isExpectCall$2 = node => {
   return node.callee.type === 'Identifier' && node.callee.name === 'expect';
 };
-const create$8 = context => {
+const create$9 = context => {
   return {
     CallExpression(node) {
       if (!isExpectCall$2(node)) {
@@ -146,11 +235,11 @@ const create$8 = context => {
 
 const noInlineLocatorInExpect = {
   __proto__: null,
-  create: create$8,
-  meta: meta$8
+  create: create$9,
+  meta: meta$9
 };
 
-const meta$7 = {
+const meta$8 = {
   docs: {
     description: 'Disallow inline nth locator expressions inside expect calls'
   },
@@ -213,7 +302,7 @@ const containsInlineNthCall = node => {
 const isExpectCall$1 = node => {
   return node.callee.type === 'Identifier' && node.callee.name === 'expect';
 };
-const create$7 = context => {
+const create$8 = context => {
   return {
     CallExpression(node) {
       if (!isExpectCall$1(node)) {
@@ -233,11 +322,11 @@ const create$7 = context => {
 
 const noInlineNthInExpect = {
   __proto__: null,
-  create: create$7,
-  meta: meta$7
+  create: create$8,
+  meta: meta$8
 };
 
-const meta$6 = {
+const meta$7 = {
   docs: {
     description: 'Disallow lazy nth-based variable names for locator variables'
   },
@@ -298,7 +387,7 @@ const containsNthCall = node => {
 const hasLazyNthVariableName = node => {
   return isIdentifierNode$1(node) && lazyNthVariableNamePattern.test(node.name);
 };
-const create$6 = context => {
+const create$7 = context => {
   return {
     VariableDeclarator(node) {
       if (!isVariableDeclaratorNode$1(node)) {
@@ -319,6 +408,57 @@ const create$6 = context => {
 };
 
 const noLazyNthVariableName = {
+  __proto__: null,
+  create: create$7,
+  meta: meta$7
+};
+
+const meta$6 = {
+  docs: {
+    description: 'Disallow clicking context menu item locators directly in E2E tests'
+  },
+  messages: {
+    noMenuItemClick: 'Do not call .click() on a .MenuItem locator. Use ContextMenu.selectItem(...) instead.'
+  },
+  type: 'problem'
+};
+const isMenuItemLocatorCall = node => {
+  if (node.type !== 'CallExpression') {
+    return false;
+  }
+  if (node.callee.type === 'Identifier' && node.callee.name === 'Locator') {
+    const [selector] = node.arguments;
+    return selector?.type === 'Literal' && selector.value === '.MenuItem';
+  }
+  return node.callee.type === 'MemberExpression' && node.callee.object.type !== 'Super' && isMenuItemLocatorCall(node.callee.object);
+};
+const isClickCall = node => {
+  return node.callee.type === 'MemberExpression' && node.callee.property.type === 'Identifier' && node.callee.property.name === 'click';
+};
+const create$6 = context => {
+  const menuItemLocators = new Set();
+  return {
+    CallExpression(node) {
+      if (!isClickCall(node) || node.callee.object.type === 'Super') {
+        return;
+      }
+      const locator = node.callee.object;
+      if (locator.type === 'Identifier' && menuItemLocators.has(locator.name) || isMenuItemLocatorCall(locator)) {
+        context.report({
+          messageId: 'noMenuItemClick',
+          node: node.callee.property
+        });
+      }
+    },
+    VariableDeclarator(node) {
+      if (node.id.type === 'Identifier' && node.init && isMenuItemLocatorCall(node.init)) {
+        menuItemLocators.add(node.id.name);
+      }
+    }
+  };
+};
+
+const noMenuItemClick = {
   __proto__: null,
   create: create$6,
   meta: meta$6
@@ -649,10 +789,13 @@ const plugin = {
   },
   rules: {
     'no-direct-click': noDirectClick,
+    'no-disable-memory-clipboard-in-finally': noDisableMemoryClipBoardInFinally,
     'no-imports': noImports,
+    'no-inline-import-meta-resolve-in-open-uri': noInlineImportMetaResolveInOpenUri,
     'no-inline-locator-in-expect': noInlineLocatorInExpect,
     'no-inline-nth-in-expect': noInlineNthInExpect,
     'no-lazy-nth-variable-name': noLazyNthVariableName,
+    'no-menu-item-click': noMenuItemClick,
     'no-skip-zero': noSkipZero,
     'prefer-direct-api-destructuring': preferDirectApiDestructuring,
     'prefer-execute-extension-command': preferExecuteExtensionCommand,
@@ -668,10 +811,13 @@ const recommended = [{
   },
   rules: {
     'e2e/no-direct-click': 'error',
+    'e2e/no-disable-memory-clipboard-in-finally': 'error',
     'e2e/no-imports': 'error',
+    'e2e/no-inline-import-meta-resolve-in-open-uri': 'error',
     'e2e/no-inline-locator-in-expect': 'error',
     'e2e/no-inline-nth-in-expect': 'error',
     'e2e/no-lazy-nth-variable-name': 'error',
+    'e2e/no-menu-item-click': 'error',
     'e2e/no-skip-zero': 'error',
     'e2e/prefer-direct-api-destructuring': 'error',
     'e2e/prefer-execute-extension-command': 'error',

package/package.json

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