Title: A PowerShell workspace dependency module manifest · Issue #14077 · PowerShell/PowerShell · GitHub
Open Graph Title: A PowerShell workspace dependency module manifest · Issue #14077 · PowerShell/PowerShell
X Title: A PowerShell workspace dependency module manifest · Issue #14077 · PowerShell/PowerShell
Description: Summary of the new feature/enhancement PowerShell comes with native support for build modules using the New-ModuleManifest cmdlet, but doesn't necessarily come with the ability to describe a runtime's dependencies outside of a module. Ju...
Open Graph Description: Summary of the new feature/enhancement PowerShell comes with native support for build modules using the New-ModuleManifest cmdlet, but doesn't necessarily come with the ability to describe a runtim...
X Description: Summary of the new feature/enhancement PowerShell comes with native support for build modules using the New-ModuleManifest cmdlet, but doesn't necessarily come with the ability to describe a ru...
Opengraph URL: https://github.com/PowerShell/PowerShell/issues/14077
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"A PowerShell workspace dependency module manifest","articleBody":"## Summary of the new feature/enhancement\r\n\r\nPowerShell comes with native support for build modules using the `New-ModuleManifest` cmdlet, but doesn't necessarily come with the ability to describe a runtime's dependencies outside of a module. Just like Node runtime project's can use a `package.json` to describe the dependencies it has on npm libraries or .NET can use `.csproj` files to reference NuGet package (e.g. The runtime takes a dep. on a library which might also take dep. on more libraries creating a dep. graph), Nothing stops a runtime from wanting to take a dep. on a PowerShell module.\r\n\r\nUse cases:\r\n\r\nSimple use case - I want to share a `.ps1` file with a colleague that deps. on 5 other modules without have to go through the process to build my own module and export functions, etc. Today my colleague would need to have those 5 modules installed and imported on their device for my `ps1` file to run correctly. Sure you could just add the `Install-Module` cmdlet directly in the ps1, but it feels better to separate the concerns of my application code and my dependencies and have a more declarative approach to an infrastructural problem.\r\n\r\nA complex use case - A Node project that that uses `node-pty` to spawn `pwsh` processes that run arbitrary PowerShell. A dockerfile is used to run `Install-Module` across a plethora of modules needed. Then after forking the `pwsh` process, it needs to import those same modules to perform it's duties. There does not seem to be a good way (that I have found at least) to document this kind of manifest and have it used to generate a valid runtime environment. Currently, if my process requires 25 modules to run, I need to explicitly install and import each one.\r\n\r\n## Proposed technical implementation details (optional)\r\n\r\nTo model it after the already tried and tested solutions that .NET and npm have used, I think introducing a `modules.json` file that describes the modules and their required versions via semantic versioning (Similar to how npm does [here](https://docs.npmjs.com/cli/v6/using-npm/semver)) is an acceptable approach. Once that file is created and your dependencies are described in the manifest, you could run `Install-Module` with no arguments and it would simply look for a `modules.json` file in your folder (and possibly the ancestors) and use that file to both Install and potentially Import modules in bulk.\r\n\r\nWith this change, you would no longer have to rely on a PowerShell profile to perform \"automatic\" loading of modules as it would be at a project (folder) level and not confined to the scope of a \"user\" on a device. This makes powershell projects and libraries more portable when the consuming technology is not a PS module itself as in the case of my Node use case above or even just a vanilla .ps1 file you wanted to shared with a co-worker via git.\r\n\r\nOne caveat to this all would be that where npm and NuGet package management involves adding the packages into the workspace where they can be gitignored and discarded between builds with a `git clean`, `Install-Module` currently only installs in a global location to the device which means you mutate the device's state and have no good way of \"cleaning up\" afterwards like you would with a `bin` or `node_modules` folder.","author":{"url":"https://github.com/mhintzke","@type":"Person","name":"mhintzke"},"datePublished":"2020-11-13T00:53:32Z","url":"https://github.com/PowerShell/PowerShell/issues/14077"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:55fd7137-a3b6-80fe-c609-ca03d9ce77b3 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 97A0:F14FA:3D81A:59081:6AFD58C3 |
| html-safe-nonce | 09d26d6d0f10af037385daeab60d63c79de43d2bc07f1c7ee314be843f91bc74 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5N0EwOkYxNEZBOjNEODFBOjU5MDgxOjZBRkQ1OEMzIiwidmlzaXRvcl9pZCI6IjU2MjE3NjM3NTQ0NDcxNjU2MzUiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 2cea8415a6d10194b6a802b1aeb9e8196fbf80614ca79ef2a461e616deca7cf8 |
| hovercard-subject-tag | issue:742038119 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/PowerShell/PowerShell/14077/issue_layout |
| twitter:image | https://opengraph.githubassets.com/82853ba63e176e2c9c3cb3d1935cce2eef671e233020767af1012082df8d7e28/PowerShell/PowerShell/issues/14077 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/82853ba63e176e2c9c3cb3d1935cce2eef671e233020767af1012082df8d7e28/PowerShell/PowerShell/issues/14077 |
| og:image:alt | Summary of the new feature/enhancement PowerShell comes with native support for build modules using the New-ModuleManifest cmdlet, but doesn't necessarily come with the ability to describe a runtim... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | mhintzke |
| hostname | github.com |
| expected-hostname | github.com |
| None | 66653c2e55a6fff2930be1bdf07ee4f8aa137e3956d056c822563be6f878755e |
| turbo-cache-control | no-preview |
| go-import | github.com/PowerShell/PowerShell git https://github.com/PowerShell/PowerShell.git |
| octolytics-dimension-user_id | 11524380 |
| octolytics-dimension-user_login | PowerShell |
| octolytics-dimension-repository_id | 49609581 |
| octolytics-dimension-repository_nwo | PowerShell/PowerShell |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 49609581 |
| octolytics-dimension-repository_network_root_nwo | PowerShell/PowerShell |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | b6f01f7cb9f35f8c09949773241a3d49dd04b340 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width