chore: Add more logs to build process

Author: 3y3

src/commands/build/index.ts

@@ -16,7 +16,7 @@ import {
 import {getHooks as getTocHooks} from '~/core/toc';
 import {PAGE_PROCESS_CONCURRENCY, Stage, YFM_CONFIG_FILENAME} from '~/constants';
 import {Command} from '~/core/config';
-import {normalizePath, setExt} from '~/core/utils';
+import {console, normalizePath, setExt} from '~/core/utils';
 import {Extension as LocalSearchExtension} from '~/extensions/local-search';
 import {Extension as GenericIncluderExtension} from '~/extensions/generic-includer';
 import {Extension as OpenapiIncluderExtension} from '~/extensions/openapi';
@@ -170,9 +170,11 @@ export class Build extends BaseProgram<BuildConfig, BuildArgs> {
         await getHooks(this).BeforeRun.for(outputFormat).promise(this.run);
 
         if (isMainThread) {
+            console.log('Prepare build input');
             await this.prepareInput();
         }
 
+        console.log('Prepare build runtime');
         await this.prepareRun();
 
         if (!isMainThread) {
@@ -181,6 +183,7 @@ export class Build extends BaseProgram<BuildConfig, BuildArgs> {
 
         await threads.setup();
 
+        console.log('Collect project files info');
         const ignore = this.run.config.ignore.map((rule) => rule.replace(/\/*$/g, '/**'));
         const paths = await this.run.glob('**/toc.yaml', {
             cwd: this.run.input,
@@ -208,6 +211,7 @@ export class Build extends BaseProgram<BuildConfig, BuildArgs> {
         const {tocs, entries, copymap} = this.run.toc;
         const vcs = this.run.vcs.getData();
 
+        console.log('Sync project data');
         await this.sync(tocs, entries, copymap, vcs);
 
         await this.concurrently(tocs, async (raw) => {
@@ -216,6 +220,7 @@ export class Build extends BaseProgram<BuildConfig, BuildArgs> {
             await this.run.write(join(this.run.output, toc.path), toc.toString(), true);
         });
 
+        console.log('Process project files');
         await this.concurrently(entries, async (entry) => {
             try {
                 this.run.logger.proc(entry);
@@ -234,12 +239,14 @@ export class Build extends BaseProgram<BuildConfig, BuildArgs> {
 
         await handler(this.run);
 
+        console.log('Aggregate build artifacts');
         await this.releaseRun();
 
         await getHooks(this).AfterRun.for(outputFormat).promise(this.run);
         await getBaseHooks(this).AfterAnyRun.promise(this.run);
 
-        await this.releaseOutput();
+        console.log('Cleanup build results');
+        await this.cleanup();
     }
 
     async concurrently<T>(items: T[], iterator: (item: T, index: number) => Promise<void>) {
@@ -281,10 +288,6 @@ export class Build extends BaseProgram<BuildConfig, BuildArgs> {
         await this.run.copy(originalInput, input, ['node_modules/**', '*/node_modules/**']);
     }
 
-    private async releaseOutput() {
-        await this.cleanup();
-    }
-
     private async prepareRun() {
         await this.run.vars.init();
         await this.run.leading.init();

src/commands/threads.ts

@@ -10,7 +10,7 @@ import {Observable, Subject} from 'threads/observable';
 // @ts-ignore
 import {expose} from 'threads/worker';
 
-import {Defer, Graph, all} from '~/core/utils';
+import {Defer, Graph, all, console} from '~/core/utils';
 import {LogLevel} from '~/core/logger';
 import {Program, parse} from '~/commands';
 
@@ -129,6 +129,8 @@ export async function init(_program: Program, runargv: string[]) {
         return;
     }
 
+    console.log(`Init ${jobs} processing threads`);
+
     program = _program;
     argv = runargv;
     threads = Array(jobs)
@@ -152,6 +154,12 @@ export async function init(_program: Program, runargv: string[]) {
 }
 
 export async function setup() {
+    if (!threads.length) {
+        return;
+    }
+
+    console.log('Wait for threads setup');
+
     await all(
         threads.map(async (defer) => {
             const thread = await defer.promise;

src/core/utils/console.ts

@@ -0,0 +1,37 @@
+/* eslint-disable no-console */
+
+class MutableConsole {
+    log(...args: unknown[]) {
+        this.write('log', args);
+    }
+
+    warn(...args: unknown[]) {
+        console.warn(...args);
+    }
+
+    error(...args: unknown[]) {
+        console.error(...args);
+    }
+
+    time(label: string) {
+        if (process.env.NODE_ENV !== 'test') {
+            console.time(label);
+        }
+    }
+
+    timeEnd(label: string) {
+        if (process.env.NODE_ENV !== 'test') {
+            console.timeEnd(label);
+        }
+    }
+
+    private write(level: 'log' | 'error' | 'warn', args: unknown[]) {
+        if (process.env.NODE_ENV !== 'test') {
+            console[level](...args);
+        }
+    }
+}
+
+const _console = new MutableConsole();
+
+export {_console as console};

src/core/utils/index.ts

@@ -1,4 +1,5 @@
 export * from './common';
+export * from './console';
 export * from './decorators';
 export * from './extension';
 export * from './path';

src/index.ts

@@ -7,6 +7,7 @@ import './require';
 import * as threads from '~/commands/threads';
 import {Program, parse} from '~/commands';
 import {stats} from '~/core/logger';
+import {console} from '~/core/utils';
 
 export * from '~/commands';
 
@@ -42,27 +43,25 @@ if (isMainThread && require.main === module) {
         // eslint-disable-next-line no-console
         console.time(MAIN_TIMER_ID);
 
-        if (global.VERSION && process.env.NODE_ENV !== 'test') {
+        if (global.VERSION) {
             // eslint-disable-next-line no-console
             console.log(`Using v${global.VERSION} version`);
         }
 
         const report = await run(process.argv);
 
-        if (process.env.NODE_ENV !== 'test') {
-            // eslint-disable-next-line no-console
-            console.timeEnd(MAIN_TIMER_ID);
+        // eslint-disable-next-line no-console
+        console.timeEnd(MAIN_TIMER_ID);
 
-            if (report.code) {
-                // eslint-disable-next-line no-console
-                console.log(
-                    red(dedent`
+        if (report.code) {
+            // eslint-disable-next-line no-console
+            console.log(
+                red(dedent`
                         ================================
                         YFM build completed with ERRORS!
                         ================================
                     `),
-                );
-            }
+            );
         }
 
         process.exit(report.code);