@alint-js/tools-fs

中文文档
0.7.3发布于 2026/09/29MITTypeScriptES Module近 30 天下载 9.4万

Filesystem exploration tools for alint agent-powered rules

原始使用文档
文档目录3 节
  1. Usage
  2. When to use
  3. When not to use

@alint-js/tools-fs

Shared filesystem AgentTools for alint plugins whose rules let an agent explore a project. createTools(cwd, options?) returns four tools, all reporting paths relative to cwd:

  • read_file — read a UTF-8 file (path relative to cwd or absolute).
  • list_files — list files, with optional glob patterns, ignore, and directory.
  • search_files — match file paths by substring.
  • search_in_files — match file contents, returning path:line: snippet lines.

Usage

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 replaces the builtins (git/build/dist/node_modules/vendor); spread DEFAULT_IGNORE_PATTERNS to extend them instead. Per-call ignores from the agent always append to the ignore list set at tool creation time. The underlying listFiles / readFile / searchFiles / searchInFiles are exported too.

When to use

  • Use when a ctx.agent rule needs generic read/list/search tools to explore a project.

When not to use

  • Don't for a single structured model judgement without an agent loop, or when you need real code search (regex/AST/ranking).

版本与发布记录

@alint-js/tools-fs 共发布 35 个版本,首次发布于 2026/07/13;过去 12 个月发布了 35 个版本。

版本发布日期距今
0.7.3latest2026/09/291 个月前
0.7.22026/09/281 个月前
0.7.12026/08/292 个月前
0.7.02026/08/292 个月前
0.6.02026/08/192 个月前
0.5.02026/08/162 个月前

关于 @alint-js/tools-fs 的常见问题

@alint-js/tools-fs 是什么?

Filesystem exploration tools for alint agent-powered rules

如何安装 @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 和提交记录判断。