npm package feature

Author: danielbraun89

src/npm-package/devcontainer-feature.json

@@ -0,0 +1,30 @@
+{
+    "name": "npm package",
+    "id": "npm-package",
+    "version": "1.0.0",
+    "description": "Installs an npm package.",
+    "documentationURL": "http://github.com/devcontainers-contrib/features/tree/main/src/npm-package",
+    "installAfter": [
+        "ghcr.io/devcontainers/features/node:latest"
+    ],
+    "options": {
+        "package": {
+            "type": "string",
+            "proposals": [
+                "typescript",
+                "vtop",
+                "fkill-cli"
+            ],
+            "default": "",
+            "description": "Select the npm package to install."
+        },
+        "version": {
+            "type": "string",
+            "proposals": [
+                "latest"
+            ],
+            "default": "latest",
+            "description": "Select the version of the npm package to install."
+        }
+    }
+}

src/npm-package/install.sh

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+set -e
+
+PACKAGE=${PACKAGE:-""}
+VERSION=${VERSION:-"latest"}
+
+# Clean up
+rm -rf /var/lib/apt/lists/*
+
+if [ -z "$PACKAGE" ]; then
+	echo -e "'package' variable is empty, skipping"
+	exit 0
+fi
+
+if [ "$(id -u)" -ne 0 ]; then
+	echo -e 'Script must be run as 
+    root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.'
+	exit 1
+fi
+
+check_packages() {
+	# This is part of devcontainers-contrib script library
+	# source: https://github.com/devcontainers-contrib/features/tree/v1.1.8/script-library
+	if ! dpkg -s "$@" >/dev/null 2>&1; then
+		if [ "$(find /var/lib/apt/lists/* | wc -l)" = "0" ]; then
+			echo "Running apt-get update..."
+			apt-get update -y
+		fi
+		apt-get -y install --no-install-recommends "$@"
+	fi
+}
+
+install_via_npm() {
+	# This is part of devcontainers-contrib script library
+	# source: https://github.com/devcontainers-contrib/features/tree/v1.1.8/script-library
+	PACKAGE=$1
+
+	# install node+npm if does not exists
+	if ! type npm >/dev/null 2>&1; then
+		echo "Installing node and npm..."
+		check_packages curl ca-certificates
+		curl -fsSL https://raw.githubusercontent.com/devcontainers/features/main/src/node/install.sh | bash
+		export NVM_DIR=/usr/local/share/nvm
+		[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
+		[ -s "$NVM_DIR/bash_completion" ] && . "$NVM_DIR/bash_completion"
+	fi
+
+	if [ "$(npm list --global --parseable --depth 0 --omit dev | grep "$PACKAGE")" != "" ]; then
+		echo "$PACKAGE  already exists - skipping installation"
+		exit 0
+	fi
+
+	if [ "$VERSION" = "latest" ]; then
+		npm_installation="$PACKAGE"
+	else
+		npm_installation="$PACKAGE==$VERSION"
+	fi
+
+	npm install -g --omit=dev "$npm_installation"
+}
+
+install_via_npm "$PACKAGE" "$VERSION"

test/npm-package/install_angular_cli.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -e
+
+source dev-container-features-test-lib
+
+check "list --short | grep black" list --short | grep black
+
+
+reportResults

test/npm-package/install_typescript.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -e
+
+source dev-container-features-test-lib
+
+check "list --short | grep black" list --short | grep black
+
+
+reportResults

test/npm-package/scenarios.json

@@ -0,0 +1,20 @@
+{
+    "install_angular_cli": {
+        "image": "debian:bullseye",
+        "features": {
+            "npm-package": {
+                "version": "latest",
+                "package": "@angular/cli"
+            }
+        }
+    },
+    "install_typescript": {
+        "image": "debian:bullseye",
+        "features": {
+            "npm-package": {
+                "version": "latest",
+                "package": "typescript"
+            }
+        }
+    }
+}

test/npm-package/test.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -e
+
+source dev-container-features-test-lib
+
+check "nothing is installted when package is empty" exit 0
+
+reportResults