# @codacy/tools-spectral-1 中文文档

规范地址：https://npmcn.com/package/%40codacy/tools-spectral-1/

版本：0\.28\.0
npm 元数据更新时间：2026-11-09T13:47:00.436Z
中文译文更新时间：2026-11-10T05:39:30.073Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40codacy/tools-spectral-1
原文对照：https://npmcn.com/package/%40codacy/tools-spectral-1/?lang=original
项目主页：https://github.com/codacy/analysis-cli
源码仓库：https://github.com/codacy/analysis-cli

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

- 包体积（解压后）：126 kB，9 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：1 个
- 首次发布：2026-03-24T13:16:04.488Z
- 最新版本发布：2026-11-09T13:47:00.256Z
- 近 30 天下载量：11915（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：36（近 12 个月 36 个）

## 中文简介

光谱适配器 — Library-mode OpenAPI/ AsyncAPI linter

## 安装

```sh
npm install @codacy/tools-spectral-1
```

也可以使用：`pnpm add @codacy/tools-spectral-1`、`yarn add @codacy/tools-spectral-1`、`bun add @codacy/tools-spectral-1`

## README

# @codacy/tools-光谱-1

## 目录

-   [概览](https://npmcn.com/package/%40codacy/tools-spectral-1/#readme-overview)
-   [更新图案](https://npmcn.com/package/%40codacy/tools-spectral-1/#readme-updating-patterns)
-   [更新光谱版本](https://npmcn.com/package/%40codacy/tools-spectral-1/#readme-updating-the-spectral-version)
-   [发展](https://npmcn.com/package/%40codacy/tools-spectral-1/#readme-development)
-   [维护者的注释](https://npmcn.com/package/%40codacy/tools-spectral-1/#readme-notes-for-maintainers)

* * *

## 概览

使用 OpenAPI 和 AsyncAPI 接口 [光谱](https://stoplight.io/open-source/spectral)使用图书馆执行战略——称为 `@stoplight/spectral-core` API直接而不是产入子进程.

| 财产 | 数值 |
| --- | --- |
| 工具标识 | `spectral` |
| 编码 UUID | `fb60ff64-3d91-11ec-9bbc-0242ac130002` |
| 战略 | 图书馆 |
| 语文 | 贾森, 耶门 |
| 依赖性 | `@stoplight/spectral-core` (v1.x) (中文(简体) ) |
| 文件图案 | `**/*.yaml`, (中文(简体) ), `**/*.yml`, (中文(简体) ), `**/*.json` |

## 更新图案

```bash
# Re-fetch pattern metadata from the Codacy API
pnpm prefetch

# Commit the result
git add src/patterns.json
```

模式 ID 遵循格式 `spectral_operation-operationId`, (中文(简体) ), `spectral_info-contact`等 (中文(简体) ).

## 更新光谱版本

1.  更新 `@stoplight/spectral-core` 和相关软件包 `devDependencies` 联 合 国 `package.json`,以及 `preferredVersion` 内 `src/metadata.ts` (音轨) `@stoplight/spectral-core`(中文(简体) )
2.  运行 `pnpm install`
3.  运行 `pnpm generate-payloads spectral-1` 从重播根到重播 `payload/package.json` 并重生其锁文件
4.  运行 `pnpm prefetch` 以检查新的/撤消的规则
5.  运行 `pnpm test` 以验证兼容性
6.  如果主要版本更改,请创建新的适配软件包(`spectral-2/`(中文(简体) )

## 发展

```bash
pnpm build    # Build with tsup
pnpm test     # Run tests
```

## 维护者的注释

-   光谱诊断 **基于 0** 行和列编号。 适配器在两者中都增加了1个来制作基于1的Codacy Issues.
-   适配器一次处理一个文件,每个文件创建一个新的Spectral实例. 这样可以避免文件之间的状态渗出.
-   并非所有的YAML/JSON文件都是API specs. 非 spec 文件可能会从 Spectral 中产生解析错误——适配器将这些错误捕获为警告并持续.
-   适配器通过检查顶级来检测 AsyncAPI 规格 `asyncapi` 文件内容中的密钥,并使用 `asyncapi` 规则从 `@stoplight/spectral-rulesets`。所有其他文件使用 OAS (OpenAPI) 规则.
-   `checkAvailability` 动态进口 `@stoplight/spectral-core` 并创造了一个实例.
-   工具为 npm _有效载数_,而不是依赖性:在运行时解决(Codacy管理安装) `~/.codacy/tools/<id>/`页:1 `CODACY_TOOL_ROOT_<ID>` root, 或此软件包本身 `node_modules` (在单体)和 `install` 运行 `npm ci` 对所犯 `payload/package-lock.json`。见 `src/payload.ts`。 。 。 .

## 常见问题

### @codacy/tools-spectral-1 是什么？

光谱适配器 — Library-mode OpenAPI/ AsyncAPI linter

### 如何安装 @codacy/tools-spectral-1？

在项目目录运行 npm install @codacy/tools-spectral-1，或使用 pnpm add / yarn add / bun add。

### @codacy/tools-spectral-1 支持 TypeScript 吗？

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

### @codacy/tools-spectral-1 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @codacy/tools-spectral-1 需要什么版本的 Node\.js？

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

### @codacy/tools-spectral-1 可以商用吗？

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

### @codacy/tools-spectral-1 的下载量有多少？

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

### @codacy/tools-spectral-1 还在维护吗？

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