eslint-plugin-neverthrow


Notice

forked from mdbetancourt/eslint-plugin-neverthrow
to support flat config.

Installation

Use npm or a compatible tool to install.

``bash


npm

npm install --save-dev @bufferings/eslint-plugin-neverthrow

pnpm

pnpm install --save-dev @bufferings/eslint-plugin-neverthrow
`

$3

- Node.js v20.0.0 or newer versions.
- ESLint v9.0.0 or newer versions.

Usage

Write your config file such as eslint.config.js.

`js
import eslint from '@eslint/js';
import { defineConfig } from 'eslint/config';
import neverthrowPlugin from '@bufferings/eslint-plugin-neverthrow';
import tseslint from 'typescript-eslint';

export default defineConfig(
eslint.configs.recommended,
tseslint.configs.recommendedTypeChecked,
neverthrowPlugin.configs.recommended,
{
languageOptions: {
parserOptions: {
projectService: {
allowDefaultProject: ['.config.'],
},
tsconfigRootDir: import.meta.dirname,
},
},
}
);
`

See also Configure ESLint - ESLint.

Rules

$3

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

Semantic Versioning Policy

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

Changelog

- GitHub Releases

Contributing

Welcome your contribution!

See also Contribute to ESLint.

Development Tools

- pnpm test` runs tests.