# @ankhorage/rules 中文文档

规范地址：https://npmcn.com/package/%40ankhorage/rules/

版本：0\.5\.1
npm 元数据更新时间：2026-11-05T12:16:35.101Z
中文译文更新时间：2026-11-06T05:08:49.103Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40ankhorage/rules
原文对照：https://npmcn.com/package/%40ankhorage/rules/?lang=original
项目主页：https://github.com/ankhorage/rules#readme
源码仓库：https://github.com/ankhorage/rules

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

- 包体积（解压后）：204 kB，108 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2026-10-01T09:07:47.739Z
- 最新版本发布：2026-11-05T12:16:34.688Z
- 近 30 天下载量：108648（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

Ankhorage的域-不可知规则引擎和JSON配置.

## 安装

```sh
npm install @ankhorage/rules
```

也可以使用：`pnpm add @ankhorage/rules`、`yarn add @ankhorage/rules`、`bun add @ankhorage/rules`

## README

# @ankhorage/ 规则

![license: MIT](https://npmcn.com/package/%40ankhorage/rules/paradox/badges/license.svg) ![npm: v0.5.1](https://npmcn.com/package/%40ankhorage/rules/paradox/badges/npm.svg) ![runtime: bun](https://npmcn.com/package/%40ankhorage/rules/paradox/badges/runtime.svg) ![typescript: strict](https://npmcn.com/package/%40ankhorage/rules/paradox/badges/typescript.svg) ![eslint: checked](https://npmcn.com/package/%40ankhorage/rules/paradox/badges/eslint.svg) ![prettier: checked](https://npmcn.com/package/%40ankhorage/rules/paradox/badges/prettier.svg) ![build: checked](https://npmcn.com/package/%40ankhorage/rules/paradox/badges/build.svg) ![tests: checked](https://npmcn.com/package/%40ankhorage/rules/paradox/badges/tests.svg) ![paradox: canonical](https://npmcn.com/package/%40ankhorage/rules/paradox/badges/docs.svg)

Ankhorage的域-不可知规则引擎和JSON配置.

## 使用量

### 国 际

Ankhorage 包通过命令行界面曝光 `ankh`启用 `ankh --help` 来发现可用的软件包命令,或用 `--help` 用于特定软件包.

```zsh
# Install the Ankhorage CLI
bun add --global @ankhorage/ankh

# Show usage information for rules
ankh rules --help
```

### 验证规则配置

通过公共通用规则API验证一个寄存器规则.json文件.

```ts
import { readRulesConfigAsync } from '@ankhorage/rules';
```

## 生成的文件

-   [交互式文件应用](https://npmcn.com/package/%40ankhorage/rules/paradox/index.html)
-   [公共 API 参考](https://npmcn.com/package/%40ankhorage/rules/paradox/exports.md)
-   [构成部分登记册](https://npmcn.com/package/%40ankhorage/rules/paradox/components.md)
-   [结构概览](https://npmcn.com/package/%40ankhorage/rules/paradox/diagrams/architecture-overview.mmd)
-   [模块关系](https://npmcn.com/package/%40ankhorage/rules/paradox/diagrams/module-relationships.mmd)
-   [导出图](https://npmcn.com/package/%40ankhorage/rules/paradox/diagrams/export-graph.mmd)
-   [akhorage 规则序列](https://npmcn.com/package/%40ankhorage/rules/paradox/diagrams/sequences/ankhorage-rules.mmd)
-   [创建规则登记序列](https://npmcn.com/package/%40ankhorage/rules/paradox/diagrams/sequences/create-rule-registry.mmd)
-   [验证规则配置序列](https://npmcn.com/package/%40ankhorage/rules/paradox/diagrams/sequences/validate-rules-config.mmd)

## 常见问题

### @ankhorage/rules 是什么？

Ankhorage的域-不可知规则引擎和JSON配置\.

### 如何安装 @ankhorage/rules？

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

### @ankhorage/rules 支持 TypeScript 吗？

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

### @ankhorage/rules 支持 ESM 还是 CommonJS？

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

### @ankhorage/rules 可以商用吗？

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

### @ankhorage/rules 的下载量有多少？

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

### @ankhorage/rules 还在维护吗？

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