@cprussin/eslint-config v2.0.0
@cprussin/eslint-config - v2.0.0
This package contains a set of strict base eslint configs for packages using ESM.
Note this package exports configs in the new eslint flat config format.
Installing
Use the package manager of your choice to install:
- npm:
npm install --save-dev @cprussin/eslint-config
- pnpm:
pnpm add -D @cprussin/eslint-config
- yarn:
yarn add -D @cprussin/eslint-config
Usage
First, ensure you're using ESM (set "type": "module"
in your
package.json.
). Then, the most basic eslint.config.js
could look like
this:
export { base as default } from "@cprussin/eslint-config";
To override things, just concat the config you want together, for instance:
import { base } from "@cprussin/eslint-config";
export default [
...base,
{
ignores: ["foo/bar/**"],
},
];
Table of contents
Variables
Functions
Variables
base
• Const
base: Linter.FlatConfig
[]
This configuration is the base configuration for the others. It can be used standalone in a project that doesn't need one of the extensions. It extends a number of shared configs and sets some strict opinionated configs for the following file types:
- Typescript
- CJS
- ESM
- JSON
- Jest test files
Example
// eslint.config.js
export { base as default } from "@cprussin/eslint-config";
Defined in
nextjs
• Const
nextjs: Linter.FlatConfig
[]
This configuration extends the base and react configurations
and adds the next/core-web-vitals
config.
Example
// eslint.config.js
export { nextjs as default } from "@cprussin/eslint-config";
Defined in
react
• Const
react: Linter.FlatConfig
[]
This configuration extends the base configuration and adds the
react
, react-hooks
, and jsx-a11y
shared configs. It also adds configs
for jest dom tests using the jest-dom
and testing-library
shared configs
for test files.
Example
// eslint.config.js
export { react as default } from "@cprussin/eslint-config";
Defined in
storybook
• Const
storybook: Linter.FlatConfig
[]
This configuration sets up the storybook plugin.
Defined in
Functions
tailwind
▸ tailwind(tailwindConfig
): FlatConfig
[]
This configuration sets up linting for tailwind styles.
Parameters
Name | Type | Description |
---|---|---|
tailwindConfig | string | the path to the project's tailwind config file |
Returns
FlatConfig
[]
the eslint config