# eslint-plugin-pluginjscodecommentcheck

> js代码注释检测工具

Latest version **0.0.4** (published 2023-07-24) · ISC license · 0 weekly downloads

## Install

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

## 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.4 |
| Published | 2023-07-24 |
| First published | 2022-07-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 10.x \|\| 12.x \|\| 14.x \|\| >= 16 |
| Dependencies | 1 |
| Unpacked size | 24.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | liulichao |
| Maintainers | liulichao |
| Keywords | eslint, eslintplugin, eslint-plugin |

## Links

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

## Dependencies (1)

- [requireindex](https://npm.io/package/requireindex.md) ^1.2.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
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2023-07-24
- 0.0.2 — 2022-07-12
- 0.0.1 — 2022-07-01
- 0.0.0 — 2022-07-01

## README

# eslint-plugin-pluginjscodecommentcheck

js代码注释检测工具(ts兼容)

## Installation

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

```sh
npm i eslint --save-dev
```

Next, install `eslint-plugin-pluginjscodecommentcheck`:

```sh
npm install eslint-plugin-pluginjscodecommentcheck --save-dev
```

## Usage

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

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


Then configure the rules you want to use under the rules section.

```json
{
    "rules": {
        "pluginjscodecommentcheck/rule-name": 2
    }
}
```

## Supported Rules

* rulejscodecommentcheck
* class-declaration
* export-declaration
* function-declaration
* tsenum-declaration
* tsinterface-declaration



## 注意
默认针对js文件生效，如需其他文件，需要在.vscode下的settings.json文件里面增加如下配置：
{
    "eslint.validate": [
      "javascript",
      "javascriptreact",
      "typescriptreact",
      "typescript"
    ]
  }

如需对ts兼容需要对项目安装@typescript-eslint/parser，(项目根目录执行：npm add @typescript-eslint/parser)
并在.eslintrc.js文件中添加配置："parser": "@typescript-eslint/parser"

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