eslint-config-moneyforward 2.0.1 → 4.0.0

package/README.md

@@ -1,59 +1,182 @@
 # eslint-config-moneyforward
 
-This package provides moneyforward's .eslintrc as an extensible shared config.
+[![Version](https://img.shields.io/npm/v/eslint-config-moneyforward.svg?style=flat-square)](https://www.npmjs.com/package/eslint-config-moneyforward?activeTab=versions)
+[![License](https://img.shields.io/github/license/moneyforward/eslint-config-moneyforward.svg?style=flat-square)](https://github.com/moneyforward/eslint-config-moneyforward/blob/main/LICENSE)
+
+This package provides moneyforward's `.eslintrc` as an extensible shared config.
 
 ## Usage
 
-`npm install --save-dev eslint eslint-config-moneyforward`
+### 1. Install dependencies (and peer dependencies)
+
+```bash
+npm install --save-dev eslint-config-moneyforward eslint
+```
+
+### 2. Configure ESLint
+
+#### 2a. for Flat Config
+
+Within your ESLint config file (`eslint.config.js`):
+
+```js
+import { essentials } from 'eslint-config-moneyforward/flat';
+
+export default [...essentials];
+```
+
+If you need TypeScript Support:
+
+```diff
+-import { essentials } from 'eslint-config-moneyforward/flat';
++import { essentials, typescript } from 'eslint-config-moneyforward/flat';
+
+ export default [
+   ...essentials,
++  ...typescript,
+ ];
+```
+
+Must be added after `essentials`.
+
+We also provide various other rule sets that you can configure to suit your project.
+
+```js
+import {
+  essentials,
+  jsdoc,
+  node,
+  react,
+  storybook,
+  test,
+  typescript,
+} from 'eslint-config-moneyforward/flat';
+
+export default [
+  ...essentials,
+  ...jsdoc,
+  ...next,
+  ...node,
+  ...react,
+  ...storybook,
+  ...test.react,
+  ...typescript,
+];
+```
+
+#### 2b. for eslintrc format
+
+Within your ESLint config file:
+
+```json
+{
+  "extends": ["moneyforward/essentials"]
+}
+```
+
+If you need React Support:
+
+```diff
+{
+  "extends": [
+    "moneyforward/essentials",
++   "moneyforward/react",
+  ]
+}
+```
 
-Ex. Using Next.js, TypeScript, Jest in your repository,
+Must be added after `essentials`.
 
-.eslintrc.json
+We also provide various other rule sets that you can configure to suit your project.
 
 ```json
 {
   "extends": [
-    "moneyforward",
-    "moneyforward/rules/next",
-    "moneyforward/rules/typescript",
-    "moneyforward/rules/jest"
+    "moneyforward/essentials",
+    "moneyforward/jsdoc",
+    "moneyforward/next",
+    "moneyforward/node",
+    "moneyforward/react",
+    "moneyforward/storybook",
+    "moneyforward/test/react",
+    "moneyforward/typescript"
   ]
 }
 ```
 
-## Support rules
+|     Rule set | Summary                                               | Dependencies                                                                                                                                                                                                                                                                        |
+| -----------: | :---------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `essentials` | Contains basic, import, and promise recommended rules | [`eslint`](https://eslint.org/) <br> [`eslint-plugin-promise`](https://github.com/eslint-community/eslint-plugin-promise) <br> [`eslint-plugin-import`](https://github.com/import-js/eslint-plugin-import)                                                                          |
+|      `jsdoc` | Contains JSDoc recommended rules                      | [`eslint-plugin-jsdoc`](https://github.com/gajus/eslint-plugin-jsdoc)                                                                                                                                                                                                               |
+|       `next` | Contains Next.js recommended rules                    | [`@next/eslint-plugin-next`](https://github.com/vercel/next.js/tree/canary/packages/eslint-plugin-next)                                                                                                                                                                             |
+|       `node` | Contains Node.js recommended rules                    | [`eslint-plugin-n`](https://github.com/eslint-community/eslint-plugin-n)                                                                                                                                                                                                            |
+|      `react` | Contains React recommended rules                      | [`eslint-plugin-jsx-a11y`](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y) <br> [`eslint-plugin-react-hooks`](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks) <br> [`eslint-plugin-react`](https://github.com/jsx-eslint/eslint-plugin-react) |
+|  `storybook` | Contains Storybook recommended rules                  | [`eslint-plugin-storybook`](https://github.com/storybookjs/eslint-plugin-storybook)                                                                                                                                                                                                 |
+| `test/react` | Contains Jest and React Testing Library rules         | [`eslint-plugin-jest`](https://github.com/jest-community/eslint-plugin-jest) <br> [`eslint-plugin-jest-dom`](https://github.com/testing-library/eslint-plugin-jest-dom) <br> [`eslint-plugin-testing-library`](https://github.com/testing-library/eslint-plugin-testing-library)    |
+| `typescript` | Contains TypeScript recommended rules                 | [`@eslint-typescript/eslint-plugin`](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin) <br> [`@eslint-typescript/parser`](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/parser)                                  |
 
-- `moneyforward`
-  - Contains ESLint recommended rule
-- `moneyforward/rules/node`
-  - Contains Node.js recommended rule ( `eslint-plugin-node` )
-- `moneyforward/rules/typescript`
-  - Contains TypeScript recommended rule ( `@typescript-eslint/eslint-plugin` )
-- `moneyforward/rules/react`
-  - Contains React recommended rule ( `eslint-plugin-react`, `eslint-plugin-react-hooks` )
-- `moneyforward/rules/next`
-  - Contains React and Next.js recommended rule ( `eslint-plugin-react`, `eslint-plugin-react-hooks`, `eslint-plugin-next` )
-- `moneyforward/rules/jest`
-  - Contains Jest recommended rule ( `eslint-plugin-jest` )
-- `moneyforward/rules/testing-library/react`
-  - Contains React Testing Library recommended rule ( `eslint-plugin-testing-library`, `eslint-plugin-jest-dom` )
+## Using Prettier
 
-## Prettier support
+If you use [Prettier](https://prettier.io/) to format your code, you must disable any rules in `moneyforward/essentials` that conflict with Prettier.
 
-Using prettier, extend `moneyforward/prettier`
+### 1. Install dependencies
 
-- Using [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier).
-  - `Turns off all rules that are unnecessary or might conflict with Prettier.`
-  - `Make sure to put it last, so it gets the chance to override other configs.`
+```bash
+npm install --save-dev eslint-config-prettier
+```
+
+### 2. Configure ESLint
+
+Within your ESLint config file:
+
+```diff
+// eslint.config.js
+
+ import { essentials, react } from 'eslint-config-moneyforward/flat';
++import prettier from 'eslint-config-prettier';
+
+ export default [
+   ...essentials,
+   ...react,
++  prettier,
+ ],
+```
+
+```diff
+// .eslintrc.js
 
-```json
 {
-  "extends": ["some-other-config-you-use", "moneyforward/rules/prettier"]
+  "extends": [
+    "moneyforward/essentials",
+    "moneyforward/react",
++   "prettier"
+  ]
 }
 ```
 
+By adding the `prettier` configuration to `extends` in the ESLint configuration, you can disable all rules in `...essentials` (or `moneyforward/essentials`) that conflict with Prettier.
+
+## Migrate from an existing configuration
+
+eslint-config-moneyforward contains various plugins related to different rule sets. Therefore, users don't need to install them separately. If you have installed them in your existing configuration, we recommend uninstalling them.
+
+```bash
+npm uninstall eslint-plugin-promise eslint-plugin-import \
+  eslint-plugin-jsdoc \
+  @next/eslint-plugin-next \
+  eslint-plugin-n \
+  eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks \
+  eslint-plugin-storybook \
+  eslint-plugin-jest eslint-plugin-testing-library \
+  @eslint-typescript/eslint-plugin @eslint-typescript/parser
+```
+
 ## Versioning
 
 - Increment major version: Changed **error** rules.
 - Increment minor version: Changed **warn** rules.
 - Increment patch version: Not changed **error** and **warn** rules.
+
+## License
+
+Open source [licensed as MIT](https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/LICENSE).

package/configs/eslintrc/essentials.js

@@ -0,0 +1,15 @@
+module.exports = {
+  extends: [
+    '../../rules/best-practices',
+    '../../rules/errors',
+    '../../rules/es6',
+    '../../rules/imports',
+    '../../rules/promise',
+    '../../rules/style',
+    '../../rules/variables',
+  ],
+  parserOptions: {
+    ecmaVersion: 12,
+    sourceType: 'module',
+  },
+};

package/configs/eslintrc/jsdoc.js

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

package/configs/eslintrc/next.js

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

package/configs/eslintrc/node.js

@@ -0,0 +1,6 @@
+module.exports = {
+  extends: ['../../rules/node'],
+  env: {
+    node: true,
+  },
+};

package/configs/eslintrc/react.js

@@ -0,0 +1,12 @@
+module.exports = {
+  extends: [
+    '../../rules/react',
+    '../../rules/react-hooks',
+    '../../rules/jsx-a11y',
+  ],
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+};

package/configs/eslintrc/storybook.js

@@ -0,0 +1,12 @@
+module.exports = {
+  overrides: [
+    {
+      extends: ['../../rules/storybook'],
+      files: [
+        '*.stories.@(ts|tsx|js|jsx)',
+        '*.story.@(ts|tsx|js|jsx)',
+        '**/.storybook/**/*.@(ts|tsx|js|jsx)',
+      ],
+    },
+  ],
+};

package/configs/eslintrc/test/react.js

@@ -0,0 +1,15 @@
+module.exports = {
+  overrides: [
+    {
+      extends: [
+        '../../../rules/jest',
+        '../../../rules/jest-dom',
+        '../../../rules/testing-library/react',
+      ],
+      files: ['**/__tests__/**/*', '**/*.{spec,test}.*'],
+      env: {
+        'jest/globals': true,
+      },
+    },
+  ],
+};

package/configs/eslintrc/typescript.js

@@ -0,0 +1,9 @@
+module.exports = {
+  overrides: [
+    {
+      extends: ['../../rules/typescript'],
+      files: ['*.@(ts|tsx|cts|mts)'],
+      parser: '@typescript-eslint/parser',
+    },
+  ],
+};

package/configs/flat/essentials.mjs

@@ -0,0 +1,43 @@
+// @ts-check
+// @ts-ignore
+import importPlugin from 'eslint-plugin-import';
+import promisePlugin from 'eslint-plugin-promise';
+import bestPracticesRuleSet from '../../rules/best-practices.js';
+import errorsRuleSet from '../../rules/errors.js';
+import es6RuleSet from '../../rules/es6.js';
+import importRuleSetBase from '../../rules/imports.js';
+import promiseRuleSetBase from '../../rules/promise.js';
+import styleRuleSet from '../../rules/style.js';
+import variablesRuleSet from '../../rules/variables.js';
+
+const importRuleSet = {
+  plugins: {
+    import: importPlugin,
+  },
+  settings: importRuleSetBase.settings,
+  rules: {
+    ...importPlugin.configs.recommended.rules,
+    ...importPlugin.configs.errors.rules,
+    ...importRuleSetBase.rules,
+  },
+};
+
+const promiseRuleSet = {
+  plugins: {
+    promise: promisePlugin,
+  },
+  rules: {
+    ...promisePlugin.configs.recommended.rules,
+    ...promiseRuleSetBase.rules,
+  },
+};
+
+export default [
+  bestPracticesRuleSet,
+  errorsRuleSet,
+  es6RuleSet,
+  importRuleSet,
+  promiseRuleSet,
+  styleRuleSet,
+  variablesRuleSet,
+];

package/configs/flat/index.mjs

@@ -0,0 +1,15 @@
+// @ts-check
+import essentials from './essentials.mjs';
+import jsdoc from './jsdoc.mjs';
+import next from './next.mjs';
+import node from './node.mjs';
+import react from './react.mjs';
+import storybook from './storybook.mjs';
+import testReact from './test/react.mjs';
+import typescript from './typescript.mjs';
+
+const test = {
+  react: testReact,
+};
+
+export { essentials, jsdoc, next, node, react, storybook, test, typescript };

package/configs/flat/jsdoc.mjs

@@ -0,0 +1,31 @@
+// @ts-check
+import jsdoc from 'eslint-plugin-jsdoc';
+import jsdocRuleSetBase from '../../rules/jsdoc.js';
+
+const jsdocRuleSetTs = {
+  plugins: {
+    jsdoc,
+  },
+  rules: {
+    ...jsdoc.configs['flat/recommended-typescript-error'].rules,
+    ...jsdocRuleSetBase.rules,
+  },
+};
+
+const jsdocRuleSetJs = {
+  plugins: {
+    jsdoc,
+  },
+  rules: {
+    ...jsdocRuleSetBase.overrides[0].rules,
+  },
+};
+
+export default [
+  jsdocRuleSetTs,
+
+  {
+    files: ['*.@(js|cjs|mjs)'],
+    ...jsdocRuleSetJs,
+  },
+];

package/configs/flat/next.mjs

@@ -0,0 +1,34 @@
+// @ts-check
+import next from '@next/eslint-plugin-next';
+// @ts-ignore
+import importPlugin from 'eslint-plugin-import';
+import nextRuleSetBase from '../../rules/next.js';
+
+const nextRuleSet = {
+  plugins: {
+    '@next/next': next,
+  },
+  rules: {
+    ...next.configs.recommended.rules,
+    ...next.configs['core-web-vitals'].rules,
+  },
+};
+
+const nextRuleSetPages = {
+  plugins: {
+    '@next/next': next,
+    import: importPlugin,
+  },
+  rules: {
+    ...nextRuleSetBase.overrides[0].rules,
+  },
+};
+
+export default [
+  nextRuleSet,
+
+  {
+    files: ['**/@(app|pages)/**/*', '**/*.page.@(tsx|jsx|js)'],
+    ...nextRuleSetPages,
+  },
+];

package/configs/flat/node.mjs

@@ -0,0 +1,15 @@
+// @ts-check
+import n from 'eslint-plugin-n';
+import nodeRuleSetBase from '../../rules/node.js';
+
+const nodeRuleSet = {
+  plugins: {
+    n,
+  },
+  rules: {
+    ...n.configs['flat/recommended'].rules,
+    ...nodeRuleSetBase.rules,
+  },
+};
+
+export default [nodeRuleSet];

package/configs/flat/react.mjs

@@ -0,0 +1,54 @@
+// @ts-check
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+import react from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import jsxA11yRuleSetBase from '../../rules/jsx-a11y.js';
+import reactHooksRuleSetBase from '../../rules/react-hooks.js';
+import reactRuleSetBase from '../../rules/react.js';
+
+const reactRuleSet = {
+  plugins: {
+    react,
+  },
+  rules: {
+    ...react.configs.recommended.rules,
+    ...reactRuleSetBase.rules,
+  },
+};
+
+const reactHooksRuleSet = {
+  plugins: {
+    'react-hooks': reactHooks,
+  },
+  rules: {
+    ...reactHooksRuleSetBase.rules,
+  },
+};
+
+const jsxA11yRuleSet = {
+  plugins: {
+    'jsx-a11y': jsxA11y,
+  },
+  rules: {
+    ...jsxA11y.configs.recommended.rules,
+    ...jsxA11yRuleSetBase.rules,
+  },
+};
+
+export default [
+  {
+    languageOptions: {
+      ...react.configs.recommended.languageOptions,
+    },
+
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+  },
+
+  reactRuleSet,
+  reactHooksRuleSet,
+  jsxA11yRuleSet,
+];

package/configs/flat/storybook.mjs

@@ -0,0 +1,42 @@
+// @ts-check
+// @ts-ignore
+import importPlugin from 'eslint-plugin-import';
+import * as storybook from 'eslint-plugin-storybook';
+import storybookRuleSetBase from '../../rules/storybook.js';
+
+const storybookRuleSetStories = {
+  plugins: {
+    storybook,
+    import: importPlugin,
+  },
+
+  rules: {
+    ...storybook.configs.recommended.overrides[0].rules,
+    ...storybook.configs['csf-strict'].rules,
+    ...storybookRuleSetBase.rules,
+    'import/no-default-export': ['off'],
+  },
+};
+
+const storybookRuleSetConfig = {
+  plugins: {
+    storybook,
+    import: importPlugin,
+  },
+  rules: {
+    ...storybook.configs.recommended.overrides[1].rules,
+    'import/no-default-export': ['off'],
+  },
+};
+
+export default [
+  {
+    files: ['**/*.@(stories|story).@(ts|tsx|js|jsx|mjs|cjs)'],
+    ...storybookRuleSetStories,
+  },
+
+  {
+    files: ['**/.storybook/**/*.@(ts|tsx|js|jsx|mjs|cjs)'],
+    ...storybookRuleSetConfig,
+  },
+];

package/configs/flat/test/react.mjs

@@ -0,0 +1,57 @@
+// @ts-check
+import jest from 'eslint-plugin-jest';
+// @ts-ignore
+import jestDom from 'eslint-plugin-jest-dom';
+import testingLibrary from 'eslint-plugin-testing-library';
+import jestDomRuleSetBase from '../../../rules/jest-dom.js';
+import jestRuleSetBase from '../../../rules/jest.js';
+import testingLibraryReactRuleSetBase from '../../../rules/testing-library/react.js';
+
+const jestRuleSet = {
+  plugins: {
+    jest,
+  },
+  rules: {
+    ...jest.configs.recommended.rules,
+    ...jest.configs.style.rules,
+    ...jestRuleSetBase.rules,
+  },
+};
+
+const jestDomRuleSet = {
+  plugins: {
+    'jest-dom': jestDom,
+  },
+  rules: {
+    ...jestDom.configs.recommended.rules,
+    ...jestDomRuleSetBase.rules,
+  },
+};
+
+const testingLibraryReactRuleSet = {
+  plugins: {
+    'testing-library': testingLibrary,
+  },
+
+  rules: {
+    ...testingLibrary.configs.react.rules,
+    ...testingLibraryReactRuleSetBase.rules,
+  },
+};
+
+export default [
+  {
+    files: ['**/__tests__/**/*', '**/*.{spec,test}.*'],
+    ...jestRuleSet,
+  },
+
+  {
+    files: ['**/__tests__/**/*', '**/*.{spec,test}.*'],
+    ...jestDomRuleSet,
+  },
+
+  {
+    files: ['**/__tests__/**/*', '**/*.{spec,test}.*'],
+    ...testingLibraryReactRuleSet,
+  },
+];

package/configs/flat/typescript.mjs

@@ -0,0 +1,31 @@
+// @ts-check
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import typescriptEslintParser from '@typescript-eslint/parser';
+import typescriptRuleSetBase from '../../rules/typescript.js';
+
+const typescriptRuleSet = {
+  plugins: {
+    '@typescript-eslint': typescriptEslint,
+  },
+  rules: {
+    ...typescriptEslint.configs['eslint-recommended'].overrides?.[0].rules,
+    ...typescriptEslint.configs['strict-type-checked'].rules,
+    ...typescriptEslint.configs['stylistic-type-checked'].rules,
+    ...typescriptRuleSetBase.rules,
+  },
+};
+
+export default [
+  {
+    files: ['**/*.@(ts|tsx|cts|mts)'],
+
+    languageOptions: {
+      parser: typescriptEslintParser,
+      parserOptions: {
+        project: true,
+      },
+    },
+
+    ...typescriptRuleSet,
+  },
+];