Merge pull request #92 from CodeDeficient/claude/project-thread-36cl1x-tidy

Tidy repo files: misplaced doc comment, dead screenshot, pre-commit hook

Author: CodeDeficient

.karpeslop/pre-commit

@@ -118,7 +118,7 @@ There are no inline suppression comments. A comment that silences the linter is
   run: npx karpeslop@latest --quiet --strict
 ```
 
-[`examples/github-workflow.yml`](examples/github-workflow.yml) is a complete workflow that also uploads the JSON report and comments on the pull request when the check fails.
+[`examples/github-workflow.yml`](examples/github-workflow.yml) is a complete workflow that also uploads the JSON report and comments on the pull request when the check fails. [`examples/pre-commit`](examples/pre-commit) is a git hook that blocks a commit on critical findings.
 
 ## Contributing
 

.npmignore

@@ -0,0 +1,12 @@
+#!/bin/sh
+# KarpeSlop pre-commit hook.
+# Copy to .git/hooks/pre-commit (or call it from husky or lint-staged) and make it executable.
+#
+# Blocks the commit on critical findings (imports or packages that do not
+# exist), and on any error that stops the scan. Use --fail-on=high to block
+# on high-severity findings too.
+
+if ! npx karpeslop@latest --fail-on=critical --no-report; then
+  echo "KarpeSlop: commit blocked by the findings or error above."
+  exit 1
+fi

README.md

@@ -381,7 +381,6 @@ interface CastReport {
   form: string;
 }
 
-/** Classify one cast. Chained casts report the chain, plus `as any` when it ends in any. */
 function skipParentheses(expr: ts.Expression): ts.Expression {
   let current = expr;
   while (ts.isParenthesizedExpression(current)) current = current.expression;
@@ -405,6 +404,7 @@ function isInnerOfChain(node: AssertionNode): boolean {
   return isCast(parent);
 }
 
+/** Classify one cast. Chained casts report the chain, plus `as any` when it ends in any. */
 function classifyCast(node: AssertionNode): CastReport[] {
   const isAny = node.type.kind === ts.SyntaxKind.AnyKeyword;
   if (innerCast(node) !== undefined) {