Git hooks fer linters and formatters
Chart yer checks once, and hk pipes the crew on deck afore ye set sail, while ye work, or fer the harbour-master in CI. Independent hands haul side by side, and a lock on each shared file takes the strain.
mise use hkmise, the quartermaster, brings hk aboard, though there be other ways. Every way aboard →
// Run by check, fix, and pre-commit
steps {
["prettier"] = Builtins.prettier
["eslint"] = Builtins.eslint
["ruff"] = Builtins.ruff
}Side by side, each on a file o' their own
app.tsmain.pyEach file has its own lane, and all hands haul at once. Checks can share a file; a fix makes its file fast until the mending's done.
What the crew does on every run o' the pre-commit hook, verse by verse.
git commitYe christen her, hit return, and she makes ready to sail.
The pre-commit hook pipes the crew up from stem to stern.
hk can stow the cargo left on the dock in the hold, so the crew sees only the cargo loaded aboard.
Lookouts and sailmakers work in parallel, and a lock on each file takes the strain.
The fixes are loaded aboard, yer stowed cargo comes up from the hold, and she sets sail. A squall no sailmaker can mend hauls her back to port.
Sing along, matey
The hk sea shanty: one commit's voyage through hk, sung by the whole crew.
Heave away, haul away, hk! (Heave ho!)All hands haul at once! (Haul away!)For a lock on each file takes the strain,And we're bound away for the main!
Independent hands haul at once, even over shared cargo: read/write locks make each file fast, so no two collide. Where a tool can call out a patch or a list o' files, hk narrows the work that needs a file to itself.
How the crew hauls →hk stows the cargo left on the dock in the hold afore it mends the staged version o' a file, then brings it up from the hold when the hook is done.
How the stowin' works →Sign on a builtin from the standing crew, or a hand of yer own with a shell command. mise, the quartermaster, or yer usual package manager provisions the tools.
Read the crew roster →They steer by the one set of charts
Sign on yer hands once, in Pkl. The hook, the helm and the harbour-master all muster the self-same crew: to inspect a change, mend yer working tree, or inspect the whole ship.
Learn the ropes →hk checkhk fixhk check --allhk check --planWhere to sail next
So all you hands who would sign aboard,
mise use hk
And we're bound away for the main!
Get under way