feat(install): add return val in installAll / installDeps (#11)

Signed-off-by: Kevin Cui <[email protected]>

Author: BlackHole1

src/cmd/install.test.ts

@@ -144,13 +144,58 @@ describe.sequential("install all", () => {
         // Copy `entry` to workdir
         await copyDir(path.join(p, "entry"), ctx.workdir);
 
-        await install({
+        const result = await install({
             all: true,
             token: "fake-token",
             workdir: ctx.workdir,
             distDir,
         });
 
+        expect(result.deps).toStrictEqual({
+            "a-0.0.1": {
+                name: "a",
+                version: "0.0.1",
+                isAlreadyExist: false,
+                target: expect.any(String),
+                meta: expect.any(Object),
+            },
+            "b-0.0.1": {
+                name: "b",
+                version: "0.0.1",
+                isAlreadyExist: false,
+                target: expect.any(String),
+                meta: expect.any(Object),
+            },
+            "c-0.0.1": {
+                name: "c",
+                version: "0.0.1",
+                isAlreadyExist: true,
+                target: expect.any(String),
+                meta: expect.any(Object),
+            },
+            "c-0.0.2": {
+                name: "c",
+                version: "0.0.2",
+                isAlreadyExist: false,
+                target: expect.any(String),
+                meta: expect.any(Object),
+            },
+            "d-0.0.1": {
+                name: "d",
+                version: "0.0.1",
+                isAlreadyExist: false,
+                target: expect.any(String),
+                meta: expect.any(Object),
+            },
+            "e-0.0.1": {
+                name: "e",
+                version: "0.0.1",
+                isAlreadyExist: true,
+                target: expect.any(String),
+                meta: expect.any(Object),
+            },
+        });
+
         const fileList = await fg.glob(`**/${ooPackageName}`, {
             cwd: distDir,
             onlyFiles: true,
@@ -194,7 +239,7 @@ describe.sequential("install deps", () => {
         // Copy `entry` to workdir
         await copyDir(path.join(p, "entry"), ctx.workdir);
 
-        await install({
+        const result = await install({
             deps: [
                 { name: "a" },
                 { name: "b" },
@@ -206,6 +251,37 @@ describe.sequential("install deps", () => {
             distDir,
         });
 
+        expect(result.deps).toStrictEqual({
+            "a-0.0.2": {
+                name: "a",
+                version: "0.0.2",
+                isAlreadyExist: false,
+                target: expect.any(String),
+                meta: expect.any(Object),
+            },
+            "b-0.0.2": {
+                name: "b",
+                version: "0.0.2",
+                isAlreadyExist: false,
+                target: expect.any(String),
+                meta: expect.any(Object),
+            },
+            "c-0.0.1": {
+                name: "c",
+                version: "0.0.1",
+                isAlreadyExist: false,
+                target: expect.any(String),
+                meta: expect.any(Object),
+            },
+            "d-0.0.1": {
+                name: "d",
+                version: "0.0.1",
+                isAlreadyExist: false,
+                target: expect.any(String),
+                meta: expect.any(Object),
+            },
+        });
+
         const deps = (await generatePackageJson(ctx.workdir, false)).dependencies;
         expect(deps).toEqual({
             a: "0.0.2",

src/cmd/install.ts

@@ -1,4 +1,4 @@
-import type { Dep, DepRaw, Deps, InstallFileResult } from "../types";
+import type { Dep, DepRaw, Deps, InstallAllResult, InstallFileResult, InstallPackageResult } from "../types";
 import path from "node:path";
 import { execa } from "execa";
 import { ooPackageName } from "../const";
@@ -35,9 +35,10 @@ export interface InstallPackageOptions extends InstallBasicOptions {
 
 export type InstallOptions = InstallAllOptions | InstallFileOptions | InstallPackageOptions;
 
-export async function install(options: InstallAllOptions | InstallPackageOptions): Promise<void>;
+export async function install(options: InstallAllOptions): Promise<InstallAllResult>;
+export async function install(options: InstallPackageOptions): Promise<InstallPackageResult>;
 export async function install(options: InstallFileOptions): Promise<InstallFileResult>;
-export async function install(options: InstallOptions): Promise<InstallFileResult | void> {
+export async function install(options: InstallOptions): Promise<InstallFileResult | InstallPackageResult | InstallAllResult> {
     if ("file" in options) {
         return await installFile(options);
     }
@@ -97,7 +98,7 @@ export async function installFile(options: InstallFileOptions): Promise<InstallF
 
 // oopm install foo
 // oopm install [email protected]
-export async function installPackage(options: InstallPackageOptions) {
+export async function installPackage(options: InstallPackageOptions): Promise<InstallPackageResult> {
     const libraryMeta = await generatePackageJson(options.workdir, false);
 
     const alreadyInstalled: Deps = [];
@@ -144,18 +145,22 @@ export async function installPackage(options: InstallPackageOptions) {
         await Promise.all(p);
     }
 
-    await _install({
+    const deps = await _install({
         alreadyInstalled,
         needInstall,
         save: options.save,
         workdir: options.workdir,
         distDir: options.distDir,
         token: options.token,
     });
+
+    return {
+        deps,
+    };
 }
 
 // oopm install
-export async function installAll(options: InstallAllOptions) {
+export async function installAll(options: InstallAllOptions): Promise<InstallAllResult> {
     const libraryMeta = await generatePackageJson(options.workdir, false);
 
     const alreadyInstalled: Deps = [];
@@ -180,14 +185,18 @@ export async function installAll(options: InstallAllOptions) {
         await Promise.all(p);
     }
 
-    await _install({
+    const deps = await _install({
         alreadyInstalled,
         needInstall,
         save: false,
         workdir: options.workdir,
         distDir: options.distDir,
         token: options.token,
     });
+
+    return {
+        deps,
+    };
 }
 
 interface _InstallOptions {
@@ -199,7 +208,7 @@ interface _InstallOptions {
     needInstall: Deps;
 }
 
-async function _install(options: _InstallOptions) {
+async function _install(options: _InstallOptions): Promise<InstallPackageResult["deps"]> {
     const temp = await tempDir();
     await initPackageJson(temp, options.needInstall, options.token);
 
@@ -218,6 +227,20 @@ async function _install(options: _InstallOptions) {
 
     await mkdir(options.distDir);
 
+    const targets: InstallPackageResult["deps"] = {};
+
+    for (const dep of options.alreadyInstalled) {
+        const target = path.join(options.distDir, `${dep.name}-${dep.version}`);
+
+        targets[`${dep.name}-${dep.version}`] = {
+            name: dep.name,
+            version: dep.version,
+            target,
+            isAlreadyExist: true,
+            meta: await generatePackageJson(target, false),
+        };
+    }
+
     const ps = info
         .filter((i) => {
             if (options.alreadyInstalled.length === 0) {
@@ -230,7 +253,17 @@ async function _install(options: _InstallOptions) {
         })
         .map(async (i) => {
             const target = path.join(options.distDir, `${i.name}-${i.version}`);
-            if (!await exists(target)) {
+            const isAlreadyExist = await exists(target);
+
+            targets[`${i.name}-${i.version}`] = {
+                name: i.name,
+                version: i.version,
+                target,
+                isAlreadyExist,
+                meta: await generatePackageJson(i.source, false),
+            };
+
+            if (!isAlreadyExist) {
                 return copyDir(i.source, target);
             }
         });
@@ -242,4 +275,6 @@ async function _install(options: _InstallOptions) {
     await Promise.all(ps);
 
     await remove(temp);
+
+    return targets;
 }

src/types.ts

@@ -14,7 +14,17 @@ export interface InstallFileResult {
     target: string;
     meta: Omit<OOPackageSchema, "scripts">;
     isOverwrite: boolean;
-};
+}
+
+export interface InstallPackageResult {
+    deps: Record<`${Dep["name"]}-${Dep["version"]}`, Dep & {
+        target: string;
+        meta: Omit<OOPackageSchema, "scripts">;
+        isAlreadyExist: boolean;
+    }>;
+}
+
+export interface InstallAllResult extends InstallPackageResult {}
 
 export interface OOPackageSchema {
     name: string;