truecourse 0.5.5 → 0.5.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -56,7 +56,9 @@ TrueCourse uses the [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-
56
56
 
57
57
  ```bash
58
58
  # Analysis
59
- truecourse analyze # Analyze current repo
59
+ truecourse analyze # Analyze current repo (prompts before stashing dirty trees)
60
+ truecourse analyze --stash # Pre-approve stashing pending changes (CI-friendly)
61
+ truecourse analyze --no-stash # Analyze working tree as-is, no stash
60
62
  truecourse analyze --diff # New/resolved violations from your uncommitted changes
61
63
  truecourse list # Show violations from latest analysis
62
64
  truecourse list --all # Show all violations (no pagination)
@@ -192,6 +194,23 @@ For a one-off override, prefix the command:
192
194
  CLAUDE_CODE_MAX_CONCURRENCY=2 truecourse analyze
193
195
  ```
194
196
 
197
+ ### Excluding files from analysis
198
+
199
+ TrueCourse honors `.gitignore` automatically (including nested `.gitignore` files, `.git/info/exclude`, and your configured global excludes file).
200
+
201
+ For paths you want tracked in git but not analyzed — generated code, vendored snapshots, large fixtures — add a `.truecourseignore` at the repo root. Same syntax as `.gitignore`:
202
+
203
+ ```
204
+ # generated
205
+ src/generated/
206
+ # vendored
207
+ third_party/
208
+ # specific files
209
+ scripts/ingest-epub.js
210
+ ```
211
+
212
+ Patterns are anchored to the file's location, so `src/generated/` matches the top-level directory only; use `**/generated/` to match at any depth.
213
+
195
214
  ## Development
196
215
 
197
216
  ```bash