eslint-config-moneyforward

This package provides moneyforward's .eslintrc as an extensible shared config.

Usage

1. Install dependencies (and peer dependencies)

npm install --save-dev eslint-config-moneyforward eslint

2. Configure ESLint

Within your ESLint config file:

{
  "extends": ["moneyforward/essentials"]
}

If you need React Support:

{
  "extends": [
    "moneyforward/essentials",
+   "moneyforward/react",
  ]
}

Must be added after essentials.

We also provide various other rule sets that you can configure to suit your project.

{
  "extends": [
    "moneyforward/essentials",
    "moneyforward/jsdoc",
    "moneyforward/next",
    "moneyforward/node",
    "moneyforward/react",
    "moneyforward/storybook",
    "moneyforward/test/react",
    "moneyforward/typescript"
  ]
}

Rule set	Summary	Dependencies
essentials	Contains basic, import, and promise recommended rules	eslint eslint-plugin-promise eslint-plugin-import
jsdoc	Contains JSDoc recommended rules	eslint-plugin-jsdoc
next	Contains Next.js recommended rules	eslint-plugin-next
node	Contains Node.js recommended rules	eslint-plugin-n
react	Contains React recommended rules	eslint-plugin-jsx-a11y eslint-plugin-react-hooks eslint-plugin-react
storybook	Contains Storybook recommended rules	eslint-plugin-storybook
test/react	Contains Jest and React Testing Library rules	eslint-plugin-jest eslint-plugin-testing-library
typescript	Contains TypeScript recommended rules	@eslint-typescript/eslint-plugin @eslint-typescript/parser

Using Prettier

If you use Prettier to format your code, you must disable any rules in moneyforward/essentials that conflict with Prettier.

1. Install dependencies

npm install --save-dev eslint-config-prettier

2. Configure ESLint

Within your ESLint config file:

{
  "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.