readme.md

@envsa/eslint-config

ESLint configuration for @envsa/shared-config.

Overview

It's a shared ESLint config.

See @envsa/shared-config for the recommended single-package approach.

Setup

To use just this ESLint config in isolation:

1. Install the .npmrc in your project root. This is required for correct PNPM behavior:

   pnpm dlx @envsa/repo-config --init

2. Add the package:

   pnpm add -D @envsa/eslint-config

3. 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 @envsa/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.

Credits

Eric Mika is the author of the original @kitschpatrol/shared-config project on which this is based.

License

MIT © Liam Rella