Skip to content

feat: ci-harper — grammar for prose, complementing typos for code #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sebhoss merged 1 commit into from
Jul 9, 2026
Merged

feat: ci-harper — grammar for prose, complementing typos for code #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions flake.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@
actionlint
shellcheck # actionlint shells out to it for run: blocks
markdownlint-cli2
harper # grammar/style for prose; typos stays for code identifiers
];

# One canonical `ci-<tool>` command per shared lint tool, wrapping the EXACT
Expand All @@ -132,6 +133,25 @@
# actionlint finds shellcheck on PATH, which the devShell provides.
(pkgs.writeShellScriptBin "ci-actionlint" ''exec ${pkgs.actionlint}/bin/actionlint "$@"'')
(pkgs.writeShellScriptBin "ci-markdown" ''exec ${pkgs.markdownlint-cli2}/bin/markdownlint-cli2 "**/*.md" "$@"'')
# harper lints PROSE (grammar, repeated words, style) where typos
# lints CODE (identifier spelling) — complements, not substitutes,
# so SpellCheck is off here; heading case is a style choice, so
# UseTitleCase is off too. Repos append rules via HARPER_IGNORE.
# Scope defaults to docs/ and kb/ (the prose homes); pass paths to
# override. Exits non-zero via xargs when any file has findings.
(pkgs.writeShellScriptBin "ci-harper" ''
set -eu
ignore="SpellCheck,UseTitleCase''\${HARPER_IGNORE:+,$HARPER_IGNORE}"
if [ "$#" -gt 0 ]; then
roots=("$@")
else
roots=()
for d in docs kb; do [ -d "$d" ] && roots+=("$d"); done
[ "''\${#roots[@]}" -gt 0 ] || roots=(.)
fi
${pkgs.findutils}/bin/find "''\${roots[@]}" -name '*.md' -not -path './.git/*' -print0 \
| ${pkgs.findutils}/bin/xargs -0 ${pkgs.harper}/bin/harper-cli lint --ignore "$ignore"
'')
];

# Assemble a repo's devShell: the shared lint gate plus the repo's own
Expand All @@ -154,8 +174,8 @@
packages = lintTools pkgs ++ lintCommands pkgs ++ packages;
shellHook = ''
if [ -t 1 ]; then
echo "metio devshell — shared lint gate: reuse, typos, yamllint, actionlint, markdownlint-cli2"
echo " run any the CI way: ci-reuse, ci-typos, ci-yaml, ci-actionlint, ci-markdown"
echo "metio devshell — shared lint gate: reuse, typos, yamllint, actionlint, markdownlint-cli2, harper"
echo " run any the CI way: ci-reuse, ci-typos, ci-yaml, ci-actionlint, ci-markdown, ci-harper"
${menu}
fi
''
Expand Down