@fullstacksjs/eslint-config 8.10.0 → 8.11.0

package/cypress.js

@@ -1,13 +1,15 @@
+const { exts } = require('./utils');
+
 /** @type { import('eslint').Linter.Config } */
 module.exports = {
   overrides: [
     {
-      files: ['**/cypress/**/*.+(js|jsx)', '**/cypress/**/*.+(ts|tsx)'],
-      plugins: ['cypress'],
+      files: [`**/cypress/**/*.${exts}`, `**/*.cy.+${exts}`],
+      plugins: ['jest', 'jest-formatting', 'cypress'],
       env: {
         'cypress/globals': true,
       },
-      extends: ['./rules/cypress'],
+      extends: ['./rules/test', './rules/cypress'],
     },
   ],
 };

package/esm.js

@@ -1,13 +1,13 @@
 /** @type { import('eslint').Linter.Config } */
 module.exports = {
   rules: {
-    'import/extensions': 'off',
+    'import/extensions': ['error', { mjs: 'ignorePackages' }],
   },
   overrides: [
     {
       files: ['*.ts', '*.tsx'],
       rules: {
-        'import/no-unresolved': [2, { ignore: ['.js$'], caseSensitiveStrict: true }],
+        'import/no-unresolved': ['error', { ignore: ['.js$'], caseSensitiveStrict: true }],
       },
     },
   ],

package/jest.js

@@ -1,4 +1,5 @@
-const exts = '+(js|jsx|ts|tsx)';
+const { exts } = require('./utils');
+
 const dirs = '+(test|tests|__test__|__tests__|spec|specs)';
 
 /** @type { import('eslint').Linter.Config } */
@@ -10,7 +11,7 @@ module.exports = {
       env: {
         'jest/globals': true,
       },
-      extends: ['./rules/jest', './rules/jest-format'],
+      extends: ['./rules/test', './rules/jest'],
     },
   ],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstacksjs/eslint-config",
-  "version": "8.10.0",
+  "version": "8.11.0",
   "license": "MIT",
   "author": "fullstacks <fullstacksjs@gmail.com>",
   "description": "fullstacks eslint config",
@@ -11,24 +11,22 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
-  "bin": {
-    "fullstacksjs-eslint": "./bin/index.js"
-  },
   "files": [
-    "bin",
-    "rules",
     "base.js",
+    "bin",
+    "cypress.js",
+    "esm.js",
+    "graphql.js",
     "index.js",
     "jest.js",
     "nextjs.js",
-    "cypress.js",
-    "storybook.js",
     "packages.js",
-    "graphql.js",
     "react.js",
-    "typescript.js",
+    "rules",
+    "storybook.js",
     "typecheck.js",
-    "esm.js"
+    "typescript.js",
+    "utils.js"
   ],
   "scripts": {
     "lint": "eslint .",
@@ -40,7 +38,7 @@
     "check-rules:graphql": "eslint-find-rules --no-core --deprecated --unused ./tests/graphql.js",
     "check-rules:storybook": "eslint-find-rules --no-core --deprecated --unused ./tests/storybook.js",
     "spell": "cspell ./* --no-progress",
-    "test": "npm-run-all --parallel check-rules:* && npm run spell",
+    "test": "npm-run-all --parallel check-rules:*",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable",
     "pre-commit": "npm run test && lint-staged"
@@ -52,7 +50,7 @@
     "@typescript-eslint/eslint-plugin": "5.46.1",
     "@typescript-eslint/parser": "5.46.1",
     "eslint-config-prettier": "8.5.0",
-    "eslint-import-resolver-typescript": "3.5.2",
+    "eslint-import-resolver-typescript": "3.5.3",
     "eslint-plugin-cypress": "2.12.1",
     "eslint-plugin-fp": "2.3.0",
     "eslint-plugin-import": "2.26.0",
@@ -72,17 +70,17 @@
     "@semantic-release/github": "8.0.7",
     "@semantic-release/npm": "9.0.1",
     "@semantic-release/release-notes-generator": "10.0.3",
-    "cspell": "6.17.0",
+    "cspell": "6.19.2",
     "eslint": "8.29.0",
     "eslint-find-rules": "4.1.0",
-    "husky": "8.0.2",
+    "husky": "8.0.3",
     "lint-staged": "13.1.0",
-    "np": "7.6.2",
+    "np": "7.6.3",
     "npm-run-all": "4.1.5",
     "pinst": "3.0.0",
-    "prettier": "2.8.1",
+    "prettier": "2.8.3",
     "semantic-release": "19.0.5",
-    "typescript": "4.9.4"
+    "typescript": "4.9.5"
   },
   "peerDependencies": {
     "cypress": ">=8",

package/rules/cypress.js

@@ -6,10 +6,5 @@ module.exports = {
     'cypress/no-force': 'warn',
     'cypress/no-async-tests': 'error',
     'cypress/no-pause': 'error',
-
-    // other modules
-    'max-lines-per-function': ['off'],
-    '@typescript-eslint/method-signature-style': ['off'],
-    '@typescript-eslint/no-namespace ': ['off'],
   },
 };

package/rules/jest.js

@@ -10,14 +10,10 @@ module.exports = {
     'jest/no-commented-out-tests': 'warn',
     'jest/no-conditional-expect': 'error',
     'jest/no-conditional-in-test': 'error',
-    'jest/no-disabled-tests': 'warn',
     'jest/no-done-callback': 'warn',
-    'jest/no-duplicate-hooks': 'off',
     'jest/no-expect-resolves': 'off',
     'jest/no-export': 'error',
-    'jest/no-focused-tests': 'error',
     'jest/no-hooks': 'off',
-    'jest/no-identical-title': 'error',
     'jest/no-interpolation-in-snapshots': 'error',
     'jest/no-jasmine-globals': 'off',
     'jest/no-large-snapshots': ['warn', { maxSize: 300 }],
@@ -61,7 +57,6 @@ module.exports = {
 
     ...packages.ifAnyDep('typescript', () => ({
       '@typescript-eslint/unbound-method': 'off',
-      'jest/unbound-method': 'error',
     })),
 
     // conflicts

package/rules/naming-convention.js

@@ -0,0 +1,50 @@
+module.exports = [
+  {
+    selector: 'default',
+    format: ['camelCase'],
+  },
+  {
+    selector: 'function',
+    format: ['camelCase', 'PascalCase'],
+  },
+  // variables, CONSTANTS, ReactComponents
+  {
+    selector: 'variable',
+    format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
+  },
+  {
+    selector: 'parameter',
+    format: ['camelCase', 'PascalCase'],
+    leadingUnderscore: 'allowSingleOrDouble',
+  },
+  {
+    selector: 'memberLike',
+    format: null,
+  },
+  {
+    selector: 'memberLike',
+    modifiers: ['static'],
+    format: ['camelCase', 'PascalCase'],
+    leadingUnderscore: 'allow',
+  },
+  {
+    selector: 'memberLike',
+    modifiers: ['private'],
+    format: ['camelCase'],
+    leadingUnderscore: 'allow',
+  },
+  {
+    selector: 'typeLike',
+    format: ['PascalCase'],
+  },
+  {
+    selector: 'enumMember',
+    format: ['PascalCase'],
+  },
+  // disallow I prefix for interfaces
+  {
+    selector: 'interface',
+    format: ['PascalCase'],
+    custom: { regex: '^I[A-Z]', match: false },
+  },
+];

package/rules/test.js

@@ -0,0 +1,31 @@
+const packages = require('../packages');
+
+module.exports = {
+  rules: {
+    'jest/no-duplicate-hooks': 'error',
+    'jest/no-disabled-tests': 'error',
+    'jest/no-focused-tests': 'error',
+    'jest/no-identical-title': 'error',
+
+    // formatting
+    'jest-formatting/padding-around-after-all-blocks': 'warn',
+    'jest-formatting/padding-around-after-each-blocks': 'warn',
+    'jest-formatting/padding-around-all': 'warn',
+    'jest-formatting/padding-around-before-all-blocks': 'warn',
+    'jest-formatting/padding-around-before-each-blocks': 'warn',
+    'jest-formatting/padding-around-describe-blocks': 'warn',
+    'jest-formatting/padding-around-expect-groups': 'warn',
+    'jest-formatting/padding-around-test-blocks': 'warn',
+
+    // other modules
+    'max-lines-per-function': 'off',
+    ...packages.ifAnyDep('react', () => ({
+      'react/jsx-no-constructed-context-values': 'off',
+    })),
+    ...packages.ifAnyDep('typescript', () => ({
+      '@typescript-eslint/method-signature-style': 'off',
+      '@typescript-eslint/no-namespace ': 'off',
+      '@typescript-eslint/unbound-method': 'off',
+    })),
+  },
+};

package/rules/{typescript-requiring-type-checking.js → typecheck.js}

@@ -4,14 +4,18 @@ module.exports = {
     '@typescript-eslint/consistent-type-exports': 'warn',
     '@typescript-eslint/dot-notation': [
       'warn',
-      { allowPrivateClassPropertyAccess: false, allowProtectedClassPropertyAccess: false, allowIndexSignaturePropertyAccess: true },
+      {
+        allowPrivateClassPropertyAccess: false,
+        allowProtectedClassPropertyAccess: false,
+        allowIndexSignaturePropertyAccess: true,
+      },
     ],
     '@typescript-eslint/no-confusing-void-expression': ['warn', { ignoreArrowShorthand: true, ignoreVoidOperator: true }],
     '@typescript-eslint/no-floating-promises': ['error', { ignoreVoid: true }],
     '@typescript-eslint/no-for-in-array': 'error',
     '@typescript-eslint/no-implied-eval': 'error',
     '@typescript-eslint/no-meaningless-void-operator': ['warn', { checkNever: false }],
-    '@typescript-eslint/no-misused-promises': 'error',
+    '@typescript-eslint/no-misused-promises': ['warn', { checksVoidReturn: { attributes: false } }],
     '@typescript-eslint/no-redundant-type-constituents': 'warn',
     '@typescript-eslint/no-throw-literal': 'error',
     '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
@@ -47,45 +51,13 @@ module.exports = {
     '@typescript-eslint/unbound-method': ['error', { ignoreStatic: true }],
     '@typescript-eslint/naming-convention': [
       'warn',
-      {
-        selector: 'default',
-        format: ['camelCase'],
-      },
-      // variables, CONSTANTS, ReactComponents
-      {
-        selector: 'variable',
-        format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
-      },
-      {
-        selector: 'parameter',
-        format: ['camelCase'],
-        leadingUnderscore: 'allow',
-      },
-      {
-        selector: 'memberLike',
-        modifiers: ['private'],
-        format: ['camelCase'],
-        leadingUnderscore: 'allow',
-      },
-      {
-        selector: 'typeLike',
-        format: ['PascalCase'],
-      },
-      // disallow I prefix for interfaces
-      {
-        selector: 'interface',
-        format: ['PascalCase'],
-        custom: {
-          regex: '^I[A-Z]',
-          match: false,
-        },
-      },
-      // force use is/should/has ... for boolean variables
+      ...require('./naming-convention'), // eslint-disable-line node/global-require
+      // force use is/should/has for boolean variables
       {
         selector: 'variable',
         types: ['boolean'],
-        format: ['camelCase'],
-        prefix: ['is', 'should', 'has', 'can', 'did', 'will', 'enable'],
+        format: ['PascalCase'],
+        prefix: ['is', 'should', 'has', 'can', 'did', 'will', 'enable', 'loading'],
       },
     ],
 

package/rules/typescript.js

@@ -30,57 +30,7 @@ module.exports = {
     '@typescript-eslint/member-naming': 'off',
     '@typescript-eslint/member-ordering': 'off',
     '@typescript-eslint/method-signature-style': ['warn', 'property'],
-    '@typescript-eslint/naming-convention': [
-      'warn',
-      {
-        selector: 'default',
-        format: ['camelCase'],
-      },
-      {
-        selector: 'function',
-        format: ['camelCase', 'PascalCase'],
-      },
-      // variables, CONSTANTS, ReactComponents
-      {
-        selector: 'variable',
-        format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
-      },
-      {
-        selector: 'parameter',
-        format: ['camelCase', 'PascalCase'],
-        leadingUnderscore: 'allowSingleOrDouble',
-      },
-      {
-        selector: 'memberLike',
-        format: null,
-      },
-      {
-        selector: 'memberLike',
-        modifiers: ['static'],
-        format: ['camelCase', 'PascalCase'],
-        leadingUnderscore: 'allow',
-      },
-      {
-        selector: 'memberLike',
-        modifiers: ['private'],
-        format: ['camelCase'],
-        leadingUnderscore: 'allow',
-      },
-      {
-        selector: 'typeLike',
-        format: ['PascalCase'],
-      },
-      {
-        selector: 'enumMember',
-        format: ['PascalCase'],
-      },
-      // disallow I prefix for interfaces
-      {
-        selector: 'interface',
-        format: ['PascalCase'],
-        custom: { regex: '^I[A-Z]', match: false },
-      },
-    ],
+    '@typescript-eslint/naming-convention': ['warn', ...require('./naming-convention')], // eslint-disable-line node/global-require
     '@typescript-eslint/no-array-constructor': 'error',
     '@typescript-eslint/no-base-to-string': 'off', // false negative
     '@typescript-eslint/no-confusing-non-null-assertion': 'error',

package/storybook.js

@@ -3,7 +3,7 @@ module.exports = {
   overrides: [
     {
       plugins: ['storybook'],
-      files: ['*.stories.+(ts|tsx|js|jsx|mjs|cjs)', '*.story.+(ts|tsx|js|jsx|mjs|cjs)'],
+      files: ['*.stories.+(ts|tsx|js|jsx|mjs|cjs|mdx)', '*.story.+(ts|tsx|js|jsx|mjs|cjs|mdx)'],
       extends: ['./rules/storybook.js'],
     },
   ],

package/typecheck.js

@@ -3,7 +3,7 @@ module.exports = {
   overrides: [
     {
       files: ['*.ts', '*.tsx'],
-      extends: ['./rules/typescript-requiring-type-checking.js'],
+      extends: ['./rules/typecheck.js'],
     },
   ],
 };

package/utils.js

@@ -0,0 +1 @@
+module.exports.exts = '+(js|jsx|mjs|cjs|ts|tsx|mts|cts)';

package/bin/index.js

@@ -1,9 +0,0 @@
-#!/usr/bin/env node
-
-const createOptions = require('./lib/createOptions');
-const createTasks = require('./lib/tasks');
-
-createOptions()
-  .then(createTasks)
-  .then(tasks => tasks.run())
-  .catch(() => {});

package/bin/lib/askWhenConfigExists.js

@@ -1,51 +0,0 @@
-const { readFile } = require('fs/promises');
-const inquirer = require('inquirer');
-
-const isObject = x => typeof x === 'object' && !Array.isArray(x) && x !== null;
-
-// TODO: add this function to the toolbox
-const merge = (obj, obj2) =>
-  Object.entries(obj)
-    .concat(Object.entries(obj2))
-    .reduce((acc, [key, value]) => {
-      const accValue = acc[key];
-      return Array.isArray(accValue) && Array.isArray(value)
-        ? { ...acc, [key]: accValue.concat(value) }
-        : isObject(accValue) && isObject(value)
-        ? { ...acc, [key]: merge(accValue, value) }
-        : { ...acc, [key]: value };
-    }, {});
-
-const Choice = {
-  noConfig: 'noConfig',
-  overwrite: 'overwrite',
-  extend: 'extend',
-};
-
-const askWhenConfigExists = async eslintrc => {
-  const file = await readFile('.eslintrc.json').catch(() => null);
-  if (file === null) return eslintrc;
-
-  const currentConfig = JSON.parse(file);
-  const isConfiguredBefore = eslintrc?.extends.every(c => currentConfig?.extends?.includes(c));
-  if (isConfiguredBefore) return currentConfig;
-
-  const { choice } = await inquirer.prompt({
-    type: 'list',
-    name: 'choice',
-    message: 'config found',
-    choices: [
-      {
-        value: 'overwrite',
-        name: 'overwrite the current config completely',
-      },
-      {
-        value: 'extend',
-        name: 'extend the fullstacks config alongside current config',
-      },
-    ],
-  });
-  return choice === Choice.extend ? merge(currentConfig, eslintrc) : eslintrc;
-};
-
-module.exports = askWhenConfigExists;

package/bin/lib/createOptions.js

@@ -1,25 +0,0 @@
-const getUserInput = require('./getUserInput');
-const args = require('./parseArgs');
-
-const eslintrcConfig = {
-  extends: ['@fullstacksjs'],
-};
-
-const requiredPackages = ['@fullstacksjs/eslint-config', 'eslint', 'prettier'];
-
-async function createOptions() {
-  const isTechnologyInArgv = args.t != null;
-  const optionsFromArgs = { technology: args.t };
-  const userInput = isTechnologyInArgv ? optionsFromArgs : await getUserInput();
-
-  if (userInput.technology === 'ts') {
-    requiredPackages.push('typescript');
-  }
-
-  return {
-    eslintrc: eslintrcConfig,
-    packages: requiredPackages,
-  };
-}
-
-module.exports = createOptions;

package/bin/lib/generateFile.js

@@ -1,15 +0,0 @@
-const { writeFile } = require('fs/promises');
-
-function createFileTask(eslintrc, ctx, task) {
-  return writeFile('.eslintrc.json', JSON.stringify(eslintrc, null, 2))
-    .then(() => {
-      task.title = `.eslintrc - Successfully Generated.`;
-    })
-    .catch(() => {
-      ctx.isEslintrc = false;
-      task.title = `Generating .eslintrc file`;
-      throw Error("Couldn't create file");
-    });
-}
-
-module.exports = createFileTask;

package/bin/lib/getUserInput.js

@@ -1,24 +0,0 @@
-const inquirer = require('inquirer');
-
-function getUserInput() {
-  return inquirer.prompt([
-    {
-      type: 'list',
-      name: 'technology',
-      message: 'which technology are you using?',
-      choices: [
-        {
-          value: 'ts',
-          name: 'ESLint alongside TypeScript',
-        },
-        {
-          value: 'js',
-          name: 'ESLint for JavaScript development',
-        },
-      ],
-      default: 'js',
-    },
-  ]);
-}
-
-module.exports = getUserInput;

package/bin/lib/parseArgs.js

@@ -1,12 +0,0 @@
-const yargs = require('yargs');
-
-const args = yargs(process.argv.slice(2))
-  .alias('t', 'technology')
-  .describe('t', 'Which technology are you using')
-  .choices('t', ['ts', 'js'])
-  .usage('Usage: $0 [-t ts|js]')
-  .example('$0 - ts')
-  .help('h')
-  .alias('h', 'help').argv;
-
-module.exports = args;

package/bin/lib/tasks.js

@@ -1,30 +0,0 @@
-const Listr = require('listr');
-const util = require('util');
-const askWhenConfigExists = require('./askWhenConfigExists');
-const exec = util.promisify(require('child_process').exec);
-const createFileTask = require('./generateFile');
-
-async function createTasks({ packages, eslintrc }) {
-  const installTasks = packages.map(pkg => ({
-    title: `Installing ${pkg}`,
-    task: (ctx, task) => exec(`npm i -D ${pkg}`).then(() => (task.title = `${pkg} Installed`)),
-  }));
-
-  const config = await askWhenConfigExists(eslintrc);
-
-  return new Listr(
-    [
-      {
-        title: 'Installing dependencies using npm',
-        task: () => new Listr(installTasks, { exitOnError: true }),
-      },
-      {
-        title: 'Generating .eslintrc.json file',
-        task: (ctx, task) => createFileTask(config, ctx, task),
-      },
-    ],
-    { exitOnError: false },
-  );
-}
-
-module.exports = createTasks;

package/rules/jest-format.js

@@ -1,12 +0,0 @@
-module.exports = {
-  rules: {
-    'jest-formatting/padding-around-after-all-blocks': 'warn',
-    'jest-formatting/padding-around-after-each-blocks': 'warn',
-    'jest-formatting/padding-around-all': 'warn',
-    'jest-formatting/padding-around-before-all-blocks': 'warn',
-    'jest-formatting/padding-around-before-each-blocks': 'warn',
-    'jest-formatting/padding-around-describe-blocks': 'warn',
-    'jest-formatting/padding-around-expect-groups': 'warn',
-    'jest-formatting/padding-around-test-blocks': 'warn',
-  },
-};