feat: Add npm install resource

Author: kevinwang5658

src/index.ts

@@ -19,6 +19,7 @@ import { WaitGithubSshKey } from './resources/git/wait-github-ssh-key/wait-githu
 import { HomebrewResource } from './resources/homebrew/homebrew.js';
 import { JenvResource } from './resources/java/jenv/jenv.js';
 import { Npm } from './resources/javascript/npm/npm.js';
+import { NpmInstallResource } from './resources/javascript/npm/npm-install.js';
 import { NpmLoginResource } from './resources/javascript/npm/npm-login.js';
 import { NvmResource } from './resources/javascript/nvm/nvm.js';
 import { Pnpm } from './resources/javascript/pnpm/pnpm.js';
@@ -91,6 +92,7 @@ runPlugin(Plugin.create(
     new PipSync(),
     new MacportsResource(),
     new Npm(),
+    new NpmInstallResource(),
     new NpmLoginResource(),
     new DockerResource(),
     new AptResource(),

src/resources/javascript/npm/npm-install.ts

@@ -0,0 +1,111 @@
+import { ExampleConfig, Resource, ResourceSettings, getPty } from '@codifycli/plugin-core';
+import { OS, ResourceConfig } from '@codifycli/schemas';
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import { z } from 'zod';
+
+const schema = z.object({
+  directories: z.array(z.string()).describe('List of directories to run npm install in'),
+});
+
+export type NpmInstallConfig = z.infer<typeof schema> & ResourceConfig;
+
+const defaultConfig: Partial<NpmInstallConfig> = {
+  directories: [],
+};
+
+const exampleSingleProject: ExampleConfig = {
+  title: 'Run npm install in a project directory',
+  description: 'Ensure npm dependencies are installed in a specific project directory.',
+  configs: [{
+    type: 'npm-install',
+    directories: ['~/projects/my-app'],
+  }],
+};
+
+const exampleMultipleProjects: ExampleConfig = {
+  title: 'Run npm install in multiple directories',
+  description: 'Install npm dependencies across multiple projects in one step.',
+  configs: [{
+    type: 'npm-install',
+    directories: ['~/projects/frontend', '~/projects/backend', '~/projects/shared'],
+  }],
+};
+
+export class NpmInstallResource extends Resource<NpmInstallConfig> {
+  getSettings(): ResourceSettings<NpmInstallConfig> {
+    return {
+      id: 'npm-install',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleSingleProject,
+        example2: exampleMultipleProjects,
+      },
+      operatingSystems: [OS.Darwin, OS.Linux],
+      schema,
+      parameterSettings: {
+        directories: {
+          type: 'array',
+          itemType: 'directory',
+          canModify: true,
+          isElementEqual: (a, b) => path.resolve(a) === path.resolve(b),
+          filterInStatelessMode: (desired, current) =>
+            current.filter((c) => desired.some((d) => path.resolve(d) === path.resolve(c))),
+        },
+      },
+      dependencies: ['npm', 'nvm', 'pnpm'],
+      importAndDestroy: {
+        preventDestroy: true,
+      },
+    };
+  }
+
+  async refresh(parameters: Partial<NpmInstallConfig>): Promise<Partial<NpmInstallConfig> | null> {
+    const pty = getPty();
+    const { status } = await pty.spawnSafe('which npm');
+    if (status === 'error') {
+      return null;
+    }
+
+    if (!parameters.directories || parameters.directories.length === 0) {
+      return parameters;
+    }
+
+    // Return only directories that have node_modules installed
+    const installed: string[] = [];
+    for (const dir of parameters.directories) {
+      const resolved = dir.replace(/^~/, process.env.HOME ?? '~');
+      try {
+        await fs.access(path.join(resolved, 'node_modules'));
+        installed.push(dir);
+      } catch {
+        // node_modules doesn't exist — not installed
+      }
+    }
+
+    return { directories: installed };
+  }
+
+  async create(plan: { desiredConfig: NpmInstallConfig }): Promise<void> {
+    await this.runInstall(plan.desiredConfig.directories ?? []);
+  }
+
+  async modify(
+    _pc: unknown,
+    plan: { desiredConfig: NpmInstallConfig },
+  ): Promise<void> {
+    await this.runInstall(plan.desiredConfig.directories ?? []);
+  }
+
+  async destroy(): Promise<void> {
+    // node_modules removal is intentionally left to the user; prevent destroy is set
+  }
+
+  private async runInstall(directories: string[]): Promise<void> {
+    const $ = getPty();
+    for (const dir of directories) {
+      const resolved = dir.replace(/^~/, process.env.HOME ?? '~');
+      await $.spawn(`npm install`, { cwd: resolved, interactive: true });
+    }
+  }
+}

test/node/npm/npm-install.test.ts

@@ -0,0 +1,61 @@
+import { SpawnStatus } from '@codifycli/plugin-core';
+import { PluginTester, testSpawn } from '@codifycli/plugin-test';
+import * as fs from 'node:fs/promises';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+
+describe('NpmInstall tests', () => {
+  const pluginPath = path.resolve('./src/index.ts');
+  let projectDir: string;
+
+  beforeAll(async () => {
+    // Ensure nvm + Node.js are available
+    await PluginTester.install(pluginPath, [
+      {
+        type: 'nvm',
+        global: '24',
+        nodeVersions: ['24'],
+      },
+    ]);
+
+    // Create a minimal npm project to run install against
+    projectDir = path.join(os.tmpdir(), 'codify-npm-install-test');
+    await fs.mkdir(projectDir, { recursive: true });
+    await fs.writeFile(
+      path.join(projectDir, 'package.json'),
+      JSON.stringify({ name: 'test-project', version: '1.0.0', dependencies: { 'is-odd': '3.0.1' } }),
+    );
+  }, 500000);
+
+  afterAll(async () => {
+    await fs.rm(projectDir, { recursive: true, force: true });
+  });
+
+  it('Runs npm install in the specified directory', { timeout: 500000 }, async () => {
+    await PluginTester.fullTest(
+      pluginPath,
+      [
+        {
+          type: 'npm-install',
+          directories: [projectDir],
+        },
+      ],
+      {
+        skipUninstall: true,
+        validateApply: async () => {
+          const nodeModulesExists = await fs
+            .access(path.join(projectDir, 'node_modules'))
+            .then(() => true)
+            .catch(() => false);
+          expect(nodeModulesExists).toBe(true);
+
+          const { status } = await testSpawn(
+            `node -e "require('${path.join(projectDir, 'node_modules', 'is-odd')}')"`,
+          );
+          expect(status).toBe(SpawnStatus.SUCCESS);
+        },
+      },
+    );
+  });
+});