DevContainer commands now default the workspace folder to the current directory if not specified. #1104
+486
−24
Conversation
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
Mathiyarasy
changed the title
chrmarti
requested changes
Dec 1, 2025
Contributor
chrmarti
left a comment
chrmarti
left a comment
There was a problem hiding this comment.
Great, thanks! Left a few comments.
| 'container-data-folder': { type: 'string', description: 'Container data folder where user data inside the container will be stored.' }, | ||
| 'container-system-data-folder': { type: 'string', description: 'Container system data folder where system data inside the container will be stored.' }, | ||
| 'workspace-folder': { type: 'string', description: 'Workspace folder path. The devcontainer.json will be looked up relative to this path.' }, | ||
| 'workspace-folder': { type: 'string', description: 'Workspace folder path. The devcontainer.json will be looked up relative to this path. If not provided, defaults to the current directory.' }, |
Contributor
There was a problem hiding this comment.
Mention --container-id and --id-label like in the descriptions of the other commands.
| "name": "@devcontainers/cli", | ||
| "description": "Dev Containers CLI", | ||
| "version": "0.80.2", | ||
| "version": "0.80.3", |
Contributor
There was a problem hiding this comment.
Let's make it 0.81.0 and list the improvement in the changelog.
| .options({ | ||
| 'log-level': { choices: ['error' as 'error', 'info' as 'info', 'debug' as 'debug', 'trace' as 'trace'], default: 'error' as 'error', description: 'Log level.' }, | ||
| 'workspace-folder': { type: 'string', description: 'Workspace folder to use for the configuration.', demandOption: true }, | ||
| 'workspace-folder': { type: 'string', description: 'Workspace folder to use for the configuration.' }, |
Contributor
There was a problem hiding this comment.
Mention using the current folder when not provided like in the other descriptions.
| return y | ||
| .options({ | ||
| 'workspace-folder': { type: 'string', alias: 'w', demandOption: true, default: '.', description: 'Target workspace folder to apply Template' }, | ||
| 'workspace-folder': { type: 'string', alias: 'w', default: '.', description: 'Target workspace folder to apply Template' }, |
Contributor
There was a problem hiding this comment.
Mention the default like in the other descriptions. Maybe omit default: '.', though I'm not sure that shows anywhere (like in the help text).
| const absoluteCliPath = `npx --prefix ${absoluteTmpPath} devcontainer`; | ||
|
|
||
| // First check if the config file exists | ||
| const configExists = require('fs').existsSync('.devcontainer/devcontainer.json') || |
Contributor
There was a problem hiding this comment.
Use import at the top instead of require.
| jsonOutput = JSON.parse(result.stdout.trim()); | ||
| } catch (parseError) { | ||
| // If direct parsing fails, try extracting JSON from mixed output | ||
| const lines = result.stdout.split('\n'); |
Contributor
There was a problem hiding this comment.
This seems to be a bug in the output. Let's not block on this, something to look into in the future.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes: #1069
Issue summary:
This PR enhances the user experience by automatically defaulting the [--workspace-folder] parameter to the current working directory when it is not explicitly specified. The following DevContainer CLI commands will now use the current working directory as the default workspace folder if [--workspace-folder] is omitted:
Test cases is implemented for all these commands