# eslint-plugin-kpmg

> A rule set for Eslint based on kdi standard

Latest version **0.0.17** (published 2021-06-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-kpmg
pnpm add eslint-plugin-kpmg
yarn add eslint-plugin-kpmg
bun add eslint-plugin-kpmg
```

## 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.17 |
| Published | 2021-06-10 |
| First published | 2021-05-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 1 |
| Unpacked size | 18.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | wl.huang@kpmg.com |
| Maintainers | hll7759 |
| Keywords | eslint, eslintplugin, eslint-plugin |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-kpmg
- npm.io page: https://npm.io/package/eslint-plugin-kpmg

## Dependencies (1)

- [requireindex](https://npm.io/package/requireindex.md) ~1.1.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.0.17 (latest) — 2021-06-10
- 0.0.16 — 2021-06-10
- 0.0.15 — 2021-06-03
- 0.0.14 — 2021-06-03
- 0.0.12 — 2021-06-01
- 0.0.11 — 2021-05-12
- 0.0.10 — 2021-05-12
- 0.0.9 — 2021-05-11
- 0.0.8 — 2021-05-11
- 0.0.7 — 2021-05-11
- 0.0.6 — 2021-05-11
- 0.0.5 — 2021-05-11
- 0.0.4 — 2021-05-11
- 0.0.3 — 2021-05-11
- 0.0.2 — 2021-05-11
- … 2 more at https://npm.io/package/eslint-plugin-kpmg/versions

## README

# eslint-plugin-kpmg

A rule set for Eslint based on KPMG standard.

## Installation

You'll first need to install [ESLint](http://eslint.org):

```
$ npm i eslint --save-dev
```

Next, install `eslint-plugin-kpmg`:

```
$ npm install eslint-plugin-kpmg --save-dev
```


## Usage

Add `kpmg` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json
{
    "plugins": [
        "kpmg"
    ]
}
```


or Just extend the recommand rule set,currently only support the vue rule set.

```json
     extends: ["some other plugins","plugin:kpmg/vue"],
```


Then configure the rules you want to use under the rules section,(when you are using extend  this would be optional).

```json
{
    "rules": {
            "kpmg/no-simple-naming": [1, 3],
            "kpmg/single-file-too-large": [1, 500],
            "kpmg/no-sensitive-variable": [1, "password"]

    }
}
```




## Supported Rules
| Rule | Description |
|:--|:--|
| [no-simple-naming](https://cnnkgapt12.cn.kworld.kpmg.com/whuang11/eslint-plugin-kpmg/blob/master/docs/rules/no-simple-naming.md) | do not use too simple names when define a variable name |
| [single-file-too-large](https://cnnkgapt12.cn.kworld.kpmg.com/whuang11/eslint-plugin-kpmg/blob/master/docs/rules/single-file-too-large.md) | code lines should not too large in a single file |
| [no-sensitive-variable](https://cnnkgapt12.cn.kworld.kpmg.com/whuang11/eslint-plugin-kpmg/blob/master/docs/rules/no-sensitive-variable.md) | do not use sensitive names in source code |


## License

MIT

## how to Contribute 

Please refer the [Eslint development guide](https://eslint.org/docs/developer-guide/architecture) and KPMG standard

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