-
Notifications
You must be signed in to change notification settings - Fork 45
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Feature Description
It would be nice if codebook could parse the configuration from a pyproject.toml in the project directory. pyproject.toml allows for arbitrary tool configuration in the [tool] table.
Use Case
Python projects tend to centralize tools configuration in pyproject.toml.
Proposed Solution
- If
codebook.tomlor.codebook.tomlare not found in the project directory, look for apyproject.toml. - If
[tool.codebook]exists, parse it for configuration. - It's expected that settings under
[tool.codebook]are the same ascodebook.tomlroot.
Alternative Solutions
No response
Examples
The README.md Configuration Options in a pyproject.toml.
[tool.codebook]
dictionaries = ["en_us", "en_gb"]
words = ["codebook", "rustc"]
flag_words = ["todo", "fixme"]
include_paths = ["src/**/*.rs", "lib/**/*.rs"]
ignore_paths = ["target/**/*", "**/*.json", ".git/**/*"]
ignore_patterns = [
'\b[ATCG]+\b',
'\d{3}-\d{2}-\d{4}',
'^[A-Z]{2,}$',
'https?://[^\s]+'
]
min_word_length = 3
use_global = trueAdditional Context
Example references:
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request