Downloads:

10,204

Downloads of v 1.1.0:

3,129

Last Update:

05 Aug 2022

Package Maintainer(s):

Software Author(s):

  • BBT Software AG

Tags:

chocolatey extension npm admin

Chocolatey NPM servicing extension

  • 1
  • 2
  • 3

1.1.0 | Updated: 05 Aug 2022

Downloads:

10,204

Downloads of v 1.1.0:

3,129

Software Author(s):

  • BBT Software AG

  • 1
  • 2
  • 3
Chocolatey NPM servicing extension 1.1.0

  • 1
  • 2
  • 3

All Checks are Passing

3 Passing Tests


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Successful:

No detections found in any package files

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install Chocolatey NPM servicing extension, run the following command from the command line or from PowerShell:

>

To upgrade Chocolatey NPM servicing extension, run the following command from the command line or from PowerShell:

>

To uninstall Chocolatey NPM servicing extension, run the following command from the command line or from PowerShell:

>

Deployment Method:

📝 NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade chocolatey-npm.extension -y --source="'INTERNAL REPO URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade chocolatey-npm.extension -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install chocolatey-npm.extension
  win_chocolatey:
    name: chocolatey-npm.extension
    version: '1.1.0'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'chocolatey-npm.extension' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '1.1.0'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller chocolatey-npm.extension
{
    Name     = "chocolatey-npm.extension"
    Version  = "1.1.0"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'chocolatey-npm.extension':
  ensure   => '1.1.0',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved by moderator TheCakeIsNaOH on 10 Aug 2022.

Description

This package provides helper functions useful for developing packages for installing NPM packages.
These functions may be used in Chocolatey install/uninstall scripts by declaring this package a dependency in your package's nuspec.


extensions\chocolatey-npm.psm1
# Export functions that start with capital letter, others are private
# Include file names that start with capital letters, ignore others
$ScriptRoot = Split-Path $MyInvocation.MyCommand.Definition

$pre = Get-ChildItem Function:\*
Get-ChildItem "$ScriptRoot\*.ps1" | Where-Object { $_.Name -cmatch '^[A-Z]+' } | ForEach-Object { . $_  }
$post = Get-ChildItem Function:\*
$funcs = Compare-Object $pre $post | Select-Object -Expand InputObject | Select-Object -Expand Name
$funcs | Where-Object { $_ -cmatch '^[A-Z]+'} | ForEach-Object { Export-ModuleMember -Function $_ }

#Export-ModuleMember -Alias *
extensions\Install-NpmPackage.ps1
<#
.SYNOPSIS
    Installs an NPM package globally for the current user.

.DESCRIPTION
    Installs an NPM package globally for the current user.

    Requires that NodeJS and NPM are installed, otherwise an error is shown.

    Supports installing packages for the user which initiated the process when running in background mode.

.EXAMPLE
    PS> Install-NpmPackage markdownlint

    Installs the 'markdownlint' package

.EXAMPLE
    PS> Install-NpmPackage [email protected]

    Installs version 0.23.2 of the 'markdownlint' package.
#>
function Install-NpmPackage {
    [CmdletBinding()]
    param(
        # Scope, name and version of the package to install
        [Parameter(Mandatory = $true)]
        [string]$package
    )

    $packageName = $env:ChocolateyPackageName
    if (-Not (Get-Command "node" -errorAction SilentlyContinue)) {
        Write-Error "$packageName requires Node.js to be installed. To install with Chocolatey, use either of the commands below:"
        Write-Error "  choco install nodejs"
        Write-Error "  choco install nodejs-lts"
        throw "Node.js not found"
    } elseif (-Not (Get-Command "npm" -CommandType Application -ErrorAction SilentlyContinue)) {
        Write-Error "$packageName requires npm to be installed. Please verify your Node.js installation includes the 'npm package manager' component, and was added to PATH."
        throw "npm not found"
    } else {
        $user = $env:USER_CONTEXT
        if ($user) {
            Write-Host "Detected running in background mode"
            Write-Host "Installing for user '$user'"

            $profilesDirectory = (Get-ItemProperty -Path "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\ProfileList" -Name "ProfilesDirectory").ProfilesDirectory
            $userNpmDirectory = "$profilesDirectory\$user\AppData\Roaming\npm"

            $currentPrefix = npm prefix -g
            try {
                # Set folder for global packages to user folder of user which initiated the installation.
                npm config set prefix $userNpmDirectory

                npm install -g $package
            }
            finally {
                npm config set prefix $currentPrefix
            }

        }
        else {
            npm install -g $package
        }
    }
}
extensions\Uninstall-NpmPackage.ps1
<#
.SYNOPSIS
    Uninstalls an NPM package.

.DESCRIPTION
    Uninstalls an NPM package.

    Supports uninstalling packages for the user which initiated the process when running in background mode.

.EXAMPLE
    PS> Uninstall-NpmPackage markdownlint-cli

    Uninstalls the 'markdownlint-cli' package.
#>
function Uninstall-NpmPackage {
    [CmdletBinding()]
    param(
        # Name of the package to uninstall
        [Parameter(Mandatory = $true)]
        [string]$package
    )

    $user = $env:USER_CONTEXT
    if ($user) {
        Write-Host "Detected running in background mode"
        Write-Host "Uninstalling for user '$user'"

        $profilesDirectory = (Get-ItemProperty -Path "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\ProfileList" -Name "ProfilesDirectory").ProfilesDirectory
        $userNpmDirectory = "$profilesDirectory\$user\AppData\Roaming\npm"

        $currentPrefix = npm prefix -g
        try {
            # Set folder for global packages to user folder of user which initiated the uninstallation.
            npm config set prefix $userNpmDirectory

            npm uninstall -g $package
        }
        finally {
            npm config set prefix $currentPrefix
        }

    }
    else {
        npm uninstall -g $package
    }
}

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Add to Builder Version Downloads Last Updated Status
Chocolatey NPM servicing extension 1.0.0 7075 Friday, November 20, 2020 Approved
Discussion for the Chocolatey NPM servicing extension Package

Ground Rules:

  • This discussion is only about Chocolatey NPM servicing extension and the Chocolatey NPM servicing extension package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Chocolatey NPM servicing extension, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus