# eslint-plugin-superstition

> ESLint superstition rules (forbid using numbers 13, 666 and etc.)

Latest version **0.3.1** (published 2020-01-02) · MIT license · 0 weekly downloads

## Install

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

## 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.3.1 |
| Published | 2020-01-02 |
| First published | 2019-12-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 3 |
| Unpacked size | 8.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pavel Gurov |
| Maintainers | gurov |
| Keywords | eslint, plugin, eslint-plugin, eslintplugin, superstition |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-superstition
- Repository: https://github.com/gurov/eslint-plugin-superstition
- Homepage: https://github.com/gurov/eslint-plugin-superstition#readme
- Issues: https://github.com/gurov/eslint-plugin-superstition/issues
- npm.io page: https://npm.io/package/eslint-plugin-superstition

## Dependencies (3)

- [req-all](https://npm.io/package/req-all.md) ^0.1.0
- [eslint-ast-utils](https://npm.io/package/eslint-ast-utils.md) ^1.0.0
- [create-eslint-index](https://npm.io/package/create-eslint-index.md) ^1.0.0

## Recent versions

- 0.3.1 (latest) — 2020-01-02
- 0.3.0 — 2020-01-02
- 0.2.0 — 2019-12-30
- 0.1.0 — 2019-12-30

## README

# eslint-plugin-superstition

ESLint superstition rules (forbid using numbers 13, 666 and etc.)

## Install

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

## Usage

Configure it in `package.json`.

<!-- EXAMPLE_CONFIGURATION:START -->
```json
{
  "name": "my-awesome-project",
  "eslintConfig": {
    "env": {
      "es6": true
    },
    "plugins": [
      "superstition"
    ],
    "rules": {
      "superstition/must-have-8": "error",
      "superstition/no-number-13": "error",
      "superstition/no-number-39": "error",
      "superstition/no-number-4": "error",
      "superstition/no-number-666": "error",
      "no-var": "error"
    }
  }
}
```
<!-- EXAMPLE_CONFIGURATION:END -->


## Rules

<!-- RULES:START -->
- [must-have-8](docs/rules/must-have-8.md) - Must have to use of the number `8`. It brings good luck.
- [no-number-13](docs/rules/no-number-13.md) - Forbid the use of number `13`. It is a bad omen.
- [no-number-39](docs/rules/no-number-39.md) - Forbid the use of number `39`. It is a bad omen.
- [no-number-4](docs/rules/no-number-4.md) - Forbid the use of number `4`. It is a bad omen.
- [no-number-666](docs/rules/no-number-666.md) - Forbid the use of number `666`. It is a bad omen.

<!-- RULES:END -->

## Recommended configuration

This plugin exports a [`recommended` configuration](index.js) that enforces good practices.

To enable this configuration, use the `extends` property in your `package.json`.

```json
{
  "name": "my-awesome-project",
  "eslintConfig": {
    "plugins": [
      "superstition"
    ],
    "extends": "plugin:superstition/recommended"
  }
}
```

See [ESLint documentation](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) for more information about extending configuration files.

## Notes

Based on [eslint-plugin-fp](https://github.com/jfmengels/eslint-plugin-fp)

----

MIT © [Pavel Gurov](https://github.com/pgurov)

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