Skip to content

NpmDsc: Refactor Set operation #250

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

Closed
guillermooo wants to merge 5 commits into from
Closed

NpmDsc: Refactor Set operation #250

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
625f9a2
NpmDsc: Avoid `Set` false positives with `owner/repo` packages
guillermooo Mar 8, 2026
970ea89
Simplify
guillermooo Mar 8, 2026
84bc739
Splat arguments
guillermooo Mar 8, 2026
07ea260
Refactor to reduce indentation
guillermooo Mar 8, 2026
caf7803
Refactor
guillermooo Mar 8, 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
30 changes: 23 additions & 7 deletions resources/NpmDsc/NpmDsc.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,15 +340,31 @@
}

[void] Set() {
$inDesiredState = $this.Test()
if ($this.Test()) {
return
}

$installParams = @{
PackageName = $this.Name
Arguments = $this.Arguments
Global = $this.Global
}

if ($this.Ensure -eq [Ensure]::Present) {
if (-not $inDesiredState) {
Install-NpmPackage -PackageName $this.Name -Arguments $this.Arguments -Global $this.Global
}
[NpmPackage]::EnsureValidPackageName($this.Name)
Install-NpmPackage @installParams
} else {
if (-not $inDesiredState) {
Uninstall-NpmPackage -PackageName $this.Name -Arguments $this.Arguments -Global $this.Global
}
Uninstall-NpmPackage @installParams
}
}

hidden static [void] EnsureValidPackageName($name) {
# TODO: Handling owner/repo package references pointing to GH repositories requires accounting
# for git errors (missing git, failed authentication, etc.).
#
# See: https://docs.npmjs.com/cli/v11/commands/npm-install#description

Check warning on line 365 in resources/NpmDsc/NpmDsc.psm1

View workflow job for this annotation

GitHub Actions / Check Spelling 

`npmjs` is not a recognized word. (unrecognized-spelling)
if (($name -notmatch '^git(?:\+(?:ssh|https?|file))?://') -and $name.Contains('/') -and -not $name.StartsWith('@')) {
throw "The Set operation currently only supports packages specified as [<@scope>/]<name>. The given package looks like a GitHub repository: $($name)."
}
}

Expand Down
Loading