Skip to content

Commit ed7f8bf

Browse files
committed
docs: update
1 parent 160cfc9 commit ed7f8bf

2 files changed

Lines changed: 37 additions & 9 deletions

File tree

CONTRIBUTING.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ pnpm build # Production build
6868
pnpm package # Save extension as vsix file to root
6969

7070
# Code Quality
71-
pnpm lint # Run linter (oxlint + oxfmt)
71+
pnpm lint # Run linter (ESLint)
7272
pnpm lint:fix # Auto-fix lint issues
73-
pnpm typecheck # TypeScript type checking
73+
pnpm typecheck # TypeScript type checking (tsgo)
7474

7575
# Testing
7676
pnpm test # Run tests
@@ -82,14 +82,26 @@ pnpm test # Run tests
8282
playground/ # Playground for testing
8383
res/ # Assets (e.g. marketplace icon)
8484
src/ # Extension source code
85-
├── extractors/ # Extractors
85+
├── commands/ # Command handlers (vscode API only, no reactive-vscode)
86+
├── extractors/ # Extractors (package.json, pnpm-workspace.yaml)
8687
├── providers/ # Providers
88+
│ ├── code-actions/ # Code action providers (quick fixes)
89+
│ ├── completion-item/ # Completion providers (version autocomplete)
90+
│ ├── diagnostics/ # Diagnostic providers
91+
│ ├── document-link/ # Document link providers (package links)
92+
│ └── hover/ # Hover providers
8793
├── types/ # TypeScript types
8894
├── utils/ # Utility functions
95+
│ └── api/ # API clients (package, replacement, vulnerability)
8996
├── constants.ts # Constants
97+
├── generated-meta.ts # Auto-generated extension metadata
9098
├── state.ts # State management
9199
└── index.ts # Extension entry point
92100
tests/ # Tests
101+
├── __setup__/ # Test setup and utilities
102+
├── code-actions/ # Code action tests
103+
├── diagnostics/ # Diagnostic tests
104+
└── utils/ # Utility tests
93105
```
94106

95107
## Code style
@@ -110,7 +122,7 @@ If you want to get ahead of any formatting issues, you can also run `pnpm lint:f
110122
> This will be fixed by eslint.
111123
112124
1. Type imports first (`import type { ... }`)
113-
2. Internal aliases (`#constants`, `#utils/`, etc.)
125+
2. Internal aliases (`#constants`, `#utils/`, `#composables/`, etc.)
114126
3. External packages (including `node:`)
115127
4. Relative imports (`./`, `../`)
116128
5. No blank lines between groups

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@
1414
> [!NOTE]
1515
> 🚧 **Preview Version** - This extension is under active development. Some features and configurations may change.
1616
17+
## Installation
18+
19+
- [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=npmx-dev.vscode-npmx)
20+
- [Open VSX](https://open-vsx.org/extension/npmx-dev/vscode-npmx)
21+
- Run:
22+
```bash
23+
code --install-extension npmx-dev.vscode-npmx
24+
```
25+
1726
## Features
1827

1928
- **Hover Information** – Quick links to package details and documentation on [npmx.dev](https://npmx.dev), with provenance verification status.
@@ -25,15 +34,22 @@
2534
- Dist tag warnings when a dependency uses a mutable version tag instead of a pinned version
2635
- Engine mismatch warnings when dependency engine requirements conflict with the current package
2736
- Upgrade hints when a newer version is available
37+
- **Code Actions**
38+
- Quick fix actions for diagnostics with ignore list support (workspace or user settings)
2839
- **Commands**
2940
- Open [npmx.dev](https://npmx.dev) in external browser
30-
- Open `node_modules` files on [npmx.dev](https://npmx.dev) code viewer with syntax highlighting (from editor title, explorer context menu, or command palette)
41+
- Open `node_modules` files on [npmx.dev](https://npmx.dev) code viewer with syntax highlighting (from editor title, editor context menu, explorer context menu, or command palette)
42+
43+
## Commands
44+
45+
<!-- commands -->
3146

32-
## Supported Files
47+
| Command | Title |
48+
| --------------------- | --------------------------------------- |
49+
| `npmx.openInBrowser` | npmx: Open npmx.dev in external browser |
50+
| `npmx.openFileInNpmx` | npmx: Open file on npmx.dev |
3351

34-
- `package.json`
35-
- `pnpm-workspace.yaml`
36-
- `.yarnrc.yml`
52+
<!-- commands -->
3753

3854
## Configuration
3955

0 commit comments

Comments
 (0)