# @conformetry/nx 中文文档

规范地址：https://npmcn.com/package/%40conformetry/nx/

版本：0\.0\.79
npm 元数据更新时间：2026-11-10T14:27:24.240Z
中文译文更新时间：2026-11-10T15:26:08.034Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40conformetry/nx
原文对照：https://npmcn.com/package/%40conformetry/nx/?lang=original
项目主页：https://github.com/organizzolini/codebase/tree/main/projects/ic-suite/conformetry/conformetry-nx#readme
源码仓库：https://github.com/organizzolini/codebase

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

- 包体积（解压后）：125 kB，18 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：10 个
- 首次发布：2026-10-04T22:26:55.349Z
- 最新版本发布：2026-11-10T14:27:23.637Z
- 近 30 天下载量：9443（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：77（近 12 个月 77 个）

## 中文简介

Nx 插件, 为 Conforometry 提供动态发电机脚手架和符合性验证目标

## 安装

```sh
npm install @conformetry/nx
```

也可以使用：`pnpm add @conformetry/nx`、`yarn add @conformetry/nx`、`bun add @conformetry/nx`

## README

# \* 调和 Nx

[![npm](https://img.shields.io/npm/v/@conformetry/nx?logo=npm&label=npm)](https://www.npmjs.com/package/@conformetry/nx)

Nx 主机为 [调和](https://github.com/Organizzolini/codebase/tree/main/projects/ic-suite/conformetry/conformetry-cli#readme)。 。 。 . 用于命令行为、配置、模板语法、评分和验证器的分类文档在 [@conformet/cli 读取](https://github.com/Organizzolini/codebase/tree/main/projects/ic-suite/conformetry/conformetry-cli#readme)。 。 。 . 此软件包添加了独立 CLI 无法提供的两件事: 以名称地址的生成器通过 `nx g`, (中文(简体) ), 和每个持有的工程的缓存验证目标 实例.

```bash
npm install --save-dev @conformetry/nx
```

## 设置

注册插件于 `nx.json` 把靴子绑上 `postinstall`数字 :

```json
{
  "plugins": [
    {
      "plugin": "@conformetry/nx",
      "options": {
        "configurationPath": "configuration/conformetry.config.ts",
        "validateTargetName": "conformetry-validate"
      }
    }
  ],
  "sync": { "globalGenerators": ["@conformetry/nx:sync"] }
}
```

```json
{ "scripts": { "postinstall": "conformetry-nx-bootstrap-generators" } }
```

这个 `configurationPath` 选项 **所需经费**: 不假设默认文件 没有搜索文件名 。 一个插件条目, 没有它失败, 带有一个 `ConfigurationPathRequiredError` 从 `@conformetry/configuration` 名称 选项,靴子也一样,它从 `nx.json`执行者 编辑 `sync` 生成器采用相同的路径 `configuration` 选项,哪个 两者均确定后胜过注册.

然后输入您的配置为 `ConformetryNxConfiguration` 而不是说 `ConformetryConfiguration`,因此对照 Nx 所能检查的示例组 实际解析 :

```ts
import { type ConformetryNxConfiguration } from "@conformetry/nx";
```

## 已发射的插件

工作区拥有的发电机是它的附属物 配置,所以显示它们的插件是 **排放而不是书面**。 。 。 . `conformetry-nx-bootstrap-generators` 从你的配置中得来, 写给 `.conformetry/nx-generators` (勾画出该目录——它是一个 将它连接到根部 `node_modules` 这样 `nx g conformetry:<generator>` 决定。 链接是插件的由来 可地址, 因为 Nx 通过要求以 名称而不是匹配一个 Nx 项目.

| 默认 | 数值 |
| --- | --- |
| 输出路径 | `.conformetry/nx-generators` |
| 软件包名称 | `conformetry` 所以发电机是 `nx g conformetry:<name>` |

当配置不能时,靴子会警告而不是退出非零 被读取,所以一个配置的中版从不屏蔽一个无关的安装. 漂流 相反,每个命令都比照 向配置发送插件并拒绝运行于 stale 一个.

`@conformetry/nx` 故意宣布除此之外没有其他发电机 `sync`。 。 。 . `nx g @conformetry/nx:anything` 设计解决不了任何问题——哪些发电机 存在是您的配置属性,而不是此软件包的属性.

`sync` 双向运行 : `nx sync` 财务报告和审定财务报表 `nx sync:check` 将其作为全局同步 发电机,以及 `nx g @conformetry/nx:sync` 直接运行,写入 已发射插件 .

## 正在生成

```bash
nx g conformetry:nestjs-service-module --name=billing --project=lexico
```

Nx 提示缺少来自生成器本身的计划的输入并写入 通过其虚拟 `Tree`这样 `--dry-run` 工作和工作空间 跑过结果.

## 验证

插件推断 a `conformetry-validate` 目标到每个项目持有量 实例,因此正在缓存验证并参与 `nx affected`数字 :

```bash
nx run <project>:conformetry-validate
nx run-many --target=conformetry-validate --all
nx affected --target=conformetry-validate --base=main
```

| 执行器选项 | 目的 |
| --- | --- |
| `configuration` | 配置文件, 工作空间根相干 。 从 `configurationPath` 插件选项在 `nx.json` 省略时; 需要两者之一 |
| `languages` | 将运行限制为已命名的验证符; 省略时全部运行 |

## 标记范围实例

Nx 主机读取一个实例组 `tags` 作为工程标记,并解决 组合的光彩 _内部_ 每一个匹配项目——因此,一个生成器属于何处 说明一次:

```ts
instances: [{ patterns: ["src/modules/*"], tags: ["framework:nestjs"] }];
```

项目必须携带 **每个** 标记组名,因此第二个标记缩小 进一步分组 `tags: ["framework:nestjs", "language:graphql"]` 仅达到 也属于GraphQL的NestJS项目.

这两类表格是分开的 `tags` 一个人 没有第二个字段 可能不同意它: 单独的范围 排除了项目 光荣 默默地进行缩小的验证,验证无法注意到实例 它从来没有提供.

选择 `patterns` 选择项目时不找到其中的任何内容, 这是还没有实例的模板想要的 `nx g` 仍然被限制 模板套装.

## 出口

`runConformetryGenerator` 用于发电机包装器, `bootstrapPlugin` 财务报告和审定财务报表 `runBootstrapCli` 用于靴子 `ConformetryNxConfiguration` 财务报告和审定财务报表 实例组类型,以及后面的 NestJS 服务(`PluginService`, (中文(简体) ), `AdapterService`, (中文(简体) ), `InstancesService`, (中文(简体) ), `ScopeService`, (中文(简体) ), `OptionsService`) (中文(简体) ).

## 测试

```bash
nx run conformetry-nx:vitest
```

## 许可证

麻省理工学院——见 [自由主义](https://npmcn.com/LICENSE)。 。 。 .

## \* 调和

这个项目源于 [巢-服务-项目](https://npmcn.com/configuration/conformetry-templates/nestjs-service-project) 符合模板.

## 常见问题

### @conformetry/nx 是什么？

Nx 插件, 为 Conforometry 提供动态发电机脚手架和符合性验证目标

### 如何安装 @conformetry/nx？

在项目目录运行 npm install @conformetry/nx，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 conformetry-nx-bootstrap-generators，可以用 npx conformetry-nx-bootstrap-generators 直接运行。

### @conformetry/nx 支持 TypeScript 吗？

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

### @conformetry/nx 支持 ESM 还是 CommonJS？

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

### @conformetry/nx 可以商用吗？

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

### @conformetry/nx 的下载量有多少？

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

### @conformetry/nx 还在维护吗？

最新版本 0\.0\.79 发布于 2026/11/10（今天）；至今共发布 77 个版本，其中过去 12 个月发布了 77 个；首次发布于 2026/10/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。