fallow-rs/fallow:README 来源编辑指南
基于 README、仓库元数据和许可证整理 fallow-rs/fallow 的安装与核验路径。
项目定位
fallow-rs/fallow 的 README 将项目描述为"Codebase intelligence for TypeScript and JavaScript. Free static analysis of code and styles: unused code, duplication, circular deps, complexity hotspots, architecture boundaries, design-system drift."。本文只整理仓库能直接核验的内容,不把星标、Fork 或宣传语当成质量证明。README 在"README"下的说明是:One binary finds unused code, circular dependencies, duplication, complexity hotspots, boundary violations, and design-system styling drift. An optional paid layer, Fallow Runtime, adds production execution evidence.。这给出的首先是项目边界,而不是已经完成的生产验证。
适用场景
从 README 的"What fallow reports"和相关条目看,读者可以先判断它是否解决自己的具体问题:Circular dependencies and re-export cycles, part of fallow dead-code。如果你的目标与这段说明不一致,就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名,方便回到一手来源核对。 README 还列出了另一条可核对的信息:Unused files, exports, types, enum and class members, and dependencies。这类原文条目可以帮助读者设计试运行步骤,但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"README"等段落中。可确认的线索包括:Excerpt from fallow audit on the vitest monorepo, auditing its last 15 commits. fallow 3.5.0, warm base-snapshot cache. The gate passed: the 163 inherited findings are pre-existing and excluded by design, so they do not block the change.。这篇整理没有把未写出的架构、性能或安全边界补成结论;真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是: # Zero-install, full pipeline (dead code + duplication + health) npx fallow # Gate only what a PR changed npx fallow audit # Install as a devDependency npm install --save-dev fallow # For agents and scripts: exit 0 and 1 both mean the run succeeded (1 = findings); # exit 2 is a real error, reported as a JSON envelope on stdout npx fallow audit --format json --quiet 2>/dev/null 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"What fallow reports"部分,确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"Quick start"段落提到:The npm package ships the fallow, fallow-lsp, and fallow-mcp launchers plus a version-matched agent skill, so the editor and agent integrations resolve the project-local binary instead of whatever happens to be on PATH.。对于配置文件、环境变量、权限和数据目录,当前稿只记录来源明确的部分;未写明的默认值必须在测试环境中验证,并保留可回滚的配置副本。 同一部分还提到:Code duplication with a suffix-array detector covering JS/TS and CSS-family stylesheets, plus Vue/Svelte/Astro component regions。