工具
命令行界面、格式化器、代码检查器、测试、交互式解释器和语言服务器。
工具
当前仓库的工具不止于单个 souc 二进制文件。要全面了解,需要包括检查的产物、基于脚本的网关、网站质量检查以及围绕编译器的自托管验证表面。
当前约定
- 检查进来的
souc产物仍然是公共命令行界面最具体的外部表面。 - 命令行界面应从
--help和info发现,而非从陈旧文档推断。 - 脚本网关是工具故事的一部分,因为它们是仓库如何证明整个系统关于编译器、标准库、自托管路径和网站的主张。
首先检查的 CLI 表面
export SOUC_BIN="$(pwd)/bin/souc"
"$SOUC_BIN" --help
"$SOUC_BIN" info
"$SOUC_BIN" fmt --help
"$SOUC_BIN" lint --help
"$SOUC_BIN" repl --help
仓库地图
scripts/包含主要的网关和工作流命令。scripts/selfhost/覆盖自托管验证和零回退网关。website/package.json定义了网站自身的文档和发布质量检查。self-hosted/tools/及相关自托管验证文档解释了围绕编译器的无 Rust 和自举取向的工具故事。
高价值仓库检查
bash scripts/fast_gate.sh
bash scripts/selfhost/selfhost_zero_fallback_gate.sh
npm --prefix website run check:quality
如何准确文档工具
- 描述检查产物,然后描述周围验证脚本。
- 文档以产物为依赖的功能网关,例如 LSP、GPU 或 LLVM。
- 如果工作流依赖于自托管或自举阶段,直接说明,而非呈现为默认用户路径。