# @webscopeio/eslint-config

> ESLint config package according to the Webscope guidelines.

Latest version **2.0.1** (published 2022-09-14) · ISC license · 0 weekly downloads

## Install

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

## 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 | 2.0.1 |
| Published | 2022-09-14 |
| First published | 2018-01-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Webscope.io |
| Maintainers | vorcak, jukben, olovorr, alienalien13, jankoritak, jozef.hruska |

## Links

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

## Recent versions

- 2.0.1 (latest) — 2022-09-14
- 2.0.0 — 2022-09-02
- 1.0.5 — 2019-04-17
- 1.0.4 — 2019-04-16
- 1.0.3 — 2018-07-12
- 1.0.2 — 2018-03-20
- 1.0.1 — 2018-01-22
- 1.0.0 — 2018-01-22

## README

# eslint-config
ESLint config package according to Webscope guidelines.
### The idea
Webscope's ESLint plugin is based on Prettier.
The result set of rules is then further extended by Webscope's custom rules.
You can find all the info you need in `index.js`.

### How to use on a Webscope project

1. Install the package: `npm install @webscopeio/eslint-config --save-dev`
2. Use the config in your `.eslintrc` file:

```
extends: [
  '@webscopeio/eslint-config',
  ...
],
```

Configs do not ship dependencies. You'll have to install all the necessary dev dependencies on the level of your project. You can do it all at once by running this command:

`npm install eslint-plugin-import eslint-plugin-jest eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks --save-dev`

The dependencies are:

- eslint-plugin-import
- eslint-plugin-jest
- eslint-plugin-jsx-a11y
- eslint-plugin-react
- eslint-plugin-react-hooks
If the linter is failing with this type of error `Definition for rule RULE_NAME was not found ..`, then your associated plugin does not contain RULE_NAME. To resolve this, try bumping the plugin version.
### How to publish new version to NPM
For Webscope employees.
1. Create a PR with changes you want to publish.
2. Run `npm whoami`. The command should return your NPM name. If it does not then it is either because you are not logged in (in this case run `npm login`), or because you are not registered (create new NPM account by `npm adduser` or via NPM website).
3. Make sure that one of the code-owners (listed in `.github/CODEOWNERS.md`) added your NPM account to the Webscope organization.
4. Run `npm version <update_type>`. E.g. `npm run minor`. Reach out to the code-owners if you're not sure about the version update.
5. Finally, run `npm publish`.
6. :tada: If you are in Webscope organization & logged in, you just successfully published new version! :tada:

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