# eslint-config-cbtnuggets

> Base eslint configuration for CBT Nuggets

Latest version **8.2.2** (published 2021-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-config-cbtnuggets
pnpm add eslint-config-cbtnuggets
yarn add eslint-config-cbtnuggets
bun add eslint-config-cbtnuggets
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 8.2.2 |
| Published | 2021-06-15 |
| First published | 2017-10-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 62.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Maintainers | reginaldthistleton, steamedcotton |

## Links

- npm: https://www.npmjs.com/package/eslint-config-cbtnuggets
- Repository: https://github.com/cbtnuggets/eslint-config-cbtnuggets
- Issues: https://github.com/cbtnuggets/eslint-config-cbtnuggets/issues
- npm.io page: https://npm.io/package/eslint-config-cbtnuggets

## Dependencies (5)

- [eslint](https://npm.io/package/eslint.md) ^5.8.0
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.6.1
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.8.0
- [eslint-plugin-jsx-a11y](https://npm.io/package/eslint-plugin-jsx-a11y.md) ^6.0.3
- [eslint-plugin-class-property](https://npm.io/package/eslint-plugin-class-property.md) ^1.0.1

## Recent versions

- 8.2.2 (latest) — 2021-06-15
- 8.2.1 — 2020-02-05
- 8.1.1 — 2019-05-31
- 8.0.0 — 2019-01-17
- 7.0.5 — 2018-05-24
- 7.0.4 — 2018-05-24
- 7.0.3 — 2018-05-23
- 7.0.2 — 2018-05-22
- 7.0.0 — 2018-02-15
- 6.0.1 — 2017-10-17
- 6.0.0 — 2017-10-17

## README

# eslint-config-cbtnuggets

Configuration for setting up the CBT ESLint rules.

## Install

#### Project Install

This script will install and save (as devDependencies) everything that is needed to run our eslint rules in the project that the script is executed:

##### With NPM
```bash
export PKG=eslint-config-cbtnuggets
npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm i "$PKG@latest" --save-dev
```

##### With Yarn
```bash
export PKG=eslint-config-cbtnuggets
npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs yarn add -D "$PKG@latest"
```

#### Global Install

```bash
export PKG=eslint-config-cbtnuggets
npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm i -g "$PKG@latest"
```

## Migration

If migrating from an earlier version, simply running the install script again will install the latest project and all of its peerDependencies.

[Go to Install](https://github.com/cbtnuggets/eslint-config-cbtnuggets#install)

## Project Settings

Create an **.eslintrc** file in the base directory that you want to apply the given rule set.  
Multiple **.eslintrc** can be used if needed.

#### Node (ES6)
```json
{
  "extends": "cbtnuggets/rules/node-es6"
}
```

#### Node (ES6 with strict mode required)
```json
{
  "extends": "cbtnuggets/rules/node-strict"
}
```

#### Node (legacy)
```json
{
  "extends": "cbtnuggets/rules/node"
}
```


#### React
```json
{
  "extends": "cbtnuggets/rules/react"
}
```

## Testing ESLint Setup

For global installs, run something like:
```bash
eslint ./FILE-TO-TEST.js
```

For project level installs, run something like:
```bash
node ./node_modules/eslint/bin/eslint.js ./FILE-TO-TEST.js
```



## Dev Setup

This section outlines setting up a development environment to modify this project (the *"test project"* is the project that will be used to verify the changes to eslint rules)

#### In this project:

Create a link from the eslint-config-cbtnuggets project:
```bash
npm link
```

#### In the test project:

Make sure to remove the **eslint-config-cbtnuggets** project if it is currently installed.

Install all the dependencies in the project to use for testing the eslint (i.e. install eslint and all the plugins).  
Basically install everything listed in **eslint-config-cbtnuggets** **package.json** **peerDependencies**

Example:
```bash    
npm install "eslint"@"^4.17.0" "eslint-plugin-class-property"@"^1.0.1" "eslint-plugin-import"@"^2.8.0" "eslint-plugin-jsx-a11y"@"^6.0.3" "eslint-plugin-react"@"^7.6.1"
```

Link to eslint-config-cbtnuggets project:
```bash
npm link eslint-config-cbtnuggets
```

---
_Source: https://npm.io/package/eslint-config-cbtnuggets · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
