# boiler-config-eslint

> Linting Config

Latest version **3.6.0** (published 2016-10-27) · ISC license · 0 weekly downloads

## Install

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

## 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 | 3.6.0 |
| Published | 2016-10-27 |
| First published | 2016-03-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | DtotheFP |
| Maintainers | atungare, dtothefp, stephenkao |

## Links

- npm: https://www.npmjs.com/package/boiler-config-eslint
- Repository: https://github.com/build-boiler/open-eslint-config
- Homepage: https://github.com/build-boiler/open-eslint-config#readme
- Issues: https://github.com/build-boiler/open-eslint-config/issues
- npm.io page: https://npm.io/package/boiler-config-eslint

## Dependencies (5)

- [findup-sync](https://npm.io/package/findup-sync.md) ^0.3.0
- [boiler-utils](https://npm.io/package/boiler-utils.md) ^3.6.0
- [app-root-path](https://npm.io/package/app-root-path.md) ^1.0.0
- [object-assign](https://npm.io/package/object-assign.md) ^4.0.1
- [babel-plugin-transform-runtime](https://npm.io/package/babel-plugin-transform-runtime.md) ^6.8.0

## Recent versions

- 3.6.0 (latest) — 2016-10-27
- 4.4.3 — 2016-10-27
- 5.2.4 — 2016-10-27
- 3.5.2 — 2016-10-26
- 4.4.2 — 2016-10-26
- 5.2.2 — 2016-10-19
- 4.4.1 — 2016-10-19
- 3.5.0 — 2016-10-19
- 4.4.0 — 2016-10-19
- 5.1.5 — 2016-10-17
- 5.1.4 — 2016-10-15
- 4.3.1 — 2016-10-15
- 3.4.5 — 2016-10-14
- 5.1.2 — 2016-10-11
- 5.0.0 — 2016-10-11
- … 25 more at https://npm.io/package/boiler-config-eslint/versions

## README

# eslint-config
Configuration for JavaScript code linting.

#### Gulp
- must be used with `gulp-eslint@2`
```js
import eslintConfig from 'eslint-config';
import formatter from 'eslint-friendly-formatter';

gulp.task('lint', () => {
  const lintConfig = eslintConfig({
    isDev: true,
    lintEnv: 'build'
  });

  return gulp.src(src)
    .pipe(eslint(lintConfig))
    .pipe(eslint.format(formatter));
});
```

#### Webpack

```js
import eslintConfig from 'eslint-config';

const {rules, configFile} = eslintConfig({/*options*/});

export default {
  entry: //
  output: //
  eslint: {
    rules,
    configFile,
    formatter,
    emitError: false,
    emitWarning: false,
    failOnWarning: !isDev,
    failOnError: !isDev
  }
}
```

## API

### eslint(options)

#### options.isDev

Type: `Boolean`

Allows `debugger` and `console` as well as being lighter on other rules

#### options.basic

Type: `Boolean`

Only applies a small subset of rules

#### options.lintEnv

Type: `String` 'build', 'web', 'test'

Changes rules per env

#### options.react

Type: `Boolean`

Add rules for React/JSX

#### options.generate

Type: `Boolean`

Generate a `.eslintrc` in your project root

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