@inialum/eslint-config

ESLint config for INIALUM

Installation

pnpm add -D eslint @inialum/eslint-config

Configuration Example

Default (TypeScript)

If no config is specified, the base typescript config will be used.

module.exports = {
  extends: ['@inialum'], // same as "@inialum/eslint-config/typescript"
  parserOptions: {
    project: './tsconfig.json', // Rewrite this to your tsconfig path
  },
}

React

module.exports = {
  extends: ['@inialum/eslint-config/react'],
  parserOptions: {
    project: './tsconfig.json', // Rewrite this to your tsconfig path
  },
}

When you use this config, you should also install eslint-plugin-react-hooks, eslint-plugin-react-refresh and eslint-plugin-storybook as devDependencies.

pnpm add -D eslint-plugin-react-hooks eslint-plugin-react-refresh eslint-plugin-storybook

React Testing Library

module.exports = {
  extends: [
    '@inialum', // Optional
    '@inialum/eslint-config/react-testing-library',
  ],
}

When you use this config, you should also install eslint-plugin-testing-library as devDependencies.

pnpm add -D eslint-plugin-testing-library

Next.js

module.exports = {
  extends: ['@inialum/eslint-config/next'],
  parserOptions: {
    project: './tsconfig.json', // Rewrite this to your tsconfig path
  },
}

When you use this config, you should also install eslint-config-next and eslint-plugin-storybook as devDependencies.

pnpm add -D eslint-config-next eslint-plugin-storybook

Minimal

e.g.) .js files

module.exports = {
  extends: ['@inialum/eslint-config/base'],
}

Release (for maintainers)

Run Release workflow (GitHub Actions) to publish new version to npm. You can choose major, minor, or patch version to be released. This workflow will automatically create a new release in GitHub and publish the package to npm.

License

Licensed under Apache License 2.0.