Skip to content

Commit 6ad8009

Browse files
committed
docs: describe recursive glob exclusions
1 parent 36f8ef3 commit 6ad8009

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Checks one or more prompt files against a simple JSON rules file.
7373
promptdiff check prompts/*.md --rules promptdiff.rules.json --fail-on high
7474
```
7575

76-
Both commands parse options strictly. Unknown options and options missing their required values are errors, and `compare` accepts exactly two file arguments. For `check`, every file or glob supplied on the command line must match; PromptDiff does not emit a partial report when one input is unmatched. Globs support `*` and `?` within a path segment and recursive `**` matching, such as `examples/**/*.md`. Results are sorted and deduplicated before checking.
76+
Both commands parse options strictly. Unknown options and options missing their required values are errors, and `compare` accepts exactly two file arguments. For `check`, every file or glob supplied on the command line must match; PromptDiff does not emit a partial report when one input is unmatched. Globs support `*` and `?` within a path segment and recursive `**` matching, such as `examples/**/*.md`. Glob traversal skips `.git`, `dist`, and `node_modules` directories so broad patterns check project-owned inputs instead of VCS, generated, or dependency content. Explicit file inputs remain available for any path. Results are sorted and deduplicated before checking.
7777

7878
The rules document must be a JSON object. `requiredPhrases`, `forbiddenPhrases`, and `requireSections`, when present, must be arrays containing only non-empty strings. `maxSeverity` must be one of `info`, `low`, `medium`, `high`, or `critical`. Invalid rules exit with code `1`, print a field-specific diagnostic to stderr, and do not emit a report.
7979

0 commit comments

Comments
 (0)