Skip to content

Add @vscode/python-environments npm package#1317

Merged
StellaHuang95 merged 5 commits intomicrosoft:mainfrom
StellaHuang95:npm
Mar 5, 2026
Merged

Add @vscode/python-environments npm package#1317
StellaHuang95 merged 5 commits intomicrosoft:mainfrom
StellaHuang95:npm

Conversation

@StellaHuang95
Copy link
Contributor

Our team owns multiple VS Code extensions consuming the Python Environments API. Rather than each extension maintaining its own local copy of the type definitions, which leads to duplication, version drift, and silent breakage, this PR publishes the API as @vscode/python-environments on npm, matching the pattern already established by @vscode/python-extension.

The PR includes following changes:

  1. The pythonEnvironmentsApi self-contained npm package contains:

src/main.ts: public API types + PythonEnvironments.api() helper
package.json, tsconfig.json, .npmignore, README.md, LICENSE.md, SECURITY.md,
basically the same structure as the VS Code Python Extension.

  1. The CI pipeline azure-pipeline.npm.yml + test/pack templates, use microsoft/vscode-engineering shared npm-package template. Tests on Linux/macOS/Windows. Publish gated behind manual parameter (default: off).

Next steps:

  • Register pipeline in Azure DevOps
  • Dry-run pipeline (publishPythonEnvsApi: false) and verify everything is working as expected.

@StellaHuang95
Copy link
Contributor Author

FYI, @edvilme

@StellaHuang95 StellaHuang95 added the feature-request Request for new features or functionality label Mar 4, 2026
@StellaHuang95 StellaHuang95 merged commit d747327 into microsoft:main Mar 5, 2026
43 of 44 checks passed
@StellaHuang95 StellaHuang95 deleted the npm branch March 5, 2026 22:31
@StellaHuang95
Copy link
Contributor Author

Merging the PR to add the pipeline to AZDO for testing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature-request Request for new features or functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants