@bufferings/eslint-plugin-neverthrow

中文文档
0.3.0发布于 2025/12/07MITTypeScriptES Module构建来源已验证近 30 天下载 7.8万

npm version [Downloads/month](http:/

原始使用文档
文档目录10 节
  1. Notice
  2. Installation
  3. Requirements
  4. Usage
  5. Rules
  6. Possible Errors
  7. Semantic Versioning Policy
  8. Changelog
  9. Contributing
  10. Development Tools

eslint-plugin-neverthrow

npm version Downloads/month

Notice

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

Installation

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

Requirements

  • 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.

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

Possible Errors

Rule IDDescription
neverthrow/must-use-resultNot 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

Contributing

Welcome your contribution!

See also Contribute to ESLint.

Development Tools

  • pnpm test runs tests.

版本与发布记录

@bufferings/eslint-plugin-neverthrow 共发布 15 个版本,首次发布于 2024/12/01;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.3.0latest2025/12/0711 个月前
0.3.0-beta.2beta2025/12/0611 个月前
0.3.0-beta.12025/12/0611 个月前
0.3.0-beta.02025/12/0611 个月前
0.2.122024/12/141.9 年前
0.2.112024/12/141.9 年前

关于 @bufferings/eslint-plugin-neverthrow 的常见问题

@bufferings/eslint-plugin-neverthrow 是什么?

[](http:/

如何安装 @bufferings/eslint-plugin-neverthrow?

在项目目录运行 npm install @bufferings/eslint-plugin-neverthrow,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@typescript-eslint/parser(>=8.48.0)、eslint(>=9.0.0)、typescript(>=5.6.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@bufferings/eslint-plugin-neverthrow 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@bufferings/eslint-plugin-neverthrow 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@bufferings/eslint-plugin-neverthrow 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@bufferings/eslint-plugin-neverthrow 可以商用吗?

@bufferings/eslint-plugin-neverthrow 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@bufferings/eslint-plugin-neverthrow 的下载量有多少?

根据 npm 官方下载统计,@bufferings/eslint-plugin-neverthrow 在 2026/10/09 – 2026/11/07 这 30 天内被下载 77,832 次,日均约 2,594 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@bufferings/eslint-plugin-neverthrow 还在维护吗?

最新版本 0.3.0 发布于 2025/12/07(11 个月前);至今共发布 15 个版本,其中过去 12 个月发布了 4 个;首次发布于 2024/12/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。