# @a16njs/models 中文文档

规范地址：https://npmcn.com/package/%40a16njs/models/

版本：1\.1\.1
npm 元数据更新时间：2026-08-20T20:58:30.126Z
中文译文更新时间：2026-11-07T07:15:26.973Z
软件包许可：AGPL-3\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40a16njs/models
原文对照：https://npmcn.com/package/%40a16njs/models/?lang=original
项目主页：https://texarkanine.github.io/a16n/models
源码仓库：https://github.com/Texarkanine/a16n

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

- 包体积（解压后）：84.5 kB，34 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：1 个
- 首次发布：2026-01-25T21:51:25.854Z
- 最新版本发布：2026-08-20T20:58:29.789Z
- 近 30 天下载量：2017（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

A16n 的定义和插件接口

## 安装

```sh
npm install @a16njs/models
```

也可以使用：`pnpm add @a16njs/models`、`yarn add @a16njs/models`、`bun add @a16njs/models`

## README

# @a16njs/ 型号

[![npm version](https://img.shields.io/npm/v/@a16njs/models.svg)](https://www.npmjs.com/package/@a16njs/models) [![codecov](https://codecov.io/gh/Texarkanine/a16n/graph/badge.svg?flag=models)](https://codecov.io/gh/Texarkanine/a16n)

A16n 的定义和插件接口类型 .

## 稳定

截止 `1.0.0`,导出类型和 `A16nPlugin` 界面是稳定的,并遵循语义化的版本:打破对公共API的修改来撞倒主要版本.

## 安装

```bash
npm install @a16njs/models
```

## 使用量

```typescript
import {
  CustomizationType,
  type A16nPlugin,
  type AgentCustomization,
  type GlobalPrompt,
  isGlobalPrompt,
  createId,
} from '@a16njs/models';
```

## 出口

### 类型

-   `CustomizationType` - 定制类型的数字(GlobalPrompt、SimpleAgentSkill、AgentSkillIO、文件规则、AgentIgnore、ManualPrompt)
-   `AgentCustomization` - 所有定制的基本接口
-   `GlobalPrompt` - 总是应用的提示
-   `SimpleAgentSkill` - 通过描述触发背景
-   `AgentSkillIO` - 具有资源/档案的复杂技能
-   `FileRule` - 按文件模式触发
-   `AgentIgnore` - 忽略图案
-   `ManualPrompt` - 用户提示的提示(例如, `/command`),存储于 `.cursor/skills/` 或者说 `.claude/skills/` 与 `disable-model-invocation: true`

### 插件接口

-   `A16nPlugin` - 插件必须执行的接口
-   `DiscoveryResult` - 发现定制产品的结果
-   `EmitResult` - 排放定制产品的结果
-   `WrittenFile` - 有关书面文件的信息

### 警告

-   `WarningCode` - 警告代码数字(Merged、近似、跳过、覆盖)
-   `Warning` - 警告结构

### 帮助者

-   `isGlobalPrompt(item)` - 全球Prompt的护卫类型
-   `isSimpleAgentSkill(item)` - 简易代理技能的型式警卫
-   `isAgentSkillIO(item)` - 特工SkillIO的防守类型
-   `isFileRule(item)` - 文件规则的护卫类型
-   `isAgentIgnore(item)` - 特工Ignore的防守类型
-   `isManualPrompt(item)` - 手动Prompt的护卫类型
-   `createId(type, sourcePath)` - 创建独特的ID

## 文档

备有文件全文 [https://texarkanine.github.io/a16n/ 模特儿](https://texarkanine.github.io/a16n/models)。 。 。 .

## 常见问题

### @a16njs/models 是什么？

A16n 的定义和插件接口

### 如何安装 @a16njs/models？

在项目目录运行 npm install @a16njs/models，或使用 pnpm add / yarn add / bun add。

### @a16njs/models 支持 TypeScript 吗？

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

### @a16njs/models 支持 ESM 还是 CommonJS？

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

### @a16njs/models 需要什么版本的 Node\.js？

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

### @a16njs/models 可以商用吗？

@a16njs/models 使用 AGPL-3\.0 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @a16njs/models 的下载量有多少？

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

### @a16njs/models 还在维护吗？

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