Skip to content

fix(features): preserve literal dollar sequences in generated docs - #1333

Open
sean0407 wants to merge 1 commit into
devcontainers:mainfrom
sean0407:codex/devcontainers-cli-1325-literal-readme-substitution
Open

sean0407 wants to merge 1 commit into
devcontainers:mainfrom
sean0407:codex/devcontainers-cli-1325-literal-readme-substitution

Conversation

@sean0407

Copy link
Copy Markdown

Summary

  • Use replacement callbacks when filling README template placeholders so $ sequences from Feature metadata and NOTES.md remain literal.
  • Add a regression test covering name, description, option description, and notes content.

Reproduction

Generate a Feature README with values such as Price $&, Keep $' literally, and notes containing $ followed by a backtick. Before the fix, JavaScript replacement-string expansion changed the text and duplicated template content. The regression test reproduced this ($& became #{Name}) before the implementation change.

Changed files

  • src/spec-node/collectionCommonUtils/generateDocsCommandImpl.ts
  • src/test/container-features/featuresCLICommands.test.ts

Checks

  • yarn test-container-features-cli --grep "tests generate-docs|preserves dollar sequences in generated feature documentation" — 2 passed.
  • yarn lint — passed.
  • yarn type-check — passed.

@sean0407
sean0407 requested a review from a team as a code owner October 21, 2026 09:44

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant