feat: add {file:path} config substitution for reading values from files - #259
Open
RalphSu2 wants to merge 1 commit into
Open
feat: add {file:path} config substitution for reading values from files#259RalphSu2 wants to merge 1 commit into
RalphSu2 wants to merge 1 commit into
Conversation
Extend the config substitution system to support {file:path} syntax in
addition to the existing env var substitution. This allows
users to reference file contents directly in config, e.g. for auth tokens:
"Authorization": "Bearer {file:~/.ssh/my_token}"
- {file:...} reads file contents and trims whitespace
- ~ prefix expands to home directory
- Same strict/non-strict error handling as env vars (MISSING_FILE)
- 6 new tests covering substitution, trimming, tilde expansion, coexistence
with env vars, and error handling in both modes
Author
|
fixs #260 |
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
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.
Summary
Extends the config substitution system to support
{file:path}syntax in addition to the existing${VAR_NAME}env var substitution. This allows users to reference file contents directly in config values, e.g. for auth tokens:{ "mcpServers": { "my-server": { "url": "https://example.com/mcp", "headers": { "Authorization": "Bearer {file:~/.ssh/my_token}" } } } }Changes
src/config.ts: Added a second regex pass (/\{file:([^}]+)\}/g) insubstituteEnvVars()that reads file contents, trims whitespace, and expands~to home directory. Same strict/non-strict error handling as env vars — newMISSING_FILEerror type in strict mode, warning + empty string in non-strict mode.tests/config.test.ts: 6 new tests covering file substitution, content trimming, tilde expansion, coexistence with${VAR}, and error handling in both strict and non-strict modes.README.md: Updated substitution docs with a syntax table and{file:...}example.Design decisions
readFileSync— config loads once at startup; consistent with existingexistsSyncusage. Avoids cascading async refactor.~expansion viahomedir()(already imported).${...}and{file:...}regexes.Test results