# @commitlint/config-nx-scopes 中文文档

规范地址：https://npmcn.com/package/%40commitlint/config-nx-scopes/

版本：21\.2\.3
npm 元数据更新时间：2026-09-19T16:51:10.875Z
中文译文更新时间：2026-11-10T12:14:30.756Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40commitlint/config-nx-scopes
原文对照：https://npmcn.com/package/%40commitlint/config-nx-scopes/?lang=original
项目主页：https://commitlint.js.org/
源码仓库：https://github.com/conventional-changelog/commitlint

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：8.9 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.12\.0
- 运行依赖：1 个
- peer 依赖：nx \>=14\.0\.0
- 首次发布：2022-01-25T04:19:35.129Z
- 最新版本发布：2026-09-19T16:51:10.698Z
- 近 30 天下载量：279666（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：43（近 12 个月 12 个）

## 中文简介

可共享的 vontlint 配置执行 nx 项目名称作为范围

## 安装

```sh
npm install @commitlint/config-nx-scopes
```

也可以使用：`pnpm add @commitlint/config-nx-scopes`、`yarn add @commitlint/config-nx-scopes`、`bun add @commitlint/config-nx-scopes`

## README

# @ commitlint/ config-nx- specons

启动您的 nx 工程

可分享 `commitlint` 配置执行 nx 项目和工作空间名称为范围 . 使用方式 [@ commitlint/ cli (中文(简体) )](https://npmcn.com/package/%40commitlint/cli) 财务报告和审定财务报表 [@ commitlint/ prompt- cli (中文(简体) )](https://npmcn.com/package/%40commitlint/prompt-cli)。 。 。 .

范围从 nx 项目图读取, 因此一个 nx 插件贡献的项目是 有效范围,即使没有 `project.json` 或者说 `package.json` 属于自己的.

## 开始

```
npm install --save-dev @commitlint/config-nx-scopes @commitlint/cli
echo "module.exports = {extends: ['@commitlint/config-nx-scopes']};" > commitlint.config.js
```

## 过滤工程

您可以通过提供过滤函数作为第二个参数来过滤工程 `getProjects()`。该函数将使用包含每个工程的对象来调用 `name`, (中文(简体) ), `projectType`,以及 `tags`简单返回布尔以表示项目是否应列入.

举例来说,以下代码演示了如何只选择不是端到端测试的应用程序.

在您的 . committlint.js 文件中 :

```javascript
async function getConfig() {
  const {
    default: {
      utils: { getProjects },
    },
  } = await import("@commitlint/config-nx-scopes");

  return {
    rules: {
      "scope-enum": async (ctx) => [
        2,
        "always",
        [
          ...(await getProjects(
            ctx,
            ({ name, projectType }) => !name.includes("e2e") && projectType == "application",
          )),
        ],
      ],
    },
    // . . .
  };
}

module.exports = getConfig();
```

以下是另一个例子,其中标有“阶段:报废”的项目不得用作承诺的范围.

在您的 . committlint.js 文件中 :

```javascript
async function getConfig() {
  const {
    default: {
      utils: { getProjects },
    },
  } = await import("@commitlint/config-nx-scopes");

  return {
    rules: {
      "scope-enum": async (ctx) => [
        2,
        "always",
        [...(await getProjects(ctx, ({ tags }) => !tags.includes("stage:end-of-life")))],
      ],
    },
    // . . .
  };
}

module.exports = getConfig();
```

## 实例

```
❯ cat commitlint.config.js
{
  extends: ['@commitlint/config-nx-scopes']
}

❯ tree packages

packages
├── api
├── app
└── web

❯ echo "build(api): change something in api's build" | commitlint

❯ echo "test(foo): this won't pass" | commitlint
⧗   --- input ---
test(foo): this won't pass
✖   scope must be one of [api, app, web] [scope-enum]
✖   found 1 problems, 0 warnings

❯ echo "ci: do some general maintenance" | commitlint
```

咨询 [规则参考](https://commitlint.js.org/reference/rules) 用于列出现有规则.

## 常见问题

### @commitlint/config-nx-scopes 是什么？

可共享的 vontlint 配置执行 nx 项目名称作为范围

### 如何安装 @commitlint/config-nx-scopes？

在项目目录运行 npm install @commitlint/config-nx-scopes，或使用 pnpm add / yarn add / bun add。

### @commitlint/config-nx-scopes 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/commitlint\_\_config-nx-scopes 是否存在。

### @commitlint/config-nx-scopes 支持 ESM 还是 CommonJS？

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

### @commitlint/config-nx-scopes 需要什么版本的 Node\.js？

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

### @commitlint/config-nx-scopes 可以商用吗？

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

### @commitlint/config-nx-scopes 的下载量有多少？

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

### @commitlint/config-nx-scopes 还在维护吗？

最新版本 21\.2\.3 发布于 2026/09/20（1 个月前）；至今共发布 43 个版本，其中过去 12 个月发布了 12 个；首次发布于 2022/01/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。