docs(config): document extra_extensions values and skip behavior#487
Open
JOhnsonKC201 wants to merge 1 commit into
Open
docs(config): document extra_extensions values and skip behavior#487JOhnsonKC201 wants to merge 1 commit into
JOhnsonKC201 wants to merge 1 commit into
Conversation
The README's "Custom File Extensions" section showed a single example key and stated that unknown language values are "silently skipped". Issue DeusData#359 asks what other config-file options exist and where they are documented. - Clarify that `extra_extensions` is the only key the JSON config files accept. - List the accepted, case-insensitive language names (and aliases) so users know which values are valid. - Document the "extension must start with ." rule. - Correct the behavior note: invalid entries are skipped with a warning logged to stderr (the parser calls cbm_log_warn), not silently. Closes DeusData#359 Signed-off-by: Johnson K C <Johnsonkc201@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #359.
The README's Custom File Extensions section previously showed a single example key and stated unknown language values are "silently skipped". #359 asks which other config-file options exist and where they're documented.
This clarifies the config-file surface and fixes an inaccuracy:
extra_extensionsis the only key the JSON config files (.codebase-memory.json/config.json) accept, and points to the Environment Variables table andconfigsubcommand for other tunables.LANG_NAME_TABLEinsrc/discover/userconfig.c, so users know which values are valid.." rule.parse_extra_extensionscallscbm_log_warn("userconfig.unknown_lang", …)), not silently.Docs only — no code changes. Verified against
main(e599df1).