# @ankhorage/project-detector 中文文档

规范地址：https://npmcn.com/package/%40ankhorage/project-detector/

版本：0\.3\.5
npm 元数据更新时间：2026-10-10T22:01:29.032Z
中文译文更新时间：2026-11-06T05:08:46.139Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：157 kB，101 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：5 个
- peer 依赖：@ankhorage/ankh ^0\.12\.0
- 首次发布：2026-09-14T00:13:50.699Z
- 最新版本发布：2026-10-10T22:01:28.695Z
- 近 30 天下载量：209948（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

广泛开展以证据为基础的项目检测,对独立工具进行安全档案系统检查.

## 安装

```sh
npm install @ankhorage/project-detector
```

也可以使用：`pnpm add @ankhorage/project-detector`、`yarn add @ankhorage/project-detector`、`bun add @ankhorage/project-detector`

## README

# @ankhorage/项目检测器

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

广泛开展以证据为基础的项目检测和安全档案系统检查.

## 生成的文件

-   [交互式文件应用](https://npmcn.com/package/%40ankhorage/project-detector/paradox/index.html)
-   [公共 API 参考](https://npmcn.com/package/%40ankhorage/project-detector/paradox/exports.md)
-   [构成部分登记册](https://npmcn.com/package/%40ankhorage/project-detector/paradox/components.md)
-   [结构概览](https://npmcn.com/package/%40ankhorage/project-detector/paradox/diagrams/architecture-overview.mmd)
-   [模块关系](https://npmcn.com/package/%40ankhorage/project-detector/paradox/diagrams/module-relationships.mmd)
-   [导出图](https://npmcn.com/package/%40ankhorage/project-detector/paradox/diagrams/export-graph.mmd)
-   [检测项目序列](https://npmcn.com/package/%40ankhorage/project-detector/paradox/diagrams/sequences/detect-project.mmd)
-   [项目探测器序列](https://npmcn.com/package/%40ankhorage/project-detector/paradox/diagrams/sequences/project-detector.mmd)

## 公共 API

### 公用事业

检测项目

```ts
detectProject(input: ProjectDetectionInput, options?: ProjectDetectionOptions) => ProjectDetection
```

检测重叠的项目语言、框架、运行时间和软件包管理证据.

纯API接受包元数据外加可选的相对POSIX文件路径和显示文本. JavaScript,TypeScript,Java,克特林,C++,Python和Delphi证据是添加剂,从不独有. 通用 Make/CMake/Gradle 文件识别构建工具,并不一定是源语言. 分数是热力学的长处,而不是信心概率. 没有源解析器,登记请求, 依赖性更新,迁移,文件系统操作或被检查的项目脚本在此运行. 以明确提供的可信任的检测器调用来扩展检测;ID必须是独一无二的. 公共类型为此软件包所有,并通过 `@ankhorage/project-detector/types`。 。 。 .

模块 : `src/features/detection/application/detectProject.ts` 资料来源: `src/features/detection/application/detectProject.ts:24:1` 相关符号 : `ProjectDetection`, (中文(简体) ), `ProjectDetectionInput`, (中文(简体) ), `ProjectDetectionOptions`

检查项目

```ts
inspectProjectAsync(path: string, options?: ProjectInspectionOptions) => Promise<ProjectInspection>
```

使用有边框,同步,只读的文件系统访问检查目录.

从 `@ankhorage/project-detector/node`。默认值:深度16,20,000个条目, 256 KiB 每张清单和8个 MiB 总清单文本。 依赖/建设/缓存目录, 包括生成 `.ankh`。 。 。 。 。 排除之外的联系被跳过 以有路的警告盟誓,他们不单做不完全的扫描。 他们的目标 从来没有被故意扫描。 通过中止符号取消 . 为新的生态系统配置额外的显示基名和检测器召回. 软件包/工作空间成员目前解决了JavaScript软件包.json工作空间和pnpm YAML; 其他生态系统表被确定,没有完全解为依赖图. 没有检查 JavaScript, Gradle, Python, 可执行配置或安装脚本被执行 . 检查是一个最佳的快照,而不是一个沙盒,用来对抗同时进行敌对的文件系统编辑. 已返回 `directories` 财务报告和审定财务报表 `files` 是从已扫描的相对 POSIX 路径排序的. 目录目录包含空目录并省略检查根本身. 结果报告不完整;它从未允许进行更新. 在完整的扫描输出上进行排序; 当预算用完时, 保留子集取决于 文件系统计数顺序。 检查可复制结果的稳定出票. 安装方式 `npm install @ankhorage/project-detector`;独立命令是 `npx --package @ankhorage/project-detector project-detector inspect .`。 。 。 . 安装了 Ankh, 使用 `ankh project-detector inspect .`。 。 。 . CLI出站代码为0表示完整扫描,1表示引用/根出错,2表示部分扫描. 发布自动化需要组织发布 App 配置和 npm 发布 此新软件包的授权; 仅寄存器文件不能提供这些证书.

模块 : `src/features/inspection/composition/inspectProjectAsync.ts` 资料来源: `src/features/inspection/composition/inspectProjectAsync.ts:31:1` 相关符号 : `ProjectInspection`, (中文(简体) ), `ProjectInspectionOptions`

## 常见问题

### @ankhorage/project-detector 是什么？

广泛开展以证据为基础的项目检测,对独立工具进行安全档案系统检查\.

### 如何安装 @ankhorage/project-detector？

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

### @ankhorage/project-detector 支持 TypeScript 吗？

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

### @ankhorage/project-detector 支持 ESM 还是 CommonJS？

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

### @ankhorage/project-detector 需要什么版本的 Node\.js？

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

### @ankhorage/project-detector 可以商用吗？

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

### @ankhorage/project-detector 的下载量有多少？

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

### @ankhorage/project-detector 还在维护吗？

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