# eslint-plugin-numeric-separators

> ESLint rule to make long numbers more readable

Latest version **0.0.3** (published 2020-11-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-numeric-separators
pnpm add eslint-plugin-numeric-separators
yarn add eslint-plugin-numeric-separators
bun add eslint-plugin-numeric-separators
```

## 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.3 |
| Published | 2020-11-09 |
| First published | 2020-11-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Chin-An Wu |
| Maintainers | chinanwu |
| Keywords | eslint, eslint-plugin, eslintplugin, numeric-separators, numericseparators |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-numeric-separators
- Repository: https://github.com/chinanwu/eslint-plugin-long-numbers
- Homepage: https://github.com/chinanwu/eslint-plugin-long-numbers#readme
- Issues: https://github.com/chinanwu/eslint-plugin-long-numbers/issues
- npm.io page: https://npm.io/package/eslint-plugin-numeric-separators

## 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.3 (latest) — 2020-11-09
- 0.0.2 — 2020-11-09

## README

# Use-numeric-separators (use-numeric-separators)

'Long numbers' are numbers that have a length longer than 3. 

## Installation
- Coming soon

## Rule Details

The `use-numeric-separators` rule aims to make code more readable by ensuring that long numbers uses "_".

Examples of **incorrect** code for this rule:

```js
/*eslint use-numeric-separators: "error"*/

const number = 1000;
```

Examples of **correct** code for this rule:

```js
/*eslint use-numeric-separators: "error"*/

const number = 1_000;
```

## TODOs
- Github Actions To Publish

## Resources I've Used
- [ESLint's official developer guide to making rules](https://eslint.org/docs/developer-guide/working-with-rules)
    - [ESLint's Rule Tester](https://eslint.org/docs/developer-guide/nodejs-api#ruletester)
- ["Ensure code quality; create your own ESLint rules"](https://blog.theodo.com/2020/04/create-your-own-eslint-rules/)
- ["How I built my first custom ESLint rule"](https://blog.maximeheckel.com/posts/how-to-build-first-eslint-rule)
- [AST Explorer](https://astexplorer.net/)
- Fantastic existing examples:
    - ESLint's `no-magic-numbers` rule
        - [Test](https://github.com/eslint/eslint/blob/master/tests/lib/rules/no-magic-numbers.js)
        - [Actual Code](https://github.com/eslint/eslint/blob/master/lib/rules/no-magic-numbers.js)
    - `eslint-plugin-jsx-a11y`'s `lang` rule
        - [Test](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/__tests__/src/rules/lang-test.js)
        - [Actual Code](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/src/rules/lang.js)

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