-
-
Notifications
You must be signed in to change notification settings - Fork 399
fix: link aliased dependencies to their real package #2214
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.
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
Closed
thegreatalxx
wants to merge
4
commits into
npmx-dev:main
from
thegreatalxx:fix/aliased-dependency-links
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
bd33d4a
fix: link aliased dependencies to their real package (#2010)
thegreatalxx 6ad2761
refactor: extract parseNpmAlias to app/utils/npm/alias.ts
thegreatalxx 4a0ff37
test: add parseNpmAlias unit tests
thegreatalxx 96f2bbd
[autofix.ci] apply automated fixes
autofix-ci[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| /** | ||
| * Parses npm alias syntax: "npm:real-pkg@^1.0.0" | ||
| * Returns { name, range } for the real package, or null if not an alias. | ||
| * | ||
| * @example | ||
| * parseNpmAlias('npm:real-pkg@^1.0.0') // { name: 'real-pkg', range: '^1.0.0' } | ||
| * parseNpmAlias('npm:@scope/pkg@^1.0.0') // { name: '@scope/pkg', range: '^1.0.0' } | ||
| * parseNpmAlias('npm:real-pkg') // { name: 'real-pkg', range: '' } | ||
| * parseNpmAlias('^1.0.0') // null | ||
| */ | ||
| export function parseNpmAlias(version: string): { name: string; range: string } | null { | ||
| if (!version.startsWith('npm:')) return null | ||
| const spec = version.slice(4) // strip 'npm:' | ||
| // Handle scoped packages like @scope/pkg@1.0.0 — find @ after position 0 | ||
| const atIdx = spec.startsWith('@') ? spec.indexOf('@', 1) : spec.indexOf('@') | ||
| if (atIdx === -1) return { name: spec, range: '' } | ||
| return { name: spec.slice(0, atIdx), range: spec.slice(atIdx + 1) } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| import { describe, expect, it } from 'vitest' | ||
| import { parseNpmAlias } from '~/utils/npm/alias' | ||
|
|
||
| describe('parseNpmAlias', () => { | ||
| it('returns null for a regular semver range (not an alias)', () => { | ||
| expect(parseNpmAlias('^1.0.0')).toBeNull() | ||
| }) | ||
|
|
||
| it('returns null for an empty string', () => { | ||
| expect(parseNpmAlias('')).toBeNull() | ||
| }) | ||
|
|
||
| it('returns null for a plain version number', () => { | ||
| expect(parseNpmAlias('1.2.3')).toBeNull() | ||
| }) | ||
|
|
||
| it('returns null for a workspace protocol', () => { | ||
| expect(parseNpmAlias('workspace:*')).toBeNull() | ||
| }) | ||
|
|
||
| it('parses a simple alias with version range', () => { | ||
| expect(parseNpmAlias('npm:real-pkg@^1.0.0')).toEqual({ | ||
| name: 'real-pkg', | ||
| range: '^1.0.0', | ||
| }) | ||
| }) | ||
|
|
||
| it('parses a scoped package alias', () => { | ||
| expect(parseNpmAlias('npm:@scope/pkg@^1.0.0')).toEqual({ | ||
| name: '@scope/pkg', | ||
| range: '^1.0.0', | ||
| }) | ||
| }) | ||
|
|
||
| it('parses an alias without a version range', () => { | ||
| expect(parseNpmAlias('npm:real-pkg')).toEqual({ | ||
| name: 'real-pkg', | ||
| range: '', | ||
| }) | ||
| }) | ||
|
|
||
| it('parses an alias with an exact version', () => { | ||
| expect(parseNpmAlias('npm:real-pkg@2.0.0')).toEqual({ | ||
| name: 'real-pkg', | ||
| range: '2.0.0', | ||
| }) | ||
| }) | ||
|
|
||
| it('parses a scoped package alias without version', () => { | ||
| expect(parseNpmAlias('npm:@scope/pkg')).toEqual({ | ||
| name: '@scope/pkg', | ||
| range: '', | ||
| }) | ||
| }) | ||
|
|
||
| it('strips the npm: prefix correctly', () => { | ||
| const result = parseNpmAlias('npm:lodash@^4.0.0') | ||
| expect(result).not.toBeNull() | ||
| expect(result!.name).toBe('lodash') | ||
| expect(result!.name).not.toContain('npm:') | ||
| }) | ||
| }) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Return
nullfor empty alias targets.npm:currently parses to{ name: '', range: '' }, which would send callers such asDependencies.vuedown the alias path with an empty package name instead of letting them fall back cleanly. Please treat blank specs as invalid and add a regression case for it.🩹 Suggested guard
export function parseNpmAlias(version: string): { name: string; range: string } | null { if (!version.startsWith('npm:')) return null const spec = version.slice(4) // strip 'npm:' + if (!spec.trim()) return null // Handle scoped packages like `@scope/pkg`@1.0.0 — find @ after position 0 const atIdx = spec.startsWith('@') ? spec.indexOf('@', 1) : spec.indexOf('@') if (atIdx === -1) return { name: spec, range: '' } return { name: spec.slice(0, atIdx), range: spec.slice(atIdx + 1) } }📝 Committable suggestion