eslint-config-conventions/README.md

eslint-config-conventions

ESLint shareable config to enforce strict conventions and good code quality.

📜 About

eslint-config-conventions is a ESLint configuration to enforce strict conventions and good code quality, it is highly inspired from eslint-config-standard-with-typescript but it is stricter and with no formatting rules, only code-quality rules. It supports both JavaScript and TypeScript.

This configuration is mostly for catching bugs and code-quality so it is recommended to use it with Prettier for a consistent code style, it works with any .prettierrc.json configuration.

More information about formatting rules vs code-quality rules can be found on Prettier vs. Linters.

⚙️ Getting Started

Prerequisites

Node.js >= 18.0.0

Installation

npm install --save-dev \
  eslint@^8.51.0 \
  eslint-plugin-import@^2.28.1 \
  eslint-plugin-promise@^6.1.1 \
  eslint-plugin-unicorn@^48.0.1 \
  eslint-config-conventions@latest

This list of dependencies are:

• ESLint
• 3 ESLint Plugins
  • eslint-plugin-import
  • eslint-plugin-promise
  • eslint-plugin-unicorn
• This package: eslint-config-conventions

If you want to use TypeScript, you also need to install:

npm install --save-dev \
  typescript@^5.2.2 \
  @typescript-eslint/eslint-plugin@^6.8.0 \
  @typescript-eslint/parser@^6.8.0

Dependencies are:

• TypeScript
• @typescript-eslint/eslint-plugin: ESLint rules for TypeScript.
• @typescript-eslint/parser: ESLint parser for TypeScript.

Configuration with Prettier (recommended)

You will need to install some dependencies in addition to those required:

npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier

# Create an empty config file to let editors and other tools know you are using Prettier
# You can personalize it with your own rules
echo "{}" > .prettierrc.json

.eslintrc.json

{
  "extends": ["conventions", "prettier"],
  "plugins": ["prettier"],
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "project": "./tsconfig.json"
  },
  "rules": {
    "prettier/prettier": "error"
  }
}

Note: Please read some important instructions regarding the project option here.

"parserOptions.project" is only required if you use TypeScript.

package.json

{
  "scripts": {
    "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
    "lint:prettier": "prettier . --check"
  }
}

Usage

npm run lint:eslint
# or to apply automatic fixes to code
npm run lint:eslint -- --fix

# Validate code formatting in all supported languages by Prettier
npm run lint:prettier

💡 Contributing

Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.

The steps to contribute can be found in the CONTRIBUTING.md file.

📄 License

MIT