# eslint-plugin-hz

> custom eslint rules for Hzbank

Latest version **1.0.0** (published 2022-10-18) · MIT license · 0 weekly downloads

## Install

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

## 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 | 1.0.0 |
| Published | 2022-10-18 |
| First published | 2022-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | wxqcto |
| Keywords | eslint, eslintplugin, eslint-plugin |

## Links

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

## Dependencies (2)

- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [require-all](https://npm.io/package/require-all.md) ^3.0.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

- 1.0.0 (latest) — 2022-10-18

## README

# eslint-plugin-hz

## 安装

除了本包，你需要同时安装 [ESlint](https://eslint.org/)

```shell
$ npm install eslint-plugin-hz eslint --save-dev
```

## 使用

### 引入插件

```js
// .eslintrc.js
module.exports = {
  plugin: ["hz"],
  rules: {
    "hz/no-secret-info": "error"
  }
}
```

### 使用 presets

```js
// .eslintrc.js
module.exports = {
  // 包含通用规则
  // https://github.com/hzbank/f2e-spec/tree/main/packages/eslint-plugin-hz/src/configs/recommended.js
  extends: "plugin:hz/recommended"
}
```

## 支持的规则

- [`no-broad-semantic-versioning`](https://github.com/hzbank/f2e-spec/tree/main/packages/eslint-plugin-hz/docs/rules/no-broad-semantic-versioning.md) 不要指定宽泛的版本范围
- [`no-http-url`](https://github.com/hzbank/f2e-spec/tree/main/packages/eslint-plugin-hz/docs/rules/no-http-url.md) 使用 HTTPS 协议头的 URL，而不是 HTTP
- [`no-js-in-ts-project`](https://github.com/hzbank/f2e-spec/tree/main/packages/eslint-plugin-hz/docs/rules/no-js-in-ts-project.md) 不要在 TS 项目中使用 JS
- [`no-secret-info`](https://github.com/hzbank/f2e-spec/tree/main/packages/eslint-plugin-hz/docs/rules/no-secret-info.md) 不要在代码中直接设置 `password` `token` and `secret` 信息

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