Skip to content

feat: exclude deprecated and prerelease versions from completion + add config #27

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
9romise merged 5 commits into from
Feb 5, 2026
Merged

feat: exclude deprecated and prerelease versions from completion + add config #27

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f2d45c3
feat: exclude deprecated versions from autocomplete
nitodeco Feb 5, 2026
3a72862
feat: add config to show prerelease versions
nitodeco Feb 5, 2026
b89f592
refactor: inverse prerelease completion flag
nitodeco Feb 5, 2026
892e0a2
fix: test prerelease pattern on correct version
nitodeco Feb 5, 2026
2eabca6
refactor: use more permissive prerelease pattern
nitodeco Feb 5, 2026
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
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,14 @@

<!-- configs -->

| Key | Description | Type | Default |
| -------------------------------- | ----------------------------------------------------- | --------- | ------------------- |
| `npmx.hover.enabled` | Enable hover information for packages | `boolean` | `true` |
| `npmx.completion.version` | Version completion behavior | `string` | `"provenance-only"` |
| `npmx.diagnostics.deprecation` | Show warnings for deprecated packages | `boolean` | `true` |
| `npmx.diagnostics.replacement` | Show suggestions for package replacements | `boolean` | `true` |
| `npmx.diagnostics.vulnerability` | Show warnings for packages with known vulnerabilities | `boolean` | `true` |
| Key | Description | Type | Default |
| ----------------------------------- | --------------------------------------------------------------------------------- | --------- | ------------------- |
| `npmx.hover.enabled` | Enable hover information for packages | `boolean` | `true` |
| `npmx.completion.version` | Version completion behavior | `string` | `"provenance-only"` |
| `npmx.completion.excludePrerelease` | Exclude prerelease versions (alpha, beta, rc, canary) from completion suggestions | `boolean` | `true` |
| `npmx.diagnostics.deprecation` | Show warnings for deprecated packages | `boolean` | `true` |
| `npmx.diagnostics.replacement` | Show suggestions for package replacements | `boolean` | `true` |
| `npmx.diagnostics.vulnerability` | Show warnings for packages with known vulnerabilities | `boolean` | `true` |

<!-- configs -->

Expand Down
11 changes: 10 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,11 @@
},
"npmx.completion.version": {
"type": "string",
"enum": ["all", "provenance-only", "off"],
"enum": [
"all",
"provenance-only",
"off"
],
"enumDescriptions": [
"Show all versions",
"Show only versions with provenance",
Expand All @@ -60,6 +64,11 @@
"default": "provenance-only",
"description": "Version completion behavior"
},
"npmx.completion.excludePrerelease": {
"type": "boolean",
"default": true,
"description": "Exclude prerelease versions (alpha, beta, rc, canary) from completion suggestions"
},
"npmx.diagnostics.deprecation": {
"type": "boolean",
"default": true,
Expand Down
1 change: 1 addition & 0 deletions src/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export const PACKAGE_JSON_PATTERN = `**/${PACKAGE_JSON_BASENAME}`
export const PNPM_WORKSPACE_PATTERN = `**/${PNPM_WORKSPACE_BASENAME}`

export const VERSION_TRIGGER_CHARACTERS = [':', '^', '~', '.', ...Array.from({ length: 10 }).map((_, i) => `${i}`)]
export const PRERELEASE_PATTERN = /-(?:alpha|beta|rc|canary)/i

@RYGRIT RYGRIT Feb 5, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The PRERELEASE_PATTERN seems a bit too restrictive.

Using a whitelist (alpha|beta|rc|canary) will miss many common prerelease tags, such as next (e.g., vue@next), dev, or nightly.

Suggestion: Since SemVer defines a prerelease as anything following a hyphen, a generic regex would be safer:

// Matches any version containing a hyphen
export const PRERELEASE_PATTERN = /-.+/;

(Or use semver.prerelease() if the package is available.)


export const CACHE_TTL_ONE_DAY = 1000 * 60 * 60 * 24

Expand Down
7 changes: 7 additions & 0 deletions src/providers/completion-item/version.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { Extractor } from '#types/extractor'
import type { CompletionItemProvider, Position, TextDocument } from 'vscode'
import { PRERELEASE_PATTERN } from '#constants'
import { config } from '#state'
import { getPackageInfo } from '#utils/api/package'
import { formatVersion, parseVersion } from '#utils/package'
Expand Down Expand Up @@ -41,6 +42,12 @@ export class VersionCompletionItemProvider<T extends Extractor> implements Compl
for (const semver in pkg.versionsMeta) {
const meta = pkg.versionsMeta[semver]

if (meta.deprecated != null)
continue

if (config.completion.excludePrerelease && PRERELEASE_PATTERN.test(version))
continue
Comment thread
nitodeco marked this conversation as resolved.

if (config.completion.version === 'provenance-only' && !meta.provenance)
continue

Expand Down