print the mkdocs output when running the generate command with the --verbose flag

Signed-off-by: Morgan Bentell <[email protected]>

Author: agentbellnorm

.changeset/quick-coats-sneeze.md

@@ -0,0 +1,5 @@
+---
+'@techdocs/cli': minor
+---
+
+Running `@techdocs/cli generate` with the `--verbose` flag will now print the mkdocs output.

packages/techdocs-cli/src/commands/generate/generate.ts

@@ -31,8 +31,8 @@ import { ConfigReader } from '@backstage/config';
 import {
   convertTechDocsRefToLocationAnnotation,
   createLogger,
+  getLogStream,
 } from '../../lib/utility';
-import { stdout } from 'process';
 
 export default async function generate(opts: OptionValues) {
   // Use techdocs-node package to generate docs. Keep consistency between Backstage and CI generating docs.
@@ -110,7 +110,7 @@ export default async function generate(opts: OptionValues) {
       : {}),
     logger,
     etag: opts.etag,
-    ...(process.env.LOG_LEVEL === 'debug' ? { logStream: stdout } : {}),
+    logStream: getLogStream(logger),
     siteOptions: { name: opts.siteName },
   });
 

packages/techdocs-cli/src/lib/utility.ts

@@ -18,6 +18,8 @@ import {
   ParsedLocationAnnotation,
 } from '@backstage/plugin-techdocs-node';
 import * as winston from 'winston';
+import { Writable } from 'stream';
+import { stdout } from 'process';
 
 export const convertTechDocsRefToLocationAnnotation = (
   techdocsRef: string,
@@ -52,3 +54,17 @@ export const createLogger = ({
 
   return logger;
 };
+
+export const getLogStream = (logger: winston.Logger): Writable => {
+  if (process.env.LOG_LEVEL === 'debug') {
+    return stdout;
+  }
+
+  return new Writable({
+    defaultEncoding: 'utf8',
+    write(chunk, _encoding, next) {
+      logger.verbose(chunk.toString().trim());
+      next();
+    },
+  });
+};