@autossey/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.

---

This package provides a base ESLint config for TypeScript, and a second for TypeScript with React.

Installation

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

yarn add --dev @autossey/eslint-config

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

bun add --dev @autossey/eslint-config

Usage

In your package.json file:

TypeScript

This is a generic config for projects that use TypeScript.

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

Node

The node config extends the typescript config and adds rules for Node.js.

{
  "eslintConfig": {
    "extends": "@autossey/eslint-config/node"
  }
}

React

The react config extends the typescript config and adds rules for React.

{
  "eslintConfig": {
    "extends": "@autossey/eslint-config/react"
  }
}

Running ESLint

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

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": {
    "@autossey/eslint-config": "~0.2.0"
  }
}

Dependencies

• @types/eslint: TypeScript definitions for eslint
• @typescript-eslint/eslint-plugin: TypeScript plugin for ESLint
• @typescript-eslint/parser: An ESLint custom parser which leverages TypeScript ESTree
• eslint-plugin-i: A fork of eslint-plugin-import using get-tsconfig to replace tsconfig-paths and heavy typescript under the hood.
• eslint-plugin-json: eslint plugin for JSON files
• eslint-plugin-n: Additional ESLint's rules for Node.js
• eslint-plugin-react: React specific linting rules for ESLint
• eslint-plugin-react-hooks: ESLint rules for React Hooks

Peer Dependencies

• eslint: An AST-based pattern checker for JavaScript.

Dev Dependencies

• @autossey/tsconfig: A collection of base TSConfigs for various types of projects.
• eslint: An AST-based pattern checker for JavaScript.

License

MIT - MIT License