feat: add logger for install (#141)

web-infra-dev · Jun 12, 2024 · 1be9cbf · 1be9cbf
1 parent 4a1331b
commit 1be9cbf
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 7 deletions.
diff --git a/.changeset/wise-dancers-admire.md b/.changeset/wise-dancers-admire.md
@@ -0,0 +1,6 @@
+---
+'@modern-js/codesmith': patch
+---
+
+feat: add logger for install
+feat: install 添加 logger
diff --git a/packages/core/src/utils/downloadPackage.ts b/packages/core/src/utils/downloadPackage.ts
@@ -2,11 +2,12 @@ import os from 'os';
 import { fs, semver } from '@modern-js/utils';
 import axios from 'axios';
 import tar from 'tar';
+import { fsExists } from './fsExists';
 import { getNpmTarballUrl } from './getNpmTarballUrl';
 import { getNpmVersion } from './getNpmVersion';
-import { fsExists } from './fsExists';
 import { runInstall } from './packageManager';
 import { CATCHE_VALIDITY_PREIOD } from '@/constants';
+import { Logger } from '@/logger';
 
 async function isValidCache(cacheDir: string) {
   /* generator cache can use
@@ -91,9 +92,10 @@ export async function downloadPackage(
   options: {
     registryUrl?: string;
     install?: boolean;
+    logger?: Logger;
   } = {},
 ) {
-  const { registryUrl, install } = options;
+  const { registryUrl, install, logger } = options;
   let version;
   if (!semver.valid(pkgVersion)) {
     // get pkgName version
@@ -108,6 +110,7 @@ export async function downloadPackage(
     version = pkgVersion;
   }
   const targetDir = `${os.tmpdir()}/csmith-generator/${pkgName}@${version}`;
+  logger?.debug?.(`Download package ${pkgName}@${version} to ${targetDir}`);
   if ((await fsExists(targetDir)) && (await isValidCache(targetDir))) {
     return targetDir;
   }
@@ -122,7 +125,7 @@ export async function downloadPackage(
   await downloadAndDecompressTargz(tarballPkg, targetDir);
 
   if (install) {
-    await runInstall(targetDir, registryUrl);
+    await runInstall(targetDir, registryUrl, logger);
   }
 
   // write completed flag

diff --git a/packages/core/src/utils/packageManager.ts b/packages/core/src/utils/packageManager.ts
@@ -1,5 +1,6 @@
 import path from 'path';
 import { fs, execa } from '@modern-js/utils';
+import { Logger } from '@/logger';
 
 export async function canUseYarn() {
   try {
@@ -23,7 +24,11 @@ export async function canUsePnpm() {
   }
 }
 
-export async function runInstall(targetDir: string, registryUrl?: string) {
+export async function runInstall(
+  targetDir: string,
+  registryUrl?: string,
+  logger?: Logger,
+) {
   const options = {
     cwd: targetDir,
     env: process.env,
@@ -41,19 +46,27 @@ export async function runInstall(targetDir: string, registryUrl?: string) {
      * no handle
      */
   }
+
+  const showLog = logger?.level === 'debug';
+
   if (await canUsePnpm()) {
     const params = [
       'install',
       '--prod',
-      '--reporter=silent',
+      showLog ? null : '--reporter=silent', // if debug mode, console install log
       '--ignore-scripts',
-    ];
+    ].filter(Boolean) as string[];
     if (registryUrl) {
       params.push(`--registry=${registryUrl}`);
     }
     await execa('pnpm', params, options);
   } else if (await canUseYarn()) {
-    const params = ['install', '--production', '--silent', '--ignore-scripts'];
+    const params = [
+      'install',
+      '--production',
+      showLog ? null : '--silent',
+      '--ignore-scripts',
+    ].filter(Boolean) as string[];
     if (registryUrl) {
       params.push(`--registry=${registryUrl}`);
     }