feat: npm resource

Author: kevinwang5658

package.json

@@ -23,7 +23,7 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "semver": "^7.6.0",
-    "codify-plugin-lib": "1.0.173",
+    "codify-plugin-lib": "1.0.174",
     "codify-schemas": "1.0.63",
     "chalk": "^5.3.0",
     "debug": "^4.3.4",
@@ -50,7 +50,7 @@
     "@types/debug": "4.1.12",
     "@types/plist": "^3.0.5",
     "@types/lodash.isequal": "^4.5.8",
-    "codify-plugin-test": "0.0.50",
+    "codify-plugin-test": "0.0.51",
     "commander": "^12.1.0",
     "eslint": "^8.51.0",
     "eslint-config-oclif": "^5",

src/index.ts

@@ -34,6 +34,7 @@ import { TerraformResource } from './resources/terraform/terraform.js';
 import { VscodeResource } from './resources/vscode/vscode.js';
 import { XcodeToolsResource } from './resources/xcode-tools/xcode-tools.js';
 import { MacportsResource } from './resources/macports/macports.js';
+import { Npm } from './resources/node/npm/npm.js';
 
 runPlugin(Plugin.create(
   'default',
@@ -71,6 +72,7 @@ runPlugin(Plugin.create(
     new VenvProject(),
     new Pip(),
     new PipSync(),
-    new MacportsResource()
+    new MacportsResource(),
+    new Npm(),
   ])
 )

src/resources/node/npm/global-install.ts

@@ -0,0 +1,131 @@
+import { ParameterSetting, Plan, StatefulParameter, getPty } from 'codify-plugin-lib';
+
+import { codifySpawn } from '../../../utils/codify-spawn.js';
+import { NpmConfig } from './npm.js';
+
+export interface NpmPackage {
+  name: string;
+  version?: string;
+}
+
+interface NpmLsResponse {
+  version: string;
+  name: string;
+  dependencies?: Record<string, {
+    version: string;
+    resolved: string;
+    overridden: boolean;
+  }>;
+}
+
+export class NpmGlobalInstallParameter extends StatefulParameter<NpmConfig, Array<NpmPackage | string>> {
+
+  getSettings(): ParameterSetting {
+    return {
+      type: 'array',
+      isElementEqual: this.isEqual,
+      filterInStatelessMode: (desired, current) =>
+        current.filter((c) => desired.some((d) => this.isSamePackage(d, c))),
+    }
+  }
+
+  async refresh(desired: (NpmPackage | string)[] | null, config: Partial<NpmConfig>): Promise<(NpmPackage | string)[] | null> {
+    const pty = getPty();
+
+    const { data } = await pty.spawnSafe('npm ls --json --global --depth=0 --loglevel=error')
+    if (!data) {
+      return null;
+    }
+
+    const parsedData = JSON.parse(data) as NpmLsResponse;
+    const dependencies = Object.entries(parsedData.dependencies ?? {})
+      .map(([name, info]) => ({
+        name,
+        version: info.version,
+      }))
+
+    return dependencies.map((c) => {
+      if (desired?.some((d) => typeof d === 'string' && d === c.name)) {
+        return c.name;
+      }
+
+      if(desired?.some((d) => typeof d === 'object' && d.name === c.name && !d.version)) {
+        return { name: c.name };
+      }
+
+      return c;
+    })
+  }
+
+  async add(valueToAdd: Array<NpmPackage | string>, plan: Plan<NpmConfig>): Promise<void> {
+    await this.install(valueToAdd);
+  }
+
+  async modify(newValue: (NpmPackage | string)[], previousValue: (NpmPackage | string)[], plan: Plan<NpmConfig>): Promise<void> {
+    const toInstall = newValue.filter((n) => !previousValue.some((p) => this.isSamePackage(n, p)));
+    const toUninstall = previousValue.filter((p) => !newValue.some((n) => this.isSamePackage(n, p)));
+    
+    await this.uninstall(toUninstall);
+    await this.install(toInstall);
+  }
+
+  async remove(valueToRemove: (NpmPackage | string)[], plan: Plan<NpmConfig>): Promise<void> {
+    await this.uninstall(valueToRemove);
+  }
+
+  async install(packages: Array<NpmPackage | string>): Promise<void> {
+    const installStatements = packages.map((p) => {
+      if (typeof p === 'string') {
+        return p;
+      }
+
+      if (p.version) {
+        return `${p.name}@${p.version}`;
+      }
+
+      return p.name;
+    })
+
+    await codifySpawn(`npm install --global ${installStatements.join(' ')}`);
+  }
+
+  async uninstall(packages: Array<NpmPackage | string>): Promise<void> {
+    const uninstallStatements = packages.map((p) => {
+      if (typeof p === 'string') {
+        return p;
+      }
+
+      return p.name;
+    })
+
+    await codifySpawn(`npm uninstall --global ${uninstallStatements.join(' ')}`);
+  }
+
+
+  isSamePackage(desired: NpmPackage | string, current: NpmPackage | string): boolean {
+    if (typeof desired === 'string' && typeof current === 'string') {
+      return desired === current;
+    }
+
+    if (typeof desired === 'object' && typeof current === 'object') {
+      return desired.name === current.name;
+    }
+
+    return false;
+  }
+
+  isEqual(desired: NpmPackage | string, current: NpmPackage | string): boolean {
+    if (typeof desired === 'string' && typeof current === 'string') {
+      return desired === current;
+    }
+
+    if (typeof desired === 'object' && typeof current === 'object') {
+      return desired.version
+        ? desired.name === current.name && desired.version === current.version
+        : desired.name === current.name;
+    }
+
+    return false;
+  }
+
+}

src/resources/node/npm/npm-shema.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/npm.json",
+  "title": "Npm resource",
+  "description": "Install and manage packages using NPM.",
+  "type": "object",
+  "properties": {
+    "globalInstall": {
+      "type": "array",
+      "description": "An array of",
+      "items": {
+        "oneOf": [
+          { "type": "string", "description": "Npm packages to install globally" },
+          {
+            "type": "object",
+            "properties": {
+              "name": { "type": "string", "description": "The name of the package to install" },
+              "version": { "type": "string", "description": "The version of package to install" }
+            },
+            "required": ["name"]
+          }
+        ]
+      }
+    }
+  },
+  "additionalProperties": false
+}

src/resources/node/npm/npm.ts

@@ -0,0 +1,42 @@
+import { CreatePlan, DestroyPlan, RefreshContext, Resource, ResourceSettings, getPty } from 'codify-plugin-lib';
+import { ResourceConfig } from 'codify-schemas';
+
+import { NpmGlobalInstallParameter, NpmPackage } from './global-install.js';
+import schema from './npm-shema.json'
+
+export interface NpmConfig extends ResourceConfig {
+  globalInstall: Array<NpmPackage | string>
+}
+
+export class Npm extends Resource<NpmConfig> {
+  getSettings(): ResourceSettings<NpmConfig> {
+    return {
+      id: 'npm',
+      schema,
+      parameterSettings: {
+        globalInstall: { type: 'stateful', definition: new NpmGlobalInstallParameter() },
+      },
+      importAndDestroy: {
+        preventDestroy: true,
+      }
+    }
+  }
+
+  async refresh(parameters: Partial<NpmConfig>, context: RefreshContext<NpmConfig>): Promise<Partial<NpmConfig> | Partial<NpmConfig>[] | null> {
+    const pty = getPty();
+
+    const { status } = await pty.spawnSafe('which npm')
+    if (status === 'error') {
+      return null;
+    }
+
+    return parameters;
+  }
+
+  // Npm gets created with NodeJS
+  async create(plan: CreatePlan<NpmConfig>): Promise<void> {}
+
+  // Npm is destroyed with NodeJS
+  destroy(plan: DestroyPlan<NpmConfig>): Promise<void> {}
+
+}

test/node/npm/npm.test.ts

@@ -0,0 +1,32 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { PluginTester } from 'codify-plugin-test';
+import path from 'node:path';
+import { execSync } from 'child_process';
+
+// Example test suite
+describe('Npm tests', () => {
+  const pluginPath = path.resolve('./src/index.ts');
+
+  it('Can install nvm and a global package with npm',  { timeout: 500000 }, async () => {
+    await PluginTester.fullTest(pluginPath, [
+      {
+        type: 'nvm',
+        global: '20',
+        nodeVersions: ['20']
+      },
+      {
+        type: 'npm',
+        globalInstall: ['pnpm'],
+      }
+    ], {
+      validateApply: () => {
+        expect(() => execSync('source ~/.zshrc; which nvm', { shell: 'zsh' })).to.not.throw();
+        expect(execSync('source ~/.zshrc; node --version', { shell: 'zsh' }).toString('utf-8').trim()).to.include('20');
+
+        const installedVersions = execSync('source ~/.zshrc; nvm list', { shell: 'zsh' }).toString('utf-8').trim();
+        expect(installedVersions).to.include('20');
+        expect(installedVersions).to.include('18');
+      },
+    });
+  });
+});