@autosoft/eslint-config

A base for projects that use ESLint.

If I should maintain this repo, please ⭐️

DM me on Twitter if you have questions or suggestions.

Installation

yarn add --dev @autosoft/eslint-config

npm install --save-dev @autosoft/eslint-config

pnpm add --save-dev @autosoft/eslint-config

Usage

In your package.json file:

{
  "eslintConfig": {
    "extends": "@autosoft/eslint-config"
  }
}

Running ESLint

Now to run ESLint, run yarn eslint source or npm run eslint source.

If you have autorepo installed, yarn auto lint source or npm run auto lint source will also run ESLint.

Updates

As this package updates, bug fixes are considered patch updates as usual.

Rule changes are considered minor updates. Rule changes can cause linting errors in your code, If you want to avoid rule changes, you can set your package to use a specific minor version of this package with the ~ operator:

{
  "devDependencies": {
    "@autosoft/eslint-config": "~1.1.0"
  }
}

Dependencies

• @typescript-eslint/eslint-plugin: TypeScript plugin for ESLint
• @typescript-eslint/parser: An ESLint custom parser which leverages TypeScript ESTree
• eslint: An AST-based pattern checker for JavaScript.
• eslint-plugin-import: Import with sanity.
• eslint-plugin-json: eslint plugin for JSON files
• eslint-plugin-react: React specific linting rules for ESLint
• eslint-plugin-react-hooks: ESLint rules for React Hooks
• types-eslintrc: Type checking for .eslintrc.json

Dev Dependencies

• @autosoft/tsconfig: A base for TypeScript projects.

License

MIT - MIT License