forked from mdbetancourt/eslint-plugin-neverthrow to support flat config.
Use npm or a compatible tool to install.
# npm
npm install --save-dev @bufferings/eslint-plugin-neverthrow
# pnpm
pnpm install --save-dev @bufferings/eslint-plugin-neverthrow
- Node.js v18.0.0 or newer versions.
- ESLint v9.0.0 or newer versions.
Write your config file such as eslint.config.js
.
import eslint from '@eslint/js';
import tseslint from 'typescript-eslint';
import neverthrowPlugin from '@bufferings/eslint-plugin-neverthrow';
export default tseslint.config(
eslint.configs.recommended,
tseslint.configs.recommendedTypeChecked,
neverthrowPlugin.configs.recommended,
{
languageOptions: {
parserOptions: {
projectService: {
allowDefaultProject: ['*.config.*'],
},
tsconfigRootDir: import.meta.dirname,
},
},
}
);
See also Configure ESLint - ESLint.
Rule ID | Description | |
---|---|---|
neverthrow/must-use-result | Not handling neverthrow result is a possible error because errors could remain unhandled. | ⭐️ |
This plugin follows Semantic Versioning and ESLint's Semantic Versioning Policy.
Welcome your contribution!
See also Contribute to ESLint.
pnpm test
runs tests.