# @bizdotcom/eslint-config-bdc

> eslint config for business.com, businessnewsdaily.com, buyerzone.com and other related projects

Latest version **0.0.1** (published 2020-02-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @bizdotcom/eslint-config-bdc
pnpm add @bizdotcom/eslint-config-bdc
yarn add @bizdotcom/eslint-config-bdc
bun add @bizdotcom/eslint-config-bdc
```

## 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.0.1 |
| Published | 2020-02-05 |
| First published | 2020-02-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | BDC Dev Garage |
| Maintainers | alexjsdev |
| Keywords | eslint, config, javascript, code, style, linting |

## Links

- npm: https://www.npmjs.com/package/@bizdotcom/eslint-config-bdc
- Repository: https://github.com/businessdotcom/eslint-config-bdc
- Homepage: https://github.com/businessdotcom/eslint-config-bdc#readme
- Issues: https://github.com/businessdotcom/eslint-config-bdc/issues
- npm.io page: https://npm.io/package/@bizdotcom/eslint-config-bdc

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2020-02-05

## README

# eslint-config-bdc

business.com engineering team's eslint setup via reusable NPM package.


This eslint config extends [this create react app one](https://github.com/facebook/create-react-app/tree/master/packages/eslint-config-react-app)
and adds [prettier](https://prettier.io/docs/en/integrating-with-linters.html) formatting to it with some additional rules we standardized around at business.com.

## Install:

#### Step 1: Install the config and all of it's peer deps:
```
yarn add -D @bizdotcom/eslint-config-bdc eslint-config-react-app @typescript-eslint/eslint-plugin@2.x @typescript-eslint/parser@2.x babel-eslint@10.x eslint@6.x eslint-plugin-flowtype@3.x eslint-plugin-import@2.x eslint-plugin-jsx-a11y@6.x eslint-plugin-react@7.x eslint-plugin-react-hooks@1.x prettier eslint-plugin-prettier

or

npm install -D @bizdotcom/eslint-config-bdc eslint-config-react-app @typescript-eslint/eslint-plugin@2.x @typescript-eslint/parser@2.x babel-eslint@10.x eslint@6.x eslint-plugin-flowtype@3.x eslint-plugin-import@2.x eslint-plugin-jsx-a11y@6.x eslint-plugin-react@7.x eslint-plugin-react-hooks@1.x prettier eslint-plugin-prettier
```

#### Step 2: Create a file named `.eslintrc.json` with following contents in the root folder of your project:

```
{
  "extends": "@bizdotcom/eslint-config-bdc"
}
```

## Use:

There are many ways you can run eslint. Here are a few suggestions:

1. Run eslint in your code editor of choice via eslint extension.
	- [vscode eslint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
		- **(Recommended)** eslint can do more than just lint, especially the way we have it configured.
		To automate some of the fixable errors/warnings and the prettier code formatting
		we recommend that you enable this setting to make eslint run as soon as you hit
		save. Add this to your settings.json:
			```
			"editor.codeActionsOnSave": {
				"source.fixAll.eslint": true
			}
			```
	- [sublime eslint extension](https://github.com/SublimeLinter/SublimeLinter-eslint)
	- and many more can be [found here](https://eslint.org/docs/user-guide/integrations#editors)


2. An NPM script in your package.json: `"lint": "eslint --ext .js,.jsx ./src"`
	- optionally you could also add a script which runs the fix command for you: `"lint-fix": "yarn run lint --fix"`
	- you could have these script run on commit-hooks with help from tools like [husky](https://github.com/typicode/husky)
	or watch your files and run on save via build tools like webpack, gulp, or eslint-watch etc.

3. Like we said, these are just our suggested methods, we know there are others, you're welcome to use whichever method
works best for you!

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