eslint-config-moneyforward 2.0.0 → 3.0.0

package/.eslintrc.js

@@ -1,5 +1,10 @@
 module.exports = {
-  extends: ['./configs/base', './configs/node', './configs/jest.js'].map(
-    require.resolve,
-  ),
+  extends: ['./configs/essentials', './configs/node', 'prettier'],
+
+  overrides: [
+    {
+      files: ['*.test.js'],
+      extends: ['./rules/jest'],
+    },
+  ],
 };

package/.github/workflows/check_pull_request_title.yml

@@ -0,0 +1,37 @@
+name: Check Pull Request Title
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - reopened
+      - synchronize
+
+permissions:
+  pull-requests: read
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          # Based on the Angular convention
+          # cf. https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines
+          types: |
+            feat
+            fix
+            docs
+            style
+            refactor
+            perf
+            test
+            build
+            ci
+            chore
+            revert
+          validateSingleCommit: true
+          validateSingleCommitMatchesPrTitle: true

package/.github/workflows/release.yml

@@ -0,0 +1,31 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ./.node-version
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Release
+        run: npm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.node-version

@@ -0,0 +1 @@
+20.12.0

package/CHANGELOG.md

@@ -0,0 +1,44 @@
+# [3.0.0](https://github.com/moneyforward/eslint-config-moneyforward/compare/2.0.0...3.0.0) (2024-04-18)
+
+
+### Bug Fixes
+
+* Allow to omit importing some functions for test files written in TypeScript ([#250](https://github.com/moneyforward/eslint-config-moneyforward/issues/250)) ([7da21e3](https://github.com/moneyforward/eslint-config-moneyforward/commit/7da21e31a85d0e3d3a08e86569eb0036bbbc5fa0))
+
+
+### Features
+
+* Implement CD "release" ([#255](https://github.com/moneyforward/eslint-config-moneyforward/issues/255)) ([66734d1](https://github.com/moneyforward/eslint-config-moneyforward/commit/66734d14863fd954a00cd50ba3e5082d72ecb60d))
+* Implement config "node" ([#244](https://github.com/moneyforward/eslint-config-moneyforward/issues/244)) ([170e699](https://github.com/moneyforward/eslint-config-moneyforward/commit/170e699130abd697449c0a3ab0f6e6ec4c93f5f6))
+* Implement config "react" ([#240](https://github.com/moneyforward/eslint-config-moneyforward/issues/240)) ([a8908d6](https://github.com/moneyforward/eslint-config-moneyforward/commit/a8908d640cb491838292a2a516fa460b289c0006))
+* Implement config `jsdoc` ([#238](https://github.com/moneyforward/eslint-config-moneyforward/issues/238)) ([24cdd78](https://github.com/moneyforward/eslint-config-moneyforward/commit/24cdd7838b35bbcbb32548dde1bc7fefe0175076))
+* Implement the rule "best-practices" ([#210](https://github.com/moneyforward/eslint-config-moneyforward/issues/210)) ([701a0e6](https://github.com/moneyforward/eslint-config-moneyforward/commit/701a0e68d674863759deccfcdf82a8ed80a06f66))
+* Implement the rule "errors" ([#211](https://github.com/moneyforward/eslint-config-moneyforward/issues/211)) ([907c92a](https://github.com/moneyforward/eslint-config-moneyforward/commit/907c92a3fa6b6b5b3fdbe9202abe06a61ad5860c))
+* Implement the rule "es6" ([#212](https://github.com/moneyforward/eslint-config-moneyforward/issues/212)) ([31e3000](https://github.com/moneyforward/eslint-config-moneyforward/commit/31e30009d6785d285aafd8e5f147c96c41abc2c1))
+* Implement the rule "imports" ([#213](https://github.com/moneyforward/eslint-config-moneyforward/issues/213)) ([b09c196](https://github.com/moneyforward/eslint-config-moneyforward/commit/b09c196449defabf08aab30b23e5f5d5f4e7e291))
+* Implement the rule "react-hooks" ([#226](https://github.com/moneyforward/eslint-config-moneyforward/issues/226)) ([d1e574d](https://github.com/moneyforward/eslint-config-moneyforward/commit/d1e574d216e09d7759f40aa1a69f3689f79bb276))
+* Implement the rule "style" ([#216](https://github.com/moneyforward/eslint-config-moneyforward/issues/216)) ([6d2261d](https://github.com/moneyforward/eslint-config-moneyforward/commit/6d2261d42910c7cbc091636669d78a824960e1dd))
+* Implement the rule "variables" ([#222](https://github.com/moneyforward/eslint-config-moneyforward/issues/222)) ([e91e5d2](https://github.com/moneyforward/eslint-config-moneyforward/commit/e91e5d244a00a9938770f1b386248e7ef47f2c42))
+* Implement v3 config "essentials" ([#237](https://github.com/moneyforward/eslint-config-moneyforward/issues/237)) ([af7c775](https://github.com/moneyforward/eslint-config-moneyforward/commit/af7c7757ff8185942ac0ca5f606bafcd365414b4))
+* Implement v3 config "next" ([#243](https://github.com/moneyforward/eslint-config-moneyforward/issues/243)) ([00fdb4d](https://github.com/moneyforward/eslint-config-moneyforward/commit/00fdb4d25d055a5feb18b1cd39cfef2e2babb115))
+* Implement v3 config "storybook" ([#241](https://github.com/moneyforward/eslint-config-moneyforward/issues/241)) ([bca4534](https://github.com/moneyforward/eslint-config-moneyforward/commit/bca453402d5a88d57728ffed69bff1c5551e842b))
+* Implement v3 config "test/react" ([#239](https://github.com/moneyforward/eslint-config-moneyforward/issues/239)) ([e488f4a](https://github.com/moneyforward/eslint-config-moneyforward/commit/e488f4a4684db27f944ce875b475ca665c1b41fc))
+* Implement v3 config "typescript" ([#242](https://github.com/moneyforward/eslint-config-moneyforward/issues/242)) ([eb3d1e4](https://github.com/moneyforward/eslint-config-moneyforward/commit/eb3d1e4371760adbff1f9e33220c22d3750974c5))
+* Implement v3 rule "jesdoc" ([#234](https://github.com/moneyforward/eslint-config-moneyforward/issues/234)) ([b407ee3](https://github.com/moneyforward/eslint-config-moneyforward/commit/b407ee352e32e77ad870259fa20fe5087646802d))
+* Implement v3 rule "jest-dom" ([#231](https://github.com/moneyforward/eslint-config-moneyforward/issues/231)) ([e0891ed](https://github.com/moneyforward/eslint-config-moneyforward/commit/e0891ed1a1e0e816f881a84df94b563665e23698))
+* Implement v3 rule "jest" ([#228](https://github.com/moneyforward/eslint-config-moneyforward/issues/228)) ([d544fa0](https://github.com/moneyforward/eslint-config-moneyforward/commit/d544fa0e6e99cd27cdad6110bec57c400d29c1c9))
+* Implement v3 rule "next" ([#227](https://github.com/moneyforward/eslint-config-moneyforward/issues/227)) ([b1662ad](https://github.com/moneyforward/eslint-config-moneyforward/commit/b1662ad1fcaf1f18eb6cc70785e32c61986389a5))
+* Implement v3 rule "node" ([#215](https://github.com/moneyforward/eslint-config-moneyforward/issues/215)) ([91bcb4c](https://github.com/moneyforward/eslint-config-moneyforward/commit/91bcb4c1ea1e74a66b335447225cd45f184dbd97))
+* Implement v3 rule "promise" ([#223](https://github.com/moneyforward/eslint-config-moneyforward/issues/223)) ([b79e339](https://github.com/moneyforward/eslint-config-moneyforward/commit/b79e339d0d048b3a7d225064082acd28827be0e9))
+* Implement v3 rule "testing-library" ([#232](https://github.com/moneyforward/eslint-config-moneyforward/issues/232)) ([6afbe8f](https://github.com/moneyforward/eslint-config-moneyforward/commit/6afbe8f010dd758ae16030d3632bb16662d44f12))
+* Implement v3 rule "typescript" ([#236](https://github.com/moneyforward/eslint-config-moneyforward/issues/236)) ([6d42dc6](https://github.com/moneyforward/eslint-config-moneyforward/commit/6d42dc6e08af96f883a06ea484a4244984a57764))
+* Implement v3 rule `jsx-a11y` ([#224](https://github.com/moneyforward/eslint-config-moneyforward/issues/224)) ([7fe1bd4](https://github.com/moneyforward/eslint-config-moneyforward/commit/7fe1bd495a5326eb058437b0e5118fc9a3810bdd))
+* Implement v3 rule `react` ([#225](https://github.com/moneyforward/eslint-config-moneyforward/issues/225)) ([fe33aa2](https://github.com/moneyforward/eslint-config-moneyforward/commit/fe33aa2a34667f151b1f45aef0c899f2a7328b34))
+* Implement v3 rule storybook ([#233](https://github.com/moneyforward/eslint-config-moneyforward/issues/233)) ([d879dc5](https://github.com/moneyforward/eslint-config-moneyforward/commit/d879dc5dbe5aa1e3678076d87dee4b990d377a52))
+
+
+### BREAKING CHANGES
+
+* * Linter rules have been significantly added and are now more strict.
+
+* The way `eslintrc` is configured has been changed.

package/README.md

@@ -1,59 +1,101 @@
 # 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
+
+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                    | [`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-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
+```
 
-```json
+### 2. Configure ESLint
+
+Within your ESLint config file:
+
+```diff
 {
-  "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 `moneyforward/essentials` that conflict with Prettier.
+
 ## 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/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/jsdoc.js

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

package/configs/next.js

@@ -1,8 +1,3 @@
 module.exports = {
-  extends: [
-    require.resolve('./react'),
-    // https://github.com/vercel/next.js/blob/6f420962338fb99a377bde8e1e663bc202c95b68/packages/eslint-plugin-next/lib/index.js
-    'plugin:@next/next/recommended',
-  ],
-  plugins: ['@next/next'],
+  extends: ['../rules/next'],
 };

package/configs/node.js

@@ -1,9 +1,6 @@
 module.exports = {
+  extends: ['../rules/node'],
   env: {
     node: true,
   },
-  extends: [
-    // https://github.com/mysticatea/eslint-plugin-node/blob/f45c6149be7235c0f7422d1179c25726afeecd83/lib/index.js
-    'plugin:node/recommended',
-  ],
 };

package/configs/react.js

@@ -1,25 +1,7 @@
 module.exports = {
-  extends: [
-    // https://github.com/yannickcr/eslint-plugin-react/blob/9f1d618499b23e184a628365cb5e0ea48292cd6f/index.js
-    'plugin:react/recommended',
-    // https://github.com/facebook/react/blob/73ffce1b6fb7eff13414e35e40efe4269664e5ea/packages/eslint-plugin-react-hooks/src/index.js
-    'plugin:react-hooks/recommended',
-  ],
-  plugins: ['react'],
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
-    },
-  },
-  rules: {
-    // don't have to use props-types
-    'react/prop-types': 'off',
-    // don't have to import React
-    'react/react-in-jsx-scope': 'off',
-  },
+  extends: ['../rules/react', '../rules/react-hooks', '../rules/jsx-a11y'],
   settings: {
     react: {
-      // https://github.com/yannickcr/eslint-plugin-react/issues/1955
       version: 'detect',
     },
   },

package/configs/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/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/typescript.js

@@ -1,16 +1,9 @@
 module.exports = {
   overrides: [
     {
-      files: ['**/*.ts?(x)'],
-      extends: [
-        // https://github.com/typescript-eslint/typescript-eslint/blob/8cfe93372e1d826e54febc3aeb7047c792b90963/packages/eslint-plugin/src/configs/recommended.ts
-        'plugin:@typescript-eslint/recommended',
-      ],
-      plugins: ['@typescript-eslint'],
+      extends: ['../rules/typescript'],
+      files: ['*.@(ts|tsx|cts|mts)'],
       parser: '@typescript-eslint/parser',
-      parserOptions: {
-        sourceType: 'module',
-      },
     },
   ],
 };

package/package.json

@@ -1,12 +1,25 @@
 {
   "name": "eslint-config-moneyforward",
-  "version": "2.0.0",
-  "main": "rules/index.js",
+  "version": "3.0.0",
+  "description": "Money Forward's ESLint rules as an extensible shared config.",
+  "exports": {
+    "./essentials": "./configs/essentials.js",
+    "./jsdoc": "./configs/jsdoc.js",
+    "./next": "./configs/next.js",
+    "./node": "./configs/node.js",
+    "./react": "./configs/react.js",
+    "./storybook": "./configs/storybook.js",
+    "./test/*": "./configs/test/*.js",
+    "./typescript": "./configs/typescript.js"
+  },
+  "engines": {
+    "node": ">= 18.0.0"
+  },
   "scripts": {
     "lint": "eslint && prettier --check .",
     "lint:fix": "eslint --fix && prettier --write .",
     "test": "jest",
-    "release": "release-it"
+    "release": "semantic-release"
   },
   "repository": {
     "type": "git",
@@ -19,25 +32,39 @@
   },
   "homepage": "https://github.com/moneyforward/eslint-config-moneyforward#readme",
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.48.2",
-    "@typescript-eslint/parser": "^5.48.2",
-    "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-jest-dom": "^4.0.3",
-    "eslint-plugin-next": "^0.0.0",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-react": "^7.32.1",
+    "@next/eslint-plugin-next": "^14.1.3",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "confusing-browser-globals": "^1.0.11",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-jest-dom": "^5.1.0",
+    "eslint-plugin-jsdoc": "^48.2.1",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-react": "^7.34.0",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-testing-library": "^5.9.1"
+    "eslint-plugin-storybook": "^0.8.0",
+    "eslint-plugin-testing-library": "^5.11.1"
   },
   "devDependencies": {
-    "eslint": "^8.32.0",
-    "jest": "^29.3.1",
-    "prettier": "^2.8.3",
-    "release-it": "^15.6.0"
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/git": "10.0.1",
+    "eslint": "^7.32.0 || ^8.2.0",
+    "eslint-config-prettier": "^9.1.0",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.7",
+    "semantic-release": "23.0.8",
+    "typescript": ">= 4.2.4 || ^5.0.0"
   },
   "peerDependencies": {
-    "eslint": ">=7",
-    "typescript": ">=4"
+    "eslint": "^7.32.0 || ^8.2.0",
+    "typescript": ">= 4.2.4 || ^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
   }
 }

package/release.config.js

@@ -0,0 +1,24 @@
+/**
+ * @type {import('semantic-release').GlobalConfig}
+ */
+module.exports = {
+  branches: ['main'],
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    '@semantic-release/changelog',
+    '@semantic-release/npm',
+    [
+      '@semantic-release/git',
+      {
+        assets: ['CHANGELOG.md', 'package.json', 'package-lock.json'],
+        message:
+          // eslint-disable-next-line no-template-curly-in-string
+          'chore(release): ${nextRelease.version} \n\n${nextRelease.notes}',
+      },
+    ],
+    '@semantic-release/github',
+  ],
+  // eslint-disable-next-line no-template-curly-in-string
+  tagFormat: '${version}',
+};