eslint-config-braintree/README.md

Braintree's ESLint configuration

# eslint-config-braintree

Shared linting configuration for braintree js projects.

- [index.js](./index.js): shared configuration
- [client.js](./client.js): client side configuration
- [server.js](./server.js): server side configuration
- [jsdoc.js](./jsdoc.js): jsdoc configuration

## Consuming

Install eslint@^8

```bash
npm install eslint@^8
```

Install the eslint config

```bash
npm i --save-dev eslint-config-braintree
```

Eslint requires all the plugins that the configu uses to be installed at
the root of the project as well.

```bash
npm i --save-dev @typescript-eslint/eslint-plugin eslint-plugin-prettier
```

In your project's `.eslintrc.*`:

### yaml

**default**

```yaml
---
extends: braintree
```

**browserify**

```yaml
---
extends: braintree/client
```

**node**

```yaml
---
extends: braintree/server
```

**browserify + es6**

```yaml
---
extends:
  - braintree/client
  - braintree/es6
```

### json

**default**

```json
{
  "extends": "braintree"
}
```

**browserify**

```json
{
  "extends": "braintree/client"
}
```

**node**

```json
{
  "extends": "braintree/server"
}
```

**browserify + es6**

```json
{
  "extends": ["braintree/client", "braintree/es6"]
}
```

You can specify a `.eslintrc` for a subdirectory to change the rules
that are enforced. For instance, in a node project you could extend from
`eslint-config-braintree/server` at the top-level, and
`eslint-braintree-config/client` at the `public/.eslintrc` level.

See [Configuration File
Formats](https://eslint.org/docs/user-guide/configuring#configuration-file-formats)
for information on all supported `.eslintrc` file formats.

To override rules, add the new config under `rules` in your rc file. Be
sure to properly override any options set by the parent. See [Extending
Configuration
Files](https://eslint.org/docs/user-guide/configuring#extending-configuration-files)
for details.

For example, to change the `no-new-object` rule to warn instead of
error:

```yaml
---
extends: braintree/server
rules:
  no-new-object: 1
```

```json
{
  "extends": "braintree/server",
  "rules": {
    "no-new-object": 1
  }
}
```

In another example, to allow end of line comments, you'd override the
`"no-multi-spaces"` rule options:

```yaml
---
extends: braintree/server
rules:
  no-multi-spaces:
    - 2
    - ignoreEOLComments: false
```

```json
{
  "extends": "braintree/server",
  "rules": {
    "no-multi-spaces": [2, { "ignoreEOLComments": false }]
  }
}
```

## Test Files

By default, any files in a `__tests__` folder, whether at the top level
of the directory or within another directory will be configured to be
used in the [Jest](https://jestjs.io/) and ES2020 environments.