Skip to content

Commit 8989499

Browse files
authored
chore: drop devcontainer comments that only repeat the line below (#198)
* chore: drop devcontainer comments that restate the config Per-extension descriptions repeat the extension ID, and many setting and mount comments repeat the key below them. Keep the ones that say why, give an issue number, or tell a template adopter what to change. The devcontainer.json rule now says so, since it was the source of the per-extension descriptions. * chore: keep extension descriptions and other useful devcontainer comments Narrow the cleanup to comments that only repeat the line below them. Extension descriptions, the formatter hint, section headers and the explanatory comments return as they were on master.
1 parent ba0da85 commit 8989499

9 files changed

Lines changed: 4 additions & 23 deletions

File tree

‎.claude/rules/devcontainer.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ paths:
1212
// README at: {relevant-reference-url}
1313
```
1414

15+
## Comments
16+
17+
Skip a comment that only repeats the line below it in other words, such as `// Show workspace folder name in window title` above `"window.title"`. Extension descriptions are not that: they say what an extension ID does.
18+
1519
## node_modules Mount
1620

1721
Always include to keep node_modules off the host:

‎.devcontainer/claude-sandbox/devcontainer.json‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,23 +43,20 @@
4343
"source.fixAll": "explicit",
4444
"source.organizeImports": "explicit"
4545
},
46-
// Show workspace folder name in window title
4746
"window.title": "${localWorkspaceFolderBasename}",
4847
// Sandbox visual identity — Claude Dark theme with coral remote indicator
4948
"workbench.colorTheme": "Claude Dark",
5049
"workbench.colorCustomizations": {
5150
"statusBarItem.remoteBackground": "#C15F3C",
5251
"statusBarItem.remoteForeground": "#ffffff"
5352
},
54-
// Allow Claude Code to skip permission prompts in sandbox
5553
"claudeCode.allowDangerouslySkipPermissions": true
5654
}
5755
}
5856
},
5957
"mounts": [
6058
"source=devcontainers-sandbox-config-${devcontainerId},target=/home/node/.claude,type=volume",
6159
"source=devcontainers-sandbox-zsh-history-${devcontainerId},target=/commandhistory,type=volume",
62-
// Mount firewall script into the expected path
6360
"source=${localWorkspaceFolder}/.devcontainer/claude-sandbox/init-firewall.sh,target=/usr/local/bin/init-firewall.sh,type=bind"
6461
],
6562
"containerEnv": {
@@ -71,7 +68,6 @@
7168
},
7269
// Plugins before firewall (network still open during postCreateCommand)
7370
"postCreateCommand": "sudo chown -R node /home/node/.claude /commandhistory && bash /workspace/.devcontainer/init-plugins.sh",
74-
// Firewall locks down the network
7571
"postStartCommand": "sudo /usr/local/bin/init-firewall.sh",
7672
"waitFor": "postStartCommand"
7773
}

‎.devcontainer/devcontainer.json‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@
3434
"zsh": { "path": "zsh" },
3535
"bash": { "path": "bash", "icon": "terminal-bash" }
3636
},
37-
// Suppress extension recommendation prompts
3837
"extensions.ignoreRecommendations": true,
3938
// ── Formatter settings (customize per project) ──────────────────
4039
// Change "editor.defaultFormatter" to match your tooling:
@@ -46,7 +45,6 @@
4645
"source.fixAll": "explicit",
4746
"source.organizeImports": "explicit"
4847
},
49-
// Show workspace folder name in window title
5048
"window.title": "${localWorkspaceFolderBasename}",
5149
// Visual identity — Claude Dark theme with coral remote indicator
5250
"workbench.colorTheme": "Claude Dark",
@@ -58,9 +56,7 @@
5856
}
5957
},
6058
"mounts": [
61-
// Persist Claude Code configuration between container rebuilds
6259
"source=devcontainers-claude-config-${devcontainerId},target=/home/node/.claude,type=volume",
63-
// Persist zsh history between container rebuilds
6460
"source=devcontainers-zsh-history-${devcontainerId},target=/commandhistory,type=volume"
6561
],
6662
"containerEnv": {

‎bun/.devcontainer/devcontainer.json‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@
1111
"source=${localWorkspaceFolderBasename}-node_modules,target=${containerWorkspaceFolder}/node_modules,type=volume"
1212
],
1313

14-
// Configure tool-specific properties.
1514
"customizations": {
16-
// Configure properties specific to VS Code.
1715
"vscode": {
1816
// Use zsh as the default shell for better VS Code integration
1917
"settings": {

‎claude-bun/.devcontainer/devcontainer.json‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,10 @@
2121
// Persist shell history between container rebuilds. zsh writes here
2222
// (HISTFILE in the Dockerfile); the volume name is legacy.
2323
"source=claude-code-bashhistory-${devcontainerId},target=/commandhistory,type=volume",
24-
// Persist Claude Code configuration between container rebuilds
2524
"source=claude-code-config-${devcontainerId},target=/home/bun/.claude,type=volume"
2625
],
2726

28-
// Configure tool-specific properties.
2927
"customizations": {
30-
// Configure properties specific to VS Code.
3128
"vscode": {
3229
// Use zsh as the default shell for better VS Code integration
3330
"settings": {
@@ -43,10 +40,8 @@
4340
},
4441
// Suppress extension recommendation prompts (e.g., Container Tools in Codespaces)
4542
"extensions.ignoreRecommendations": true,
46-
// Format on save with Biome
4743
"editor.formatOnSave": true,
4844
"editor.defaultFormatter": "biomejs.biome",
49-
// Biome auto-fix on save
5045
"editor.codeActionsOnSave": {
5146
"source.fixAll.biome": "explicit",
5247
"source.organizeImports.biome": "explicit"
@@ -81,7 +76,6 @@
8176
},
8277
"workspaceMount": "source=${localWorkspaceFolder},target=/workspace,type=bind,consistency=delegated",
8378
"workspaceFolder": "/workspace",
84-
// Initialize firewall after container starts
8579
"postStartCommand": "sudo /usr/local/bin/init-firewall.sh",
8680
"waitFor": "postStartCommand"
8781
}

‎claude-code/.devcontainer/claude-sandbox/devcontainer.json‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@
9595
"statusBarItem.remoteBackground": "#C15F3C",
9696
"statusBarItem.remoteForeground": "#ffffff"
9797
},
98-
// Allow Claude Code to skip permission prompts in sandbox
9998
"claudeCode.allowDangerouslySkipPermissions": true
10099
}
101100
}

‎claude-code/.devcontainer/devcontainer.json‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@
7575
"zsh": { "path": "zsh" },
7676
"bash": { "path": "bash", "icon": "terminal-bash" }
7777
},
78-
// Suppress extension recommendation prompts
7978
"extensions.ignoreRecommendations": true,
8079
// ── Formatter settings (customize per project) ──────────────────
8180
// Change "editor.defaultFormatter" to match your tooling:
@@ -87,7 +86,6 @@
8786
"source.fixAll": "explicit",
8887
"source.organizeImports": "explicit"
8988
},
90-
// Show workspace folder name in window title
9189
"window.title": "${localWorkspaceFolderBasename}"
9290
}
9391
}

‎hugo-bun-node/.devcontainer/devcontainer.json‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@
1111
"source=${localWorkspaceFolderBasename}-node_modules,target=${containerWorkspaceFolder}/node_modules,type=volume"
1212
],
1313

14-
// Configure tool-specific properties.
1514
"customizations": {
16-
// Configure properties specific to VS Code.
1715
"vscode": {
1816
// Use zsh as the default shell for better VS Code integration
1917
"settings": {

‎hugo-bun/.devcontainer/devcontainer.json‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@
1111
"source=${localWorkspaceFolderBasename}-node_modules,target=${containerWorkspaceFolder}/node_modules,type=volume"
1212
],
1313

14-
// Configure tool-specific properties.
1514
"customizations": {
16-
// Configure properties specific to VS Code.
1715
"vscode": {
1816
// Use zsh as the default shell for better VS Code integration
1917
"settings": {

0 commit comments

Comments
 (0)