Skip to content

Commit

Permalink
Add readme for new ignore_patterns
Browse files Browse the repository at this point in the history
  • Loading branch information
blopker committed Feb 16, 2025
1 parent a0953d2 commit 61a63dc
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ Codebook has an optional configuration file you can put in the root of your proj
Here are the options:

```toml
# Currently unused. Will add more dictionaries soon.
# Default: ["en_us"]
# "en_gb" also works.
dictionaries = ["en_us"]
# List of words to ignore. Case-insensitive. Codebook will add words here when you select "Add to dictionary".
# Default: []
Expand All @@ -61,6 +61,12 @@ flag_words = ["todo", "fixme"]
# List of path globs to ignore when spell checking.
# Default: []
ignore_paths = ["target/**/*", "**/*.json", ".git/**/*"]
# List of regex patterns to ignore when spell checking. Useful for domain-specific strings like DNA sequences.
# Default: []
ignore_patterns = [
"^[ATCG]+$", # DNA sequences
"\\d{3}-\\d{2}-\\d{4}" # Social Security Number format
]
```

## Goals
Expand Down

0 comments on commit 61a63dc

Please sign in to comment.