Use workspace file when opening repository in VS Code

[ghost]

Problem
When I open a repo in Github Desktop the app suggests to open the repo in Visual Studio Code. That's great, but instead of opening the root folder I would like it to open .code (workspace) file when it is available in the root. Either per default or via a setting.

Thanks for a great product!

[shiftkey]

@SimonKibsgaard thanks for the feedback!

Do you have any links to resources explaining this file in more detail?

[ghost]

@shiftkey yes, sorry I forgot that.

I believe this is the best source: https://code.visualstudio.com/docs/editor/multi-root-workspaces#_workspace-file

To add some more detail, when I launch the repo from the current button in GitHub Desktop, the repo folder opens and VS Code prompts me to open the workspace instead (because it detects the .code file).

If GitHub Desktop launched the .code file instead of the root folder it would work as I hope for.

Br, Simon

[shiftkey]

@SimonKibsgaard thanks for the extra information!

For the moment I'm going to mark this as help wanted as this is a great chance for someone who knows VSCode and workspaces to look into trying to add support for this.

The current launch function for opening an editor isn't aware of editor-specific rules, so I suspect that area will need some enhancement:

desktop/app/src/lib/editors/launch.ts

Lines 5 to 14 in e4a7e23

	/**
	* Open a given file or folder in the desired external editor.
	*
	* @param fullPath A folder or file path to pass as an argument when launching the editor.
	* @param editor The external editor to launch.
	*/
	export async function launchExternalEditor(
	fullPath: string,
	editor: FoundEditor
	): Promise<void> {

[roottool]

I think that this issue needs to be considered about a pattern that .code-workspace file exists more than one in the root.

I have an one question.
Does Github Desktop the app open all .code-workspace file?

[shiftkey]

Does Github Desktop the app open all .code-workspace file?

Not currently

[samundra]

Hi @shiftkey

I was exploring code for this feature and able to get this working if we use file with code-workspace in fullPath

export async function launchExternalEditor(
  fullPath: string,
  editor: FoundEditor
): Promise<void> {
  ...
  ...
  if (editor.editor === 'Visual Studio Code') {
    readdir(fullPath, (err, files) => {
      if (err) {
        return console.log('Unable to scan directory: ' + err)
      }
      files.forEach(f => {
        if (f.endsWith('code-workspace')) {
          fullPath = Path.join(fullPath, f)
        }
      })
    })
  }

Current problem, I have is fullPath doesn't seem to change after readdir has finished doing it's job. How can I get that fullPath outside of callback so that it can be used in

if (editor.usesShell) {
    spawn(`"${editorPath}"`, [`"${fullPath}"`], { shell: true })
  } else {
    spawn(editorPath, [fullPath])
  }

[Soitora]

How's this come along?

[curtcurt871]

https://github.com/desktop/desktop/projects/8#card-18583843

[Lol702702]

Problem When I open a repo in Github Desktop the app suggests to open the repo in Visual Studio Code. That's great, but instead of opening the root folder I would like it to open .code (workspace) file when it is available in the root. Either per default or via a setting.

Thanks for a great product!

[silopolis]

For those desperately hoping for this to be implemented, I found myself an alternative solution, using the wottpal/vscode-auto-open-workspace extension.
It actually starts by launching VSCode and immediately reloads the workspace, but that does the trick :)
See settings for other possible behaviors.

PS: There is also haifengkao/AlwaysOpenWorkspace which I haven't tested…