Skip to content

Setup.md

Latest commit

 

History

History
67 lines (50 loc) · 4.44 KB

Setup.md

File metadata and controls

67 lines (50 loc) · 4.44 KB
Raw

Development setup

Requirements

  • .NET 10 SDK to build and test the shared engine and CLI.
  • .NET 10 runtime to use the VS Code extension or global tool.
  • Node.js 22 or later and npm to build, test, and package the VS Code extension.
  • VS Code 1.100 or later for extension development and host integration.

Restore and build

From the repository root:

dotnet restore NuGetPackageManager.slnx
dotnet build NuGetPackageManager.slnx --configuration Release
dotnet test NuGetPackageManager.slnx --configuration Release
npm ci
npm run check

Open the repository in VS Code and press F5 to launch the Extension Development Host. Open NuGet: Open Package Workbench against a file-backed workspace. The VS Code host invokes the bundled .NET tool assembly using a JSON bridge; it does not install packages or restore the target solution during activation. Install the .NET 10 runtime on the extension host machine and use the actionable startup error if it cannot be found.

Command-line tool

After the NuGet package is published, install the global tool with:

dotnet tool install --global nuget-manager

Use nuget-manager check for a read-only scan and feed check. Use nuget-manager update to review and update packages interactively. Family selection is available in either command. For example:

nuget-manager update --family Microsoft.Orleans --policy minor

The supported options are:

Option Purpose
--family <prefix> Select a first-segment family or narrower dotted package ID prefix
--policy <value> (latest, minor, or patch) Select any newer version, remain within the current major, or remain within the current minor
--prerelease Include prerelease versions
--source <NuGet V3 index> Add a NuGet V3 source for the version check
--path <workspace> Select the workspace path
--dry-run Review proposed edits without writing files
--json Emit machine-readable output
--yes Apply selected updates in noninteractive mode; use only when you intend to write files

See nuget-manager --help for the installed tool's current usage. Version 0.1.1 is published on NuGet.org and verified by a fresh install and live-feed family update. A local build or packed tool alone is insufficient publication evidence.

UI preview and npm scripts

For the standalone UI preview, run npm run preview and open the local URL printed in the terminal. The preview emulates VS Code's injected webview defaults and theme tokens. Pass query parameters to inspect layout and state: theme=light-plus|light-modern|dark-modern|hc-black for light/dark/high-contrast themes, surface=sidebar|editor for layout, and scenario=checking|unchecked|untrusted|nofolder|empty for package states. The simulated host does not read or write workspace files; it is for illustrative inspection only.

Command Purpose
npm run typecheck TypeScript analysis without emitting files
npm test Extension core tests
npm run test:host VS Code extension-host integration tests
npm run check Type check, core tests, and build
npm run format Format repository files
npm run format:check Check formatting without edits
npm run coverage Measure extension core-test coverage
npm run package Create a VSIX under artifacts/
npm run preview Launch the illustrative browser UI preview