automatic lookup for workspace folder #425

MunsMan · 2023-02-27T17:03:39Z

Fixes #29 by checking if the current working directory contains a .devcontainer folder.

I added this check after seeing #332

It looks like that the following two if-statements are obsolete.
If they are obsolete, just let me know, then I will remove them as well.

sarashino · 2023-02-28T05:00:39Z

I think better reopen this. or feel free to reuse my codes.
#387

MunsMan · 2023-02-28T08:10:36Z

@sarashino I just looked at your code and I agree that your isDirectory checks makes sense and I will add it.

Is DEVCONTAINERS_CEILING_DIRECTORIES part of the office spec? Couldn't find it anywhere. What is its purpose?

sarashino · 2023-02-28T08:15:45Z

@MunsMan Thanks.
CEILING comes from GIT_CEILING_DIRECTORIES.
Mine is almost same implementation as git has.

P.S. Just for quick reply cause I'm not in front of my desk right now.

MunsMan · 2023-02-28T08:22:51Z

@sarashino Thanks for the prompt Response.

I disagree with you about the need of such a feature. I would propose that if the user messes up the working directory, that he should be notified. Otherwise, we might start an unwanted devcontainer or worse.
Therefore, I would keep it simple and just check if the cwd contains the .devcontainer directory.

like in issue devcontainers#387

MunsMan · 2023-02-28T11:40:04Z

@microsoft-github-policy-service agree

MunsMan · 2023-02-28T11:47:25Z

I added this feature to:

devcontainer up
devcontainer run-user-command
devcontainer read-configuration
devcontainer exec

Should it be added to devcontainer build as well? Currently, for devcontainer build a workspace-path is required.

Had to add default to ensure that `workspace-folder` can't be undefined

MunsMan · 2023-02-28T14:03:09Z

Just added a draft for the devcontainer build command. I added the default option, to ensure for typescript that the workspace-folder is a string. I would love to hear about a different implementation approach.

Furthermore, I wondered if the path which should be specified for the build command is even used. Likewise, I could find any reason why it is specified in the docs. With the latest push, you can build with just devcontainer build if you are in your working folder.

hpe-ykoehler · 2023-08-03T17:15:35Z

This PR seems to have a great usability value, yet I am not seeing what is blocking this from getting merge, as an interested parties I would like to know and potentially help getting this merged.

samruddhikhandale

Apologies for not reviewing this PR sooner. Left some comments.

@MunsMan are you still interested in contributing this PR? It would be awesome to merge this in. If so, can you add few tests to validate these changes? Thanks!

samruddhikhandale · 2023-09-21T19:46:13Z

src/spec-node/devContainersSpecCLI.ts

-			if (!(argv['workspace-folder'] || argv['override-config'])) {
-				throw new Error('Missing required argument: workspace-folder or override-config');
+			if (!(argv['id-label'] || argv['override-config'] || isWorkspaceFound)) {
+				throw new Error('Missing required argument: workspace-folder or id-label or override-config');


As workspace-folder is no longer a required parameter, this error message could be misleading. Instead can we give a similar error (eg. Dev container config not found.) 👇 if workspace is not found?

cli/src/spec-node/devContainersSpecCLI.ts

Line 424 in efb3ffc

throw new ContainerError({ description: `Dev container config (${uriToFsPath(configFile, cliHost.platform)}) not found.` });

samruddhikhandale · 2023-09-21T19:47:55Z

src/spec-node/devContainersSpecCLI.ts

+		if (argv['workspace-folder'] === '.') {
+			const workspaceFolder = findWorkspaceFolder();
+			if (!workspaceFolder) {
+				throw new Error('Unable to find Configuration File, provide workspace-folder argument');


Suggested change

throw new Error('Unable to find Configuration File, provide workspace-folder argument');

throw new Error('Unable to find the dev container config, provide workspace-folder argument');

samruddhikhandale · 2023-09-21T19:48:14Z

src/spec-node/devContainersSpecCLI.ts

@@ -696,17 +716,23 @@ function runUserCommandsOptions(y: Argv) {
 	})
 		.check(argv => {
 			const idLabels = (argv['id-label'] && (Array.isArray(argv['id-label']) ? argv['id-label'] : [argv['id-label']])) as string[] | undefined;
+			const isWorkspaceFound = argv['workspace-folder'] || findWorkspaceFolder();
+			console.debug(isWorkspaceFound);


nit: Should we remove this?

Do you mean the debug log? I just removed it.
The isWorkspaceFound is required in a lower check, but I adjusted the Error Message there as well.

MunsMan · 2023-09-21T20:17:54Z

@samruddhikhandale I will take a look at it over the coming days. The Pull Request is that old, I barely remember the codebase.

MunsMan · 2023-09-22T18:46:05Z

@samruddhikhandale Do you have a proper styling sheet, or a method to style the code before committing?
My personal configuration doesn't match the original styles and using tsfmt doesn't help...

chrmarti · 2023-09-26T13:50:35Z

src/spec-node/devContainersSpecCLI.ts

@@ -82,6 +83,16 @@ const mountRegex = /^type=(bind|volume),source=([^,]+),target=([^,]+)(?:,externa

 })().catch(console.error);

+function findWorkspaceFolder(): string | undefined {


Wouldn't it be sufficient to just make . the default for --workspace-folder?

kita99 · 2024-03-23T15:27:24Z

Hey guys, I'm really interested in getting this merged as I think it would greatly improve the CLI. In case @MunsMan has no time to pick this back up I volunteer to help get the feature merged.

Can one of the reviewers (@chrmarti, @samruddhikhandale) post a quick reply with the key points required to get this rolling again?

MunsMan · 2024-03-23T20:35:04Z

That would be great. I currently have no use for this and no capacity to write the tests. @kita99 If you can take over, that would be great.

g-arjones · 2024-07-01T19:10:23Z

I'm also willing to finish this up so it can get merged. @chrmarti @samruddhikhandale could one of you please summarize what's missing? It's currently the most up-voted feature request, there's a PR already open and more people willing to contribute. All we need is a reviewer, please.

automatic lookup for workspace folder

7e242c3

MunsMan requested a review from a team as a code owner February 27, 2023 17:03

MunsMan mentioned this pull request Feb 27, 2023

Make --workspace-folder optional, default to ".". Fixes #29 #424

Closed

removing duplicate update

5c7077c

MunsMan added 4 commits February 28, 2023 11:07

switching to findWorkspaceFolder Function

c99c04f

like in issue devcontainers#387

Adding support for the run-user-command

bac5de8

Adding Support for read-configuration

2051fa1

adding support for exec

06d6905

adding feature to the build command.

bc7b16c

Had to add default to ensure that `workspace-folder` can't be undefined

MunsMan mentioned this pull request Feb 28, 2023

Why Is --workspace-folder Required. Can we default to $PWD? #29

Open

samruddhikhandale reviewed Sep 21, 2023

View reviewed changes

chrmarti requested changes Sep 26, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

automatic lookup for workspace folder #425

automatic lookup for workspace folder #425

MunsMan commented Feb 27, 2023 •

edited

Loading

sarashino commented Feb 28, 2023 •

edited

Loading

MunsMan commented Feb 28, 2023

sarashino commented Feb 28, 2023

MunsMan commented Feb 28, 2023

MunsMan commented Feb 28, 2023

MunsMan commented Feb 28, 2023

MunsMan commented Feb 28, 2023

hpe-ykoehler commented Aug 3, 2023

samruddhikhandale left a comment

samruddhikhandale Sep 21, 2023

samruddhikhandale Sep 21, 2023

samruddhikhandale Sep 21, 2023

MunsMan Sep 22, 2023

MunsMan commented Sep 21, 2023

MunsMan commented Sep 22, 2023 •

edited

Loading

chrmarti Sep 26, 2023

kita99 commented Mar 23, 2024

MunsMan commented Mar 23, 2024 •

edited

Loading

g-arjones commented Jul 1, 2024

	throw new Error('Unable to find Configuration File, provide workspace-folder argument');
	throw new Error('Unable to find the dev container config, provide workspace-folder argument');

		@@ -82,6 +83,16 @@ const mountRegex = /^type=(bind\|volume),source=([^,]+),target=([^,]+)(?:,externa

		})().catch(console.error);

		function findWorkspaceFolder(): string \| undefined {

automatic lookup for workspace folder #425

Are you sure you want to change the base?

automatic lookup for workspace folder #425

Conversation

MunsMan commented Feb 27, 2023 • edited Loading

sarashino commented Feb 28, 2023 • edited Loading

MunsMan commented Feb 28, 2023

sarashino commented Feb 28, 2023

MunsMan commented Feb 28, 2023

MunsMan commented Feb 28, 2023

MunsMan commented Feb 28, 2023

MunsMan commented Feb 28, 2023

hpe-ykoehler commented Aug 3, 2023

samruddhikhandale left a comment

Choose a reason for hiding this comment

samruddhikhandale Sep 21, 2023

Choose a reason for hiding this comment

samruddhikhandale Sep 21, 2023

Choose a reason for hiding this comment

samruddhikhandale Sep 21, 2023

Choose a reason for hiding this comment

MunsMan Sep 22, 2023

Choose a reason for hiding this comment

MunsMan commented Sep 21, 2023

MunsMan commented Sep 22, 2023 • edited Loading

chrmarti Sep 26, 2023

Choose a reason for hiding this comment

kita99 commented Mar 23, 2024

MunsMan commented Mar 23, 2024 • edited Loading

g-arjones commented Jul 1, 2024

MunsMan commented Feb 27, 2023 •

edited

Loading

sarashino commented Feb 28, 2023 •

edited

Loading

MunsMan commented Sep 22, 2023 •

edited

Loading

MunsMan commented Mar 23, 2024 •

edited

Loading