Skip to content

docs(node): document pre-bundled items and how to opt out#1695

Open
V-Subhankar-infy wants to merge 2 commits into
devcontainers:mainfrom
V-Subhankar-infy:patch-node
Open

docs(node): document pre-bundled items and how to opt out#1695
V-Subhankar-infy wants to merge 2 commits into
devcontainers:mainfrom
V-Subhankar-infy:patch-node

Conversation

@V-Subhankar-infy

@V-Subhankar-infy V-Subhankar-infy commented Jul 24, 2026

Copy link
Copy Markdown
Member

docs(node): document pre-bundled items and how to opt out

Aimed to Solve #1693 · Related: #386

Problem

The node feature installs recommended extensions (e.g. dbaeumer.vscode-eslint)
and tools (yarn, pnpm) by default, but this isn't documented. Users wanting only
Node.js are surprised and find no opt-out guidance — the same concern raised in
#386 for the Node and Go features.

Options considered

  • Remove the extension: a breaking change to a long-standing default and
    inconsistent with sibling features.
  • Per-extension opt-out option: proposed by @samruddhikhandale in Add option to opt out of extensions #386, but
    never implemented as it needs a spec change; the native VS Code -<id> syntax
    now fills this role.
  • Document the behavior + -<id> opt-out: chosen.

Why this option

The behavior is intentional and the -<id> opt-out already exists — only the
documentation was missing. It's non-breaking, zero-risk, and directly answers
what users asked in #1693 and #386.

Changes

Adds a short "Pre-bundled items" note to src/node/NOTES.md describing the default
extensions/tools and how to exclude them (extension → -<id>, tool → option
"none"). The README is auto-generated, so it regenerates on merge.

Impact

Docs-only — no behavioral change and no runtime risk. Users get clear, discoverable
opt-out guidance, which should reduce duplicate reports.

Future action

Only node is covered here; ~14 other features bundle extensions too. The durable fix
is to auto-emit this note from the docs generator (devcontainers/action, tracked in
action#139) rather than copying it per-feature.

Added notes on excluding pre-bundled items and VS Code extensions.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds Node feature documentation clarifying what gets pre-bundled by default and how consumers can opt out of those defaults.

Changes:

  • Documented that the feature includes pre-bundled convenience items (VS Code extensions and supporting tools).
  • Added an example showing how to exclude a bundled VS Code extension and disable a bundled tool via none.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/node/NOTES.md Outdated
Corrected formatting and punctuation in the NOTES.md file.
@V-Subhankar-infy
V-Subhankar-infy requested a review from Copilot July 24, 2026 13:30
@V-Subhankar-infy
V-Subhankar-infy marked this pull request as ready for review July 24, 2026 13:30
@V-Subhankar-infy
V-Subhankar-infy requested a review from a team as a code owner July 24, 2026 13:30

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread src/node/NOTES.md
Comment on lines +36 to +37
Exclude a bundled **VS Code extension** by prefixing its ID with `-`, or disable a bundled **tool** by setting its option to `none`:

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.

2 participants