eslint-plugin-neverthrow


Installation

Use npm or a compatibility tool to install.

``bash
npm install --save-dev eslint eslint-plugin-neverthrow @typescript-eslint/parser
`

$3

- Node.js v8.10.0 or newer versions.
- ESLint v5.16.0 or newer versions.
- @typescript-eslint/parser

Usage

Write your config file such as .eslintrc.js.

`js
module.exports = {
plugins: ['neverthrow'],
rules: {
'neverthrow/must-use-result': 'error',
},
parser: '@typescript-eslint/parser',
parserOptions: {
ecmaVersion: 2021,
sourceType: 'module',
project: ['./tsconfig.json'],
tsconfigRootDir: __dirname,
},
};
`

See also Configuring ESLint.

Configs

- neverthrow/recommended ... enables the recommended rules.

Rules

$3

| Rule ID | Description | |
| :------------------------------------------------------------ | :----------------------------------------------------------------------------------------- | :-: |
| neverthrow/must-use-result | Not handling neverthrow result is a possible error because errors could remain unhandleds. | ⭐️ |

Semantic Versioning Policy

This plugin follows Semantic Versioning and ESLint's Semantic Versioning Policy.

Changelog

- GitHub Releases

Contributing

Welcome your contribution!

See also ESLint Contribution Guide.

$3

- npm test runs tests.
- npm run update updates the package version. And it updates src/configs/recommended.ts, lib/index.ts, and README.md's rule table. See also npm version CLI command.
- npm run add-rule ` creates three files to add a new rule.

forked from mysticatea/template-eslint-plugin