Add support for workspace profiles

[daviwil]

It'd be nice if we provided a way for the user to configure a startup script which gets run when VS Code opens their project folder. This would allow them to configure their session for the project they're developing without having to add anything extra to their profile. This would also allow registration of project-specific editor commands using the $psEditor API.

[daviwil]

After thinking about this a bit, it seems like the most obvious way to approach this is to define the concept of a "workspace profile" that gets loaded in addition to the VS Code host profiles. When the user loads a folder in VS Code, we'll look for a file called .profile.ps1 (or better suggestion) in the root of the workspace path and then load that along with the other host profiles.

This will be useful when a project has certain modules it needs to load when the user loads up the project. This could also be useful to other editors so I won't be making it editor-specific (not placing the profile in the .vscode subfolder).

Thoughts? @rkeithhill

[PowerSchill]

I really like that idea. Would make development of modules and such much easier especially if I need to override installed modules with development versions.

[rkeithhill]

I like the idea. Do you want to load that file by a "conventional" name like .profile.ps1 or indirectly via a setting that defaults to ${workspaceRoot}/.profile.ps1. Not sure it's worth the extra level of indirection and there is some value in always being able to identify this file. And the extra level of indirection is something that could be added later if we find it is needed.

[dragonwolf83]

If it is going to be editor agnostic, it would make sense to continue the pattern to have a generic Workspace profile and a Host/Editor specific profile that can be used.

WorkspaceAllHosts    : {WorkspaceRoot}\Workspace.profile.ps1
WorkspaceCurrentHost : {WorkspaceRoot}\Workspace.VSCode_profile.ps1

WorkspaceAllHosts would work well to cover the module loading scenarios since most of them shouldn't care about the Host to run.

WorkspaceCurrentHost would cover the $psEditor commands that might be specific to an Editor that you wouldn't want to load up in another one.

[mattmcnabb]

Like the idea, but not sure about using a generic file name like profile.ps1. I can imagine someone loading a project with a file named that and inadvertently running some code they didn't intend to. A safer way would be to include this in the .vscode folder, but i know you plan to leave this open for other editors. What if we had a project-level setting in there that would contain the path to the project profile script? That way you could choose to store it in the workspace root or any where else, and name it whatever you like.

[PowerSchill]

@dragonwolf83 Considering that this setting would only be in VSCode I don't think you would need multiple values. For Example in Sublime Text you would need something to be stored in their project file.

[PowerSchill]

I can see @mattmcnabb point. My PowerShell profile is a project so if I were using that workspace it would run every time. Let me offer a suggestion of the default profile to be workspace_profile.ps1. I think that would greatly reduce the conflict possibilities.

By default the workspace profile would be {WorkspaceRoot}\workspace_profile.ps1 but could be overriden in the project settings.