# eslint-config-bom

> BOM ESLint config

Latest version **0.5.0** (published 2019-07-09) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2019-07-09 |
| First published | 2019-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 8 |
| Dependencies | 3 |
| Unpacked size | 2.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | digitaldeveloper-bom |

## Links

- npm: https://www.npmjs.com/package/eslint-config-bom
- npm.io page: https://npm.io/package/eslint-config-bom

## Dependencies (3)

- [eslint](https://npm.io/package/eslint.md) 5.16.0
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) 2.18.0
- [eslint-config-airbnb-base](https://npm.io/package/eslint-config-airbnb-base.md) 13.2.0

## Recent versions

- 0.5.0 (latest) — 2019-07-09
- 0.4.0 — 2019-06-27

## README

# eslint-config-bom

This package provides BOM's JS .eslintrc as an extensible shared config. It is based on Airbnb's ```eslint-config-airbnb-base```.

# How to use

## Add this project to your own:

```
npm install --save-dev git+ssh://git@gitlab.bom.gov.au:ddd/eslint-config-bom.git#develop
```

## Install the following dependencies:

```
npm install --save-dev eslint eslint-plugin-import
```

## Create your ```.eslintrc```

```javascript
{
 "env": {
   "es6": true,
   "node": true,
   "browser": true,
   "jest": true
 },
 "plugins": [
   // extra plugins go here
 ],
 "extends": [
   "bom",
 ],
 "rules": {
   // custom rules go here
 }
}
```

## Create your ```.eslintignore```

The following is an example of directories to be ignored.

```
build/
config/
scripts/
```

## Run eslint using npm

**Add eslint script to your package.json**

```json
  "scripts": {
    "eslint": "eslint .",
    ...
  }
```

**Call eslint script**

```
npm run eslint
```

## Run eslint from command-line

```
./node_modules/.bin eslint src/
```

# Further reading

* [ESLint Rules](http://eslint.org/docs/rules/)
* [Airbnb's ESLint config](https://www.npmjs.com/package/eslint-config-airbnb-base)

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