# @alint-js/tools-fs 中文文档

规范地址：https://npmcn.com/package/%40alint-js/tools-fs/

版本：0\.7\.3
npm 元数据更新时间：2026-09-28T17:22:27.825Z
中文译文更新时间：2026-11-05T19:49:46.928Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40alint-js/tools-fs
原文对照：https://npmcn.com/package/%40alint-js/tools-fs/?lang=original
源码仓库：https://github.com/moeru-ai/alint

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

- 包体积（解压后）：10 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-07-13T06:20:23.367Z
- 最新版本发布：2026-09-28T17:22:27.660Z
- 近 30 天下载量：93689（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 35 个）

## 中文简介

用于 alint 代理授权规则的文件系统探索工具

## 安装

```sh
npm install @alint-js/tools-fs
```

也可以使用：`pnpm add @alint-js/tools-fs`、`yarn add @alint-js/tools-fs`、`bun add @alint-js/tools-fs`

## README

# `@alint-js/tools-fs`

共享文件系统 `AgentTool`s)用于alint插件,其规则允许代理人探索一个项目. `createTools(cwd, options?)` 返回四个工具,所有相对于 `cwd`数字 :

-   `read_file` 读取 UTF-8 文件(路径相对于 `cwd` 或绝对).
-   `list_files` — 列表文件, 有可选的 glob `patterns`, (中文(简体) ), `ignore`,以及 `directory`。 。 。 .
-   `search_files` ——通过子字符串匹配文件路径.
-   `search_in_files` ——匹配文件内容,返回 `path:line: snippet` 线条.

## 使用量

```ts
import { createTools, DEFAULT_IGNORE_PATTERNS } from '@alint-js/tools-fs'

// Built-in ignores:
const tools = createTools(ctx.cwd)
// Extend the builtins:
const py = createTools(ctx.cwd, { ignore: [...DEFAULT_IGNORE_PATTERNS, '**/.venv/**'] })
// Replace the builtins:
const bare = createTools(ctx.cwd, { ignore: ['**/generated/**'] })
```

`options.ignore` **替换** 内建( e)`git/build/dist/node_modules/vendor`; 传播 `DEFAULT_IGNORE_PATTERNS` 换句话说, per-call忽略了代理总是附加在工具创建时间设置的被忽略列表中. 基础 `listFiles` 编号 : `readFile` 编号 : `searchFiles` 编号 : `searchInFiles` 也输出.

## 何时使用

-   **使用** 当 a `ctx.agent` 规则需要通用读取/列表/搜索工具来探索一个项目.

## 不使用时

-   **别** 用于一个没有代理循环的单一结构化的模型判断,或者当您需要真正的代码搜索(regex/AST/leader)时.

## 常见问题

### @alint-js/tools-fs 是什么？

用于 alint 代理授权规则的文件系统探索工具

### 如何安装 @alint-js/tools-fs？

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

### @alint-js/tools-fs 支持 TypeScript 吗？

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

### @alint-js/tools-fs 支持 ESM 还是 CommonJS？

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

### @alint-js/tools-fs 可以商用吗？

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

### @alint-js/tools-fs 的下载量有多少？

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

### @alint-js/tools-fs 还在维护吗？

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