eslint-config-cratebind

8.0.1 verified Fri May 01 auth: no javascript

A shareable ESLint configuration preset from Cratebind. Current stable version is 8.0.1. Provides a base set of linting rules for JavaScript projects, focusing on consistency and best practices. To use, you must install ESLint separately (as a peer dependency) and extend the config in your .eslintrc file. The package follows the standard ESLint shareable config pattern, allowing rule overrides. It is recommended for use with Husky and lint-staged for pre-commit hooks. Differentiation lies in Cratebind's specific rule choices, but the config is open for customization.

Common errors

error ESLint couldn't find the plugin "eslint-config-cratebind". ↓

cause The package is not installed.

fix

Run npm install eslint-config-cratebind --save-dev

error Configuration for rule "react/prop-types" is invalid. ↓

cause Rule value should be 0, 1, or 2.

fix

Set "react/prop-types": 0 (or 1 or 2) in your .eslintrc rules.

Warnings

gotcha If ESLint is installed globally, eslint-config-cratebind must also be installed globally. ↓

fix Install both packages with -g flag or use local installation.

Install

npm install eslint-config-cratebind

yarn add eslint-config-cratebind

pnpm add eslint-config-cratebind

Imports

cratebind

wrong

{
  "extends": ["eslint-config-cratebind"]
}

correct

{
  "extends": ["cratebind"]
}

In .eslintrc, you can omit the 'eslint-config-' prefix.

rules
wrong
```
No common mistake.
```
correct
```
{
  "extends": ["cratebind"],
  "rules": {}
}
```
Overriding rules is done under the 'rules' key in .eslintrc.
plugins
wrong
```
No common mistake.
```
correct
```
Not needed unless adding extra plugins.
```
This config likely doesn't require additional plugins, but you can add them under 'plugins' in .eslintrc.

Quickstart

Install ESLint and the config, then create .eslintrc with extends.

npm install eslint --save-dev
npm install eslint-config-cratebind --save-dev