chore: better error log

tiktok · Oct 11, 2023 · 89c1fd1 · 89c1fd1
1 parent d1ea6f3
commit 89c1fd1
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 8 deletions.
diff --git a/common/changes/rush-git-lfs-plugin/improve-better_error_log_2023-10-11-12-32.json b/common/changes/rush-git-lfs-plugin/improve-better_error_log_2023-10-11-12-32.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "rush-git-lfs-plugin",
+      "comment": "Provide better error log in rush git-lfs-pull",
+      "type": "patch"
+    }
+  ],
+  "packageName": "rush-git-lfs-plugin"
+}
diff --git a/rush-plugins/rush-git-lfs-plugin/command-line.json b/rush-plugins/rush-git-lfs-plugin/command-line.json
@@ -5,7 +5,7 @@
       "name": "git-lfs-check",
       "commandKind": "global",
       "summary": "Check Git LFS file in rush project",
-      "shellCommand": "node <packageFolder>/lib/bin.js",
+      "shellCommand": "node <packageFolder>/lib/check.js",
       "safeForSimultaneousRushProcesses": true
     },
     {

diff --git a/rush-plugins/rush-git-lfs-plugin/src/bin.ts → ...-plugins/rush-git-lfs-plugin/src/check.ts b/rush-plugins/rush-git-lfs-plugin/src/bin.ts → ...-plugins/rush-git-lfs-plugin/src/check.ts
diff --git a/rush-plugins/rush-git-lfs-plugin/src/executor/pull.ts b/rush-plugins/rush-git-lfs-plugin/src/executor/pull.ts
@@ -1,6 +1,6 @@
 import { Executable } from '@rushstack/node-core-library';
 import { SpawnSyncReturns } from 'child_process';
-
+import { terminal, withPrefix } from '../helpers/terminal';
 interface IProject {
   path: string;
 }
@@ -19,6 +19,8 @@ const getPackagesByProjectName = (
   if (result.status === 0) {
     return JSON.parse(result.stdout);
   }
+  terminal.writeLine(withPrefix('Logs:\n'), result.stdout);
+  terminal.writeErrorLine(withPrefix('Errors:\n'), result.stderr);
   throw new Error(`rush list error code  ${result.status}`);
 };
 

diff --git a/rush-plugins/rush-git-lfs-plugin/src/executor/run-check.ts b/rush-plugins/rush-git-lfs-plugin/src/executor/run-check.ts
@@ -6,12 +6,10 @@ import { getFilePathsFromChangedFiles, validateFilePaths } from '../helpers/file
 import { terminal, withPrefix } from '../helpers/terminal';
 
 import type { NestedRequired } from '../helpers/type';
-import type { ICommandLineOptions } from '../bin';
+import type { ICommandLineOptions } from '../check';
 import ora from 'ora';
 
-const normalizeCheckContext = (
-  commandLineOption: ICommandLineOptions
-): IGitLFSCheckModuleContext => {
+const normalizeCheckContext = (commandLineOption: ICommandLineOptions): IGitLFSCheckModuleContext => {
   // eslint-disable-next-line prefer-const
   let { file: files, fix } = commandLineOption;
   if (typeof files === 'undefined') {
@@ -36,15 +34,15 @@ const normalizeCheckContext = (
     fix,
     files,
     option,
-    spinner,
+    spinner
   };
 };
 
 export const runCheck = async (commandLineOption: ICommandLineOptions): Promise<void> => {
   const checker: GitLFSCheckModule = new GitLFSCheckModule();
   const ctx: IGitLFSCheckModuleContext = normalizeCheckContext(commandLineOption);
   await checker.run(ctx);
-  if (ctx.result.filter(e => typeof e.errorType !== 'undefined' && !e.fixed).length > 0) {
+  if (ctx.result.filter((e) => typeof e.errorType !== 'undefined' && !e.fixed).length > 0) {
     if (ctx.option.errorTips) {
       terminal.writeLine(ctx.option.errorTips);
     }