feat: add GNU envsubst SHELL-FORMAT compatibility#72
Closed
nicholasklem wants to merge 2 commits into
Closed
Conversation
Add support for GNU envsubst's SHELL-FORMAT positional argument, enabling
selective variable substitution while preserving the extended bash syntax.
When SHELL-FORMAT is provided (e.g., `envsubst '$FOO $BAR'`), only those
variables are substituted; other variable references remain as literal text.
New features:
- SHELL-FORMAT positional argument for variable filtering
- `-v` flag to output variable names from SHELL-FORMAT (GNU compat)
- New public API: StringWithVars(), BytesWithVars(), ReadFileWithVars()
- Full backward compatibility when no SHELL-FORMAT is provided
Example usage:
# Only substitute $USER and $HOME, leave others literal
echo '$USER $HOME $OTHER' | envsubst '$USER $HOME'
# Works with extended syntax - preserves defaults for filtered vars
echo '${FOO:-default} ${BAR:-default}' | envsubst '$FOO'
# Output: foovalue ${BAR:-default}
# List variables in SHELL-FORMAT
envsubst -v '$FOO ${BAR}'
# Output: FOO\nBAR
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add comprehensive test cases for SHELL-FORMAT parsing: - Escaping ($$, $$$$) - Underscore handling (_FOO vs _) - All operator variants (:- := :+ - = +) - Edge cases (trailing $, unclosed braces, empty input) - Numeric vars (a8m allows by default, unlike GNU) - Real-world ARGOCD_ENV_ patterns Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
3 tasks
Author
|
I moved away from SHELL-FORMAT and went with a |
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
This PR adds support for GNU envsubst's
SHELL-FORMATpositional argument, enabling selective variable substitution while preserving the extended bash-style syntax that makes this library valuable.Use case: In ArgoCD Config Management Plugins, we need to:
ARGOCD_ENV_*prefixed variables (not all env vars)${VAR:-default}Currently, users must choose between GNU envsubst (variable filtering) OR a8m/envsubst (extended syntax). This PR enables both.
Changes
envsubst '$VAR1 $VAR2'only substitutes listed variables-vflag: Outputs variable names from SHELL-FORMAT (GNU compatibility)StringWithVars(),BytesWithVars(),ReadFileWithVars()and restricted variantsExample Usage
Test plan
We understand this is a significant change. Happy to discuss the approach or make adjustments based on feedback. We have a fork at
nicholasklem/envsubstif this doesn't align with the project's direction.🤖 Generated with Claude Code