Skip to content

feat(docs): add vscode extension docs #979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danielroe merged 1 commit into from
Feb 5, 2026
+32 −0
Merged

feat(docs): add vscode extension docs #979

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/content/2.guide/4.vscode-extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: VS Code Extension
description: The npmx VS Code extension brings npmx.dev insights into your editor.
navigation:
icon: i-simple-icons-visualstudiocode
---

## Installation

Install from the <a href="https://marketplace.visualstudio.com/items?itemName=npmx-dev.vscode-npmx" target="_blank" rel="noopener noreferrer">VS Code Marketplace</a>, the <a href="https://open-vsx.org/extension/npmx-dev/vscode-npmx" target="_blank" rel="noopener noreferrer">Open VSX Registry</a> or run:

```bash
code --install-extension npmx-dev.vscode-npmx
```

## Features

- **Hover Information** - Quick links to <a href="https://npmx.dev" target="_blank" rel="noopener noreferrer">npmx.dev</a> for package info and documentation, with provenance verification status
- **Version Completion** - Autocomplete package versions with provenance filtering support
- **Diagnostics**
- Deprecated package warnings
- Package replacement suggestions (via <a href="https://github.com/es-tooling/module-replacements" target="_blank" rel="noopener noreferrer">module-replacements</a>)
- Vulnerability detection

## Supported Files

- `package.json`
- `pnpm-workspace.yaml`

## Configuration

For full configuration options and detailed usage, take a look at the <a href="https://github.com/npmx-dev/vscode-npmx#readme" target="_blank" rel="noopener noreferrer">GitHub repository</a>.
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

curl -s -o /dev/null -w "%{http_code}" "https://github.com/npmx-dev/vscode-npmx"

Repository: npmx-dev/npmx.dev

Length of output: 64

Update language to British English.

Change "take a look" to "have a look" to align with en-GB conventions.

For full configuration options and detailed usage, have a look at the <a href="https://github.com/npmx-dev/vscode-npmx#readme" target="_blank" rel="noopener noreferrer">GitHub repository</a>.
🧰 Tools
🪛 LanguageTool

[locale-violation] ~32-~32: In British English, “have a look” is more commonly used.
Context: ...nfiguration options and detailed usage, take a look at the <a href="https://github.com/npmx...

(TAKE_A_LOOK)

Loading