# @dbx-tools/path 中文文档

规范地址：https://npmcn.com/package/%40dbx-tools/path/

版本：0\.9\.206
npm 元数据更新时间：2026-11-10T19:19:48.110Z
中文译文更新时间：2026-11-11T17:27:17.424Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：183 kB，28 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2026-07-17T16:16:29.959Z
- 最新版本发布：2026-11-10T19:19:47.794Z
- 近 30 天下载量：10026（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：358（近 12 个月 358 个）

## 中文简介

用于发现、匹配、忽略、扫描和观看的节点文件系统路径工具包

## 安装

```sh
npm install @dbx-tools/path
```

也可以使用：`pnpm add @dbx-tools/path`、`yarn add @dbx-tools/path`、`bun add @dbx-tools/path`

## README

# @dbx-tools/路径

发现、匹配、忽略、扫描和监视同样规则的文件系统路径 由CLI、Projen、枪管生成、代码生成和文档使用 用于工具.

## 查找文件

```ts
import { find, ignore } from "@dbx-tools/path";

for await (const file of find.findFiles(["packages/**/src/**/*.ts"], {
  ignore: ignore.ignorePatterns(),
})) {
  await processFile(file);
}

const files = find.findFilesSync(["packages/**/src/**/*.ts"]).toArray();
```

`find.findFiles()` 溪流同步匹配 . `find.findFilesSync()` 返回懒惰 `Sequence<string>` 从 [@dbx-tools/ 共享核心](https://npmcn.com/package/shared/core),所以呼叫者可以不使用 立即实现.

软件包还提供了 glob 匹配器、 共享忽略规则、 工作空间软件包 扫描 和Chokidar制表助手.

使用此软件包而不是直接 `glob` 或者说 `chokidar` 在结果出现时打电话 应同意软件包的发现、桶的生成或清理逻辑.

## 编译匹配者

```ts
import { match } from "@dbx-tools/path";

const isTest = match.toPathMatcher("**/*.test.ts");
if (isTest("packages/shared/model/test/classify.test.ts")) {
  skip();
}
```

`match.toPathMatcher()` 返回可堆叠的共享核心上游。 使用 `match.pathMatchTests()` 当您需要检查所编译的包含/不包括 测试.

## 重用忽略规则

```ts
import { ignore } from "@dbx-tools/path";

const matcher = ignore.ignorePathMatcher({
  defaults: true,
  dot: true,
  test: false,
  lock: "auto",
});
```

被忽略的帮助者集中重放全局的排除,例如 `node_modules`, (中文(简体) ), 生成文件,构建输出,VCS元数据,以及包管理输出.

## 扫描工作空间包

```ts
import { scan } from "@dbx-tools/path";

const options: scan.FileScanOptions = {
  cwd: "packages",
  ignore: ["generated/**"],
  followSymlinks: scan.FOLLOW_SYMLINKS_DEFAULT,
};
```

`scan` 导出 projen 引擎使用的共享扫描选项类型 。 用同样的 选项 就像合成一样.

## 监视文件

```ts
import { watch } from "@dbx-tools/path";

const watcher = await watch.watchFiles(["packages/**/src/**/*.ts"], {
  ignoreInitial: true,
});

watcher.on("change", (file) => rebuild(file));
```

`watch.watchFiles()` 用同样的路径包裹chokidar,忽略期望 用于其他回波工具.

## 构建图案

```ts
import { pattern } from "@dbx-tools/path";

const nodeModulesPattern = pattern.directoryNamePattern("node_modules");
const tsPattern = pattern.fileExtensionPattern("ts");
```

模式帮助者使生成的光子碎片得以逃脱并保持一致.

## 模块

-   `find` - 被蒙蔽了的懒惰档案.
-   `match` - 闪闪发光的选手.
-   `ignore` - 标准忽略模式和匹配者构建.
-   `scan` - 包扫描选项类型和默认值.
-   `watch` - chokidar的档案包.
-   `pattern` - 逃脱的目录名称和扩展名光子碎片.

Projen 引擎在 [@dbx-tools/ projen (英语)](https://npmcn.com/projen)。 。 。 .

## 常见问题

### @dbx-tools/path 是什么？

用于发现、匹配、忽略、扫描和观看的节点文件系统路径工具包

### 如何安装 @dbx-tools/path？

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

### @dbx-tools/path 支持 TypeScript 吗？

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

### @dbx-tools/path 支持 ESM 还是 CommonJS？

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

### @dbx-tools/path 可以商用吗？

@dbx-tools/path 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dbx-tools/path 的下载量有多少？

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

### @dbx-tools/path 还在维护吗？

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