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.」。本文只整理倉庫可直接核對的內容,不把 star、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 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「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。