Skip to content

feat(docs): add vscode extension docs#979

Open
nitodeco wants to merge 1 commit intonpmx-dev:mainfrom
nitodeco:feat/document-vscode-extension
Open

feat(docs): add vscode extension docs#979
nitodeco wants to merge 1 commit intonpmx-dev:mainfrom
nitodeco:feat/document-vscode-extension

Conversation

@nitodeco
Copy link
Contributor

@nitodeco nitodeco commented Feb 5, 2026

To get the word out about the vs-code extension, the npmx docs should have a section about them. Eventually the extension docs should probably live in the npmx docs entirely, although right now I think its better to keep the repo as the source of truth to avoid PR spam here while the extension evolves.

Also, we've gotten a request to support the extension in Cursor: npmx-dev/vscode-npmx#26. Cursor requires a link to the extension on an official project page, otherwise it won't be reviewed and made available in extension search.

Screenshots image image

@vercel
Copy link

vercel bot commented Feb 5, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs.npmx.dev Error Error Feb 5, 2026 1:10am
npmx.dev Ready Ready Preview, Comment Feb 5, 2026 1:10am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
npmx-lunaria Ignored Ignored Feb 5, 2026 1:10am

Request Review

@nitodeco nitodeco force-pushed the feat/document-vscode-extension branch from 2ae0b82 to 52cada0 Compare February 5, 2026 01:08
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 5, 2026

📝 Walkthrough

Walkthrough

A new documentation page was added at docs/content/2.guide/4.vscode-extension.md describing the npmx VS Code extension. It documents installation (Marketplace/Open VSX or code --install-extension), features (hover information with provenance status, version completion with provenance filtering, diagnostics for deprecated packages, module replacements and vulnerabilities), supported files (package.json and pnpm-workspace.yaml) and links to the GitHub repository for full configuration and usage. The change adds 32 lines.

🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
Description check ✅ Passed The pull request description clearly relates to the changeset, explaining the purpose of adding VS Code extension documentation to promote the npmx extension and meet Cursor requirements.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (1)
docs/content/2.guide/4.vscode-extension.md (1)

32-32: Consider using British English phrasing.

In British English, "have a look" is more commonly used than "take a look". As per coding guidelines, the review language is set to en-GB.

✍️ Suggested British English phrasing
-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>.
+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>.


## 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

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)

@codecov
Copy link

codecov bot commented Feb 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant