@kitschpatrol/eslint-config
v4.7.12
Published
ESLint configuration for @kitschpatrol/shared-config.
Downloads
67
Maintainers
Readme
@kitschpatrol/eslint-config
ESLint configuration for @kitschpatrol/shared-config.
Overview
It's a shared ESLint config.
See @kitschpatrol/shared-config
for the recommended single-package approach.
Setup
To use just this ESLint config in isolation:
Install the
.npmrc
in your project root. This is required for correct PNPM behavior:pnpm dlx @kitschpatrol/repo-config --init
Add the package:
pnpm add -D @kitschpatrol/eslint-config
Add the starter
.eslintrc.cjs
config and.eslintignore
files to your project root, and add any overrides you'd like:pnpm exec eslint-config --init
Usage
The ESLint binary should be picked up automatically by VS Code plugins.
You can call it directly, or use the script bundled with the config.
Integrate with your package.json
scripts as you see fit, for example:
"scripts": {
"lint": "eslint-config --check"
"fix": "eslint-config --fix"
}
CLI
Command: eslint-config
ESLint configuration for @kitschpatrol/shared-config.
Usage:
eslint-config [<file|glob> ...]
| Option | Argument | Description |
| ------------------------ | -------- | ---------------------------------------------------------------- |
| --check
-c
| | Check for and report issues. Same as eslint-config
. |
| --fix
-f
| | Fix all auto-fixable issues, and report the un-fixable. |
| --init
-i
| | Initialize by copying starter config files to your project root. |
| --print-config
-p
| <path>
| Print the effective configuration at a certain path. |
| --help
-h
| | Print this help info. |
| --version
-v
| | Print the package version. |
Notes
The whole flat file config thing is pending...
ESLint does not inherit files and paths from .gitignore
. Ignored paths must be specified in .eslintignore
.
This shared config will also initialize a tsconfig.json
and a tsconfig.eslint.json
. These should probably live in a separate configuration package, but they'll reside here for now.
License
MIT © Eric Mika