How hailstails/hone works
Hone is a repository-discipline checker: a user invokes its CLI, which reads the repository’s selected rules, configuration and exception records, dispatches checks to the chosen engine, then reports a verdict. Its domain stages include rule selection, mechanism execution, exception/debt handling and reporting; separate commands manage debt records and migrate version-1 repositories. The README documents these workflows and engine capabilities; sampled source confirms parts of engine dispatch and rule loading, but not every command’s internal call graph.
Main entry points: run-check.ts Check workflow · engine-run.ts Engine dispatch · tool-command.ts Hone CLI · consumer-selection.ts Rule selection
Components 19
CLI and commands
- Hone CLI
core/check/tool-command.ts - Command arguments
core/command-line/command-arguments.ts
Assessment core
- Check workflow
core/check/run-check.ts - Rule selection
core/consumer-selection/consumer-selection.ts - Rule-set reader
core/rule-set-reader/rule-set-reader.ts - Symptom catalogue
core/symptom-catalogue/symptom-catalogue.ts - Engine orchestration
core/run/engines-run.ts - Engine dispatch
core/run/engine-run.ts - Mechanism contract
core/mechanism-port/runner-module-schema.ts - Verdict report
core/verdict/report-text.ts
Check engines
- Walker engine
mechanisms/audit/runner/runner.ts - ESLint engine
mechanisms/eslint/runner/runner.ts
Records and migration
- Exception records
core/exception-records/exception-layout.ts - Finding answers
core/records/answering.ts - Debt commands
core/check/run-record-debt-command.ts - Authorise location
core/records/authorising.ts - Version upgrade
core/upgrade/command/run-upgrade-command.ts
Other components
- Repository user
- Target repository
Connections 21
- Repository user → Hone CLI: invokes
README.md - Hone CLI → Command arguments: parses commands
README.md - Hone CLI → Check workflow: runs check
README.md - Check workflow → Target repository: reads configuration
README.md - Check workflow → Rule selection: loads selection
core/check/run-check.ts - Rule selection → Rule-set reader: reads rules
core/consumer-selection/consumer-selection.ts - Check workflow → Symptom catalogue: loads catalogue
README.md - Check workflow → Engine orchestration: runs selected engines
README.md - Engine orchestration → Engine dispatch: dispatches checks
core/run/engines-run.ts - Engine dispatch → Mechanism contract: loads runner contract
core/run/engine-run.ts - Engine dispatch → Walker engine: runs standalone checks
README.md - Engine dispatch → ESLint engine: runs ESLint checks
README.md - Check workflow → Exception records: reads exceptions
README.md - Check workflow → Finding answers: answers findings
README.md - Check workflow → Verdict report: prints verdict
README.md - Repository user → Debt commands: records or prunes
README.md - Debt commands → Target repository: updates records
README.md - Repository user → Authorise location: authorises location
README.md - Authorise location → Target repository: writes record
README.md - Repository user → Version upgrade: requests migration
README.md - Version upgrade → Target repository: migrates repository
README.md