Vsix packaging#77
Merged
Merged
Conversation
- package.json: add publisher (ismrmrd), license (MIT), and repository for vsce packaging - .vscodeignore: exclude compiled tests (out/test) and package-lock from the VSIX - add LICENSE to the extension so it ships in the package - README: replace scaffold template with real MRD Viz description/settings (required by vsce) - docs: add PACKAGING_AND_INSTALL_RUNBOOK.md walking through dry-run, package, and local install; verified vsce package -> mrd-viz-0.0.1.vsix installs as ismrmrd.mrd-viz@0.0.1
vsce does not require a LICENSE file (only warns). The repo-root MIT LICENSE covers mrd-viz, and package.json already declares the MIT license field, so the per-extension copy was redundant. Updated the packaging runbook expected output (11 files, harmless LICENSE warning).
yuliadub
reviewed
Jul 9, 2026
Inline steps 1-3 of the dev runbook (venv + editable install + verify), and document setting mrdViz.pythonPath to the venv interpreter for an installed VSIX. Note the python-vs-python3 PATH gotcha (bare 'python' fallback fails when only python3 is present); setting mrdViz.pythonPath avoids it. Corrects prior wording that implied the .venv auto-fallback works for installed extensions (it only works in the F5 dev host).
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
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.
VSIX local install is the intermediate step, installing hte extension into the uesr's normal VS Code so that it persists and works in every window.
docs/PACKAGING_AND_INSTALL_RUNBOOK.mdoutlines the steps walking through prereqs, dry run, package, local install, update/uninstall.Rendering still requires the mrd_viz python backend on the machine (mrdviz.pythonpath or venv fallback), so on a fresh machine it will hit an error editor. distributing backend remains in-progress.
currently ismrmrd publisher is a placeholder to statisfy local packaging, but an eventual marketplace publish would require a registered publisher ID.
most of the changes are simply packacing setup to satisfy vsce requirements.