eslint-config-seek 0.0.0-cypress-fork-20230524064546 → 0.0.0-rulesdir-20230604234812

package/base.js

@@ -4,6 +4,9 @@ const root = require('find-root')(process.cwd());
 const OFF = 0;
 const ERROR = 2;
 
+const rulesDirPlugin = require('eslint-plugin-rulesdir');
+rulesDirPlugin.RULES_DIR = 'rules'; // (an example folder where your rules might be stored)
+
 const baseRules = {
   // Possible Errors
   'no-console': ERROR,
@@ -210,13 +213,16 @@ const baseConfig = {
     {
       // Cypress config
       files: [`**/cypress/**/*.{${allExtensions}}`],
+      // eslint-plugin-cypress doesn't support ESLint v8.
+      // Use fork by `@finsit` until this is solved.
+      // https://github.com/cypress-io/eslint-plugin-cypress/issues/89
+      extends: ['plugin:@finsit/cypress/recommended'],
       env: {
         '@finsit/cypress/globals': true,
       },
-      extends: ['plugin:@finsit/cypress/recommended'],
-      plugins: ['@finsit/cypress', 'eslint-plugin-local-rules'],
+      plugins: ['@finsit/cypress', 'rulesdir'],
       rules: {
-        'local-rules/unsafe-to-chain-command': ERROR,
+        'rulesdir/unsafe-to-chain-command': ERROR,
       },
     },
   ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-seek",
-  "version": "0.0.0-cypress-fork-20230524064546",
+  "version": "0.0.0-rulesdir-20230604234812",
   "description": "ESLint configuration used by SEEK",
   "main": "index.js",
   "files": [
@@ -30,9 +30,9 @@
     "eslint-import-resolver-typescript": "3.5.3",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-local-rules": "^1.3.2",
     "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-rulesdir": "^0.2.2",
     "find-root": "^1.1.0"
   },
   "devDependencies": {

package/eslint-local-rules/index.js

@@ -1,3 +0,0 @@
-module.exports = {
-  'unsafe-to-chain-command': require('./unsafe-to-chain-command.js'),
-};

package/eslint-local-rules/unsafe-to-chain-command.js

@@ -1,88 +0,0 @@
-/** This rule is copied from the original `eslint-plugin-cypress` so we can use the fork (which
- * supports eslint 8) while having the same recommended rules as the upstream
- * https://github.com/foretagsplatsen/eslint-plugin-cypress
- * https://github.com/cypress-io/eslint-plugin-cypress/blob/c626ad543f65babf1def5caabd1bc9bb9900d2c7/lib/rules/unsafe-to-chain-command.js
- */
-// eslint-disable-next-line strict
-'use strict';
-
-module.exports = {
-  meta: {
-    docs: {
-      description: 'Actions should be in the end of chains, not in the middle',
-      category: 'Possible Errors',
-      recommended: true,
-      url: 'https://docs.cypress.io/guides/core-concepts/retry-ability#Actions-should-be-at-the-end-of-chains-not-the-middle',
-    },
-    schema: [],
-    messages: {
-      unexpected:
-        'It is unsafe to chain further commands that rely on the subject after this command. It is best to split the chain, chaining again from `cy.` in a next command line.',
-    },
-  },
-  create(context) {
-    return {
-      CallExpression(node) {
-        if (
-          isRootCypress(node) &&
-          isActionUnsafeToChain(node) &&
-          node.parent.type === 'MemberExpression'
-        ) {
-          context.report({ node, messageId: 'unexpected' });
-        }
-      },
-    };
-  },
-};
-
-function isRootCypress(node) {
-  while (node.type === 'CallExpression') {
-    if (node.callee.type !== 'MemberExpression') {
-      return false;
-    }
-
-    if (
-      node.callee.object.type === 'Identifier' &&
-      node.callee.object.name === 'cy'
-    ) {
-      return true;
-    }
-
-    // eslint-disable-next-line no-param-reassign
-    node = node.callee.object;
-  }
-
-  return false;
-}
-
-function isActionUnsafeToChain(node) {
-  // commands listed in the documentation with text: 'It is unsafe to chain further commands that rely on the subject after xxx'
-  const unsafeToChainActions = [
-    'blur',
-    'clear',
-    'click',
-    'check',
-    'dblclick',
-    'each',
-    'focus',
-    'rightclick',
-    'screenshot',
-    'scrollIntoView',
-    'scrollTo',
-    'select',
-    'selectFile',
-    'spread',
-    'submit',
-    'type',
-    'trigger',
-    'uncheck',
-    'within',
-  ];
-
-  return (
-    node.callee &&
-    node.callee.property &&
-    node.callee.property.type === 'Identifier' &&
-    unsafeToChainActions.includes(node.callee.property.name)
-  );
-}