@pplancq/eslint-config 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+## @pplancq/eslint-config 1.0.0 (2024-02-05)
+
+
+### Features
+
+* **eslint-config:** add base rule for react with jsx-a11y ans testing-library for test ([c70823a](https://github.com/pplancq/dev-tools/commit/c70823a1b457612f744df055d67ef690531c43f9))
+* **eslint-config:** add eslint base config for js ([aca46cb](https://github.com/pplancq/dev-tools/commit/aca46cb451343a76a08d3e34d299f7caff75d004))
+* **eslint-config:** add eslint base config for ts ([22846cb](https://github.com/pplancq/dev-tools/commit/22846cbd2178304f31e80ae3677b727091f390db))
+* **eslint-config:** add plugin prettier rule ([2c2d3a0](https://github.com/pplancq/dev-tools/commit/2c2d3a02a12a128b805b24a19eea47377c006727))
+* **eslint-config:** add rule for jest and vitest ([714f323](https://github.com/pplancq/dev-tools/commit/714f323161ab9b7a982207506064fe3a2a676748))
+* **eslint-config:** add script for init eslint config ([56ccc72](https://github.com/pplancq/dev-tools/commit/56ccc72f9f0388aa786e5e92b78d16ee4b1b6279))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present pplancq
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+# @pplancq/eslint-config
+
+This package provides pplancq eslint as an extensible shared config.
+
+## Usage
+
+We export three eslint configurations for your usage.
+
+## Install
+
+```shell
+npm install --save-dev @pplancq/eslint-config
+```
+
+## eslint config
+
+Use with command to enable the default configuration.
+
+```shell
+npx init-eslint-config
+```
+
+### @pplancq/eslint-config/react
+
+To use, add `"eslintConfig": { "extends": ["@pplancq/eslint-config/react"] }` to your `package.json`.\
+This configuration enables the rules of base, typescript, prettier, react and testing-library files.
+
+### @pplancq/eslint-config/node
+
+To use, add `"eslintConfig": { "extends": ["@pplancq/eslint-config/node"] }` to your `package.json`.\
+This configuration enables the rules of base, typescript and prettier files.
+
+### @pplancq/eslint-config/vitest
+
+To use, add `"eslintConfig": { "extends": ["@pplancq/eslint-config/vitest"] }` to your `package.json`.\
+This configuration enables the rules of vitest file.
+
+### @pplancq/eslint-config/jest
+
+To use, add `"eslintConfig": { "extends": ["@pplancq/eslint-config/jest"] }` to your `package.json`.\
+This configuration enables the rules of jest file.

package/bin/init.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+const { writeFileSync } = require('fs');
+
+console.info('Add eslint config in .eslintrc.js');
+
+writeFileSync(
+  '.eslintrc.js',
+  "module.exports = { extends: ['@pplancq/eslint-config/react', '@pplancq/eslint-config/vitest'] };\n",
+  {
+    encoding: 'utf-8',
+  },
+);

package/jest.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['./rules/jest.js'].map(require.resolve),
+};

package/node.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['./rules/base.js', './rules/typescript.js', './rules/prettier.js'].map(require.resolve),
+};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@pplancq/eslint-config",
+  "version": "1.0.0",
+  "license": "MIT",
+  "description": "pplancq eslint config",
+  "author": "pplancq <paul.plancq@outlook.fr>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pplancq/dev-tools",
+    "directory": "packages/eslint-config"
+  },
+  "bugs": {
+    "url": "https://github.com/pplancq/dev-tools/issues"
+  },
+  "exports": {
+    "./node": "./node.js",
+    "./react": "./react.js",
+    "./jest": "./jest.js",
+    "./vitest": "./vitest.js"
+  },
+  "bin": {
+    "init-eslint-config": "./bin/init.js"
+  },
+  "keywords": [
+    "eslint",
+    "config"
+  ],
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.14.0",
+    "@typescript-eslint/parser": "^6.14.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-jest": "^27.6.0",
+    "eslint-plugin-jest-dom": "^5.1.0",
+    "eslint-plugin-jest-extended": "^2.0.0",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-testing-library": "^6.2.0",
+    "eslint-plugin-vitest": "^0.3.17",
+    "eslint-plugin-vitest-globals": "^1.4.0"
+  },
+  "peerDependencies": {
+    "prettier": "^3.1.1",
+    "eslint": "^8.55.0"
+  },
+  "peerDependenciesMeta": {
+    "prettier": {
+      "optional": true
+    }
+  },
+  "volta": {
+    "node": "20.10.0",
+    "npm": "10.2.5"
+  }
+}

package/react.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['./rules/react.js', './rules/prettier.js'].map(require.resolve),
+};

package/rules/base.js

@@ -0,0 +1,37 @@
+module.exports = {
+  extends: ['airbnb/base'],
+  plugins: ['import'],
+  parserOptions: {
+    ecmaVersion: 'latest',
+  },
+  env: {
+    browser: true,
+    node: true,
+  },
+  rules: {
+    // eslint
+    'no-console': [
+      'error',
+      {
+        allow: ['info', 'warn', 'error'],
+      },
+    ],
+    'no-plusplus': [
+      'error',
+      {
+        allowForLoopAfterthoughts: true,
+      },
+    ],
+
+    // eslint-plugin-import https://github.com/import-js/eslint-plugin-import
+    'import/prefer-default-export': 'off',
+    'import/no-default-export': 'error',
+  },
+  settings: {
+    'import/resolver': {
+      node: {
+        extensions: ['.js'],
+      },
+    },
+  },
+};

package/rules/jest.js

@@ -0,0 +1,37 @@
+module.exports = {
+  overrides: [
+    {
+      files: ['*.{test,spec}.{js,jsx,ts,tsx}'],
+      plugins: ['jest', 'jest-extended'],
+      env: {
+        'jest/globals': true,
+      },
+      rules: {
+        'import/no-extraneous-dependencies': 'off',
+
+        // eslint-plugin-jest https://github.com/jest-community/eslint-plugin-jest
+        'jest/no-conditional-expect': 'error',
+        'jest/no-identical-title': 'error',
+        'jest/no-interpolation-in-snapshots': 'error',
+        'jest/no-jasmine-globals': 'error',
+        'jest/no-mocks-import': 'error',
+        'jest/valid-describe-callback': 'error',
+        'jest/valid-expect': 'error',
+        'jest/valid-expect-in-promise': 'error',
+        'jest/valid-title': 'error',
+        'jest/prefer-called-with': 'error',
+        'jest/prefer-hooks-on-top': 'error',
+        'jest/prefer-strict-equal': 'error',
+        'jest/prefer-to-contain': 'error',
+        'jest/prefer-to-have-length': 'error',
+
+        // eslint-plugin-jest-extended https://github.com/jest-community/eslint-plugin-jest-extended
+        'jest-extended/prefer-to-be-array': 'error',
+        'jest-extended/prefer-to-be-false': 'error',
+        'jest-extended/prefer-to-be-object': 'error',
+        'jest-extended/prefer-to-be-true': 'error',
+        'jest-extended/prefer-to-have-been-called-once': 'error',
+      },
+    },
+  ],
+};

package/rules/prettier.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['plugin:prettier/recommended'],
+};

package/rules/react.js

@@ -0,0 +1,117 @@
+module.exports = {
+  extends: [
+    'airbnb',
+    'airbnb/hooks',
+    'plugin:react/recommended',
+    'plugin:react/jsx-runtime',
+    './base.js',
+    './typescript.js',
+  ],
+  rules: {
+    // eslint-plugin-import https://github.com/import-js/eslint-plugin-import
+    'import/extensions': [
+      'error',
+      'ignorePackages',
+      {
+        js: 'never',
+        jsx: 'never',
+      },
+    ],
+
+    // eslint-plugin-react https://github.com/jsx-eslint/eslint-plugin-react
+    'react/no-multi-comp': [
+      'error',
+      {
+        ignoreStateless: false,
+      },
+    ],
+    'react/jsx-props-no-spreading': 'off',
+    'react/no-unescaped-entities': 'off',
+    'react/jsx-filename-extension': [
+      'error',
+      {
+        extensions: ['.jsx'],
+      },
+    ],
+    'react/function-component-definition': [
+      'error',
+      {
+        namedComponents: ['function-declaration', 'arrow-function', 'function-expression'],
+        unnamedComponents: ['arrow-function', 'function-expression'],
+      },
+    ],
+
+    // eslint-plugin-react-hooks https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hook
+    'react-hooks/exhaustive-deps': 'warn',
+  },
+  settings: {
+    react: {
+      version: 'detect',
+    },
+    'import/resolver': {
+      node: {
+        extensions: ['.js', '.jsx'],
+      },
+    },
+  },
+  overrides: [
+    {
+      files: ['**/*.ts?(x)'],
+      settings: {
+        'import/resolver': {
+          node: {
+            extensions: ['.js', '.jsx', '.ts', '.tsx'],
+          },
+        },
+      },
+      rules: {
+        // eslint-plugin-import https://github.com/import-js/eslint-plugin-import
+        'import/extensions': [
+          'error',
+          'ignorePackages',
+          {
+            js: 'never',
+            jsx: 'never',
+            ts: 'never',
+            tsx: 'never',
+          },
+        ],
+
+        // eslint-plugin-react https://github.com/jsx-eslint/eslint-plugin-react
+        'react/require-default-props': 'off',
+        'react/jsx-filename-extension': [
+          'error',
+          {
+            extensions: ['.jsx', '.tsx'],
+          },
+        ],
+      },
+    },
+    {
+      extends: ['plugin:jest-dom/recommended'],
+      files: ['*.{test,spec}.{js,jsx,ts,tsx}'],
+      plugins: ['testing-library'],
+      rules: {
+        // eslint-plugin-testing-library https://github.com/testing-library/eslint-plugin-testing-library
+        'testing-library/await-async-queries': 'error',
+        'testing-library/await-async-utils': 'error',
+        'testing-library/no-await-sync-queries': 'error',
+        'testing-library/no-container': 'error',
+        'testing-library/no-debugging-utils': 'error',
+        'testing-library/no-dom-import': ['error', 'react'],
+        'testing-library/no-node-access': 'error',
+        'testing-library/no-promise-in-fire-event': 'error',
+        'testing-library/no-render-in-lifecycle': 'error',
+        'testing-library/no-unnecessary-act': 'error',
+        'testing-library/no-wait-for-multiple-assertions': 'error',
+        'testing-library/no-wait-for-side-effects': 'error',
+        'testing-library/no-wait-for-snapshot': 'error',
+        'testing-library/prefer-find-by': 'error',
+        'testing-library/prefer-presence-queries': 'error',
+        'testing-library/prefer-query-by-disappearance': 'error',
+        'testing-library/prefer-screen-queries': 'error',
+        'testing-library/render-result-naming-convention': 'error',
+      },
+    },
+  ],
+};

package/rules/typescript.js

@@ -0,0 +1,43 @@
+module.exports = {
+  overrides: [
+    {
+      files: ['**/*.ts?(x)'],
+      extends: ['plugin:@typescript-eslint/recommended'],
+      parser: '@typescript-eslint/parser',
+      settings: {
+        'import/resolver': {
+          typescript: true,
+          node: {
+            extensions: ['.js', '.ts'],
+          },
+        },
+      },
+      rules: {
+        // typescript-eslint/typescript-eslint https://github.com/typescript-eslint/typescript-eslint
+        // Add TypeScript specific rules (and turn off ESLint equivalents)
+        'no-shadow': 'off',
+        '@typescript-eslint/no-shadow': 'error',
+        'no-unused-expressions': 'off',
+        '@typescript-eslint/no-unused-expressions': 'error',
+        'no-use-before-define': 'off',
+        '@typescript-eslint/no-use-before-define': 'error',
+        'no-redeclare': 'off',
+        '@typescript-eslint/no-redeclare': 'error',
+        'no-useless-constructor': 'off',
+        '@typescript-eslint/no-useless-constructor': 'error',
+
+        '@typescript-eslint/consistent-type-assertions': 'warn',
+
+        // eslint-plugin-import https://github.com/import-js/eslint-plugin-import
+        'import/extensions': [
+          'error',
+          'ignorePackages',
+          {
+            js: 'never',
+            ts: 'never',
+          },
+        ],
+      },
+    },
+  ],
+};

package/rules/vitest.js

@@ -0,0 +1,30 @@
+module.exports = {
+  overrides: [
+    {
+      files: ['*.{test,spec}.{js,jsx,ts,tsx}'],
+      plugins: ['vitest', 'vitest-globals'],
+      env: {
+        'vitest-globals/env': true,
+      },
+      rules: {
+        'import/no-extraneous-dependencies': 'off',
+
+        // eslint-plugin-vitest https://github.com/veritem/eslint-plugin-vitest
+        'vitest/no-conditional-expect': 'error',
+        'vitest/no-identical-title': 'error',
+        'vitest/no-interpolation-in-snapshots': 'error',
+        'vitest/no-mocks-import': 'error',
+        'vitest/valid-describe-callback': 'error',
+        'vitest/valid-expect': 'error',
+        'vitest/valid-title': 'warn',
+        'vitest/prefer-called-with': 'error',
+        'vitest/prefer-strict-equal': 'error',
+        'vitest/prefer-to-contain': 'error',
+        'vitest/prefer-to-have-length': 'error',
+        'vitest/prefer-to-be-truthy': 'error',
+        'vitest/prefer-to-be-falsy': 'error',
+        'vitest/prefer-to-be-object': 'error',
+      },
+    },
+  ],
+};

package/vitest.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['./rules/vitest.js'].map(require.resolve),
+};