@cparra/apexdocs 3.0.0-alpha.4 → 3.0.0-alpha.6

package/dist/cli/generate.js

@@ -13,7 +13,7 @@ var Handlebars = require('handlebars');
 var defaults = require('../defaults-DGKfeZq-.js');
 var fs = require('fs');
 var chalk = require('chalk');
-var logUpdate = require('log-update');
+var ora = require('ora');
 var cosmiconfig = require('cosmiconfig');
 var yargs = require('yargs');
 var cosmiconfigTypescriptLoader = require('cosmiconfig-typescript-loader');
@@ -1526,7 +1526,7 @@ var __spreadValues$7 = (a, b) => {
   return a;
 };
 var __spreadProps$7 = (a, b) => __defProps$7(a, __getOwnPropDescs$7(b));
-var __async$2 = (__this, __arguments, generator) => {
+var __async$3 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1578,7 +1578,7 @@ function generateDocs(apexBundles, config) {
 }
 function transformReferenceHook(config) {
   function _execute(references, parsedFiles, transformReference) {
-    return __async$2(this, null, function* () {
+    return __async$3(this, null, function* () {
       return {
         references: yield execTransformReferenceHook(Object.values(references), transformReference),
         parsedFiles
@@ -1599,8 +1599,8 @@ function transformDocumentationBundleHook(config) {
 function passThroughHook(value) {
   return value;
 }
-const execTransformReferenceHook = (_0, ..._1) => __async$2(void 0, [_0, ..._1], function* (references, hook = passThroughHook) {
-  const hooked = references.map((reference) => __async$2(void 0, null, function* () {
+const execTransformReferenceHook = (_0, ..._1) => __async$3(void 0, [_0, ..._1], function* (references, hook = passThroughHook) {
+  const hooked = references.map((reference) => __async$3(void 0, null, function* () {
     const hookedResult = yield hook(reference);
     return __spreadValues$7(__spreadValues$7({}, reference), hookedResult);
   }));
@@ -1610,24 +1610,24 @@ const execTransformReferenceHook = (_0, ..._1) => __async$2(void 0, [_0, ..._1],
     return acc;
   }, {});
 });
-const documentationBundleHook = (bundle, config) => __async$2(void 0, null, function* () {
+const documentationBundleHook = (bundle, config) => __async$3(void 0, null, function* () {
   return {
     referenceGuide: yield transformReferenceGuide(bundle.referenceGuide, config.transformReferenceGuide),
     docs: yield transformDocs(bundle.docs, config.transformDocs, config.transformDocPage)
   };
 });
-const transformReferenceGuide = (_0, ..._1) => __async$2(void 0, [_0, ..._1], function* (referenceGuide, hook = passThroughHook) {
+const transformReferenceGuide = (_0, ..._1) => __async$3(void 0, [_0, ..._1], function* (referenceGuide, hook = passThroughHook) {
   const result = yield hook(referenceGuide);
   if (isSkip(result)) {
     return result;
   }
   return __spreadValues$7(__spreadValues$7({}, referenceGuide), yield hook(referenceGuide));
 });
-const transformDocs = (_0, ..._1) => __async$2(void 0, [_0, ..._1], function* (docs, transformDocsHook = passThroughHook, transformDocPageHook = passThroughHook) {
+const transformDocs = (_0, ..._1) => __async$3(void 0, [_0, ..._1], function* (docs, transformDocsHook = passThroughHook, transformDocPageHook = passThroughHook) {
   const transformed = yield transformDocsHook(docs);
   return Promise.all(transformed.map((doc) => transformDocPage(doc, transformDocPageHook)));
 });
-const transformDocPage = (_0, ..._1) => __async$2(void 0, [_0, ..._1], function* (doc, hook = passThroughHook) {
+const transformDocPage = (_0, ..._1) => __async$3(void 0, [_0, ..._1], function* (doc, hook = passThroughHook) {
   return __spreadValues$7(__spreadValues$7({}, doc), yield hook(doc));
 });
 function postHookCompile(bundle) {
@@ -1718,52 +1718,33 @@ class Logger {
    * @param args Optional arguments.
    */
   static error(message, ...args) {
-    this.logSingle(message, false, "red", false);
+    this.logSingle(message, "red");
     args.forEach(() => {
-      this.logSingle(message, false, "red", false);
+      this.logSingle(message, "red");
     });
   }
-  static logSingle(text, showSpinner = true, color = "green", overrideConsole = true) {
+  static logSingle(text, color = "green") {
     if (this.currentFrame > 9) {
       this.currentFrame = 0;
     }
-    const spinner = showSpinner ? `${this.frames[this.currentFrame++]}` : "";
-    let logMessage;
-    if (color === "green") {
-      logMessage = `${chalk.green((/* @__PURE__ */ new Date()).toLocaleString() + ": ")}${text}
-`;
-    } else {
-      logMessage = `${chalk.red((/* @__PURE__ */ new Date()).toLocaleString() + ": ")}${text}
+    const logMessage = `${this.getChalkFn(color)((/* @__PURE__ */ new Date()).toLocaleString() + ": ")}${text}
 `;
-    }
-    if (overrideConsole) {
-      logUpdate(`${spinner} ${logMessage}`);
-    } else {
-      process.stdout.write(`${spinner} ${logMessage}`);
-    }
+    process.stdout.write(logMessage);
   }
-  static clear() {
-    logUpdate.clear();
+  static getChalkFn(color) {
+    return color === "green" ? chalk.green : chalk.red;
   }
-  static startSpinner() {
-    if (this.spinnerInterval) {
-      clearInterval(this.spinnerInterval);
-    }
-    this.spinnerInterval = setInterval(() => {
-      this.logSingle("Processing...", true, "green", true);
-    }, 80);
+  // TODO: This isn't really working and I don't think its worth it. Let's just completely remove the ora dependency.
+  static startSpinner(text) {
+    this.spinner.text = text;
+    this.spinner.start();
   }
-  static stopSpinner() {
-    if (this.spinnerInterval) {
-      clearInterval(this.spinnerInterval);
-      this.spinnerInterval = null;
-      this.clear();
-    }
+  static succeedSpinner(text) {
+    this.spinner.succeed(text);
   }
 }
 Logger.currentFrame = 0;
-Logger.frames = ["\u280B", "\u2819", "\u2839", "\u2838", "\u283C", "\u2834", "\u2826", "\u2827", "\u2807", "\u280F"];
-Logger.spinnerInterval = null;
+Logger.spinner = ora();
 
 const referenceGuideTemplate = `
 # Apex Reference Guide
@@ -1799,23 +1780,45 @@ var __spreadValues$5 = (a, b) => {
   return a;
 };
 var __spreadProps$5 = (a, b) => __defProps$5(a, __getOwnPropDescs$5(b));
-function generate(bundles, config) {
-  return _function.pipe(
-    generateDocumentationBundle(bundles, config),
-    TE__namespace.map((files) => writeFilesToSystem(files, config.targetDir)),
-    TE__namespace.mapLeft((error) => {
-      if (error._tag === "HookError") {
-        Logger.error("Error(s) occurred while processing hooks. Please review the following issues:");
-        Logger.error(error.error);
-        return;
+var __async$2 = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
       }
-      const errorMessages = [
-        "Error(s) occurred while parsing files. Please review the following issues:",
-        ...error.errors.map(formatReflectionError)
-      ].join("\n");
-      Logger.error(errorMessages);
-    })
-  )();
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+function generate(bundles, config) {
+  return __async$2(this, null, function* () {
+    return _function.pipe(
+      generateDocumentationBundle(bundles, config),
+      TE__namespace.map((files) => writeFilesToSystem(files, config.targetDir)),
+      TE__namespace.mapLeft((error) => {
+        if (error._tag === "HookError") {
+          Logger.error("Error(s) occurred while processing hooks. Please review the following issues:");
+          Logger.error(error.error);
+          return;
+        }
+        const errorMessages = [
+          "Error(s) occurred while parsing files. Please review the following issues:",
+          ...error.errors.map(formatReflectionError)
+        ].join("\n");
+        Logger.error(errorMessages);
+      })
+    )();
+  });
 }
 function generateDocumentationBundle(bundles, config) {
   return generateDocs(bundles, __spreadProps$5(__spreadValues$5({}, config), {
@@ -1826,8 +1829,7 @@ function writeFilesToSystem(files, outputDir) {
   FileWriter.write(
     [files.referenceGuide, ...files.docs].filter((file) => !isSkip(file)),
     outputDir,
-    (file) => {
-      Logger.logSingle(`${file.outputDocPath} processed.`, false, "green", false);
+    () => {
     }
   );
 }
@@ -2737,7 +2739,7 @@ class OpenApiDocsProcessor {
   }
   onProcess(type) {
     var _a, _b;
-    Logger.logSingle(`Processing ${type.name}`, false, "green", false);
+    Logger.logSingle(`Processing ${type.name}`, "green");
     const endpointPath = this.getEndpointPath(type);
     if (!endpointPath) {
       return;
@@ -2785,7 +2787,7 @@ function openApi(fileBodies, config) {
   Transpiler.generate(filteredTypes, processor);
   const generatedFiles = processor.fileBuilder().files();
   FileWriter.write(generatedFiles, config.targetDir, (file) => {
-    Logger.logSingle(`${file.outputDocPath} processed.`, false, "green", false);
+    Logger.logSingle(`${file.outputDocPath} processed.`, "green");
   });
   ErrorLogger.logErrors(filteredTypes);
 }
@@ -2807,9 +2809,8 @@ function filterByScopes(manifest) {
     "httpput"
   ]);
   const filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s), only keeping classes annotated as @RestResource.`;
-  Logger.clear();
-  Logger.logSingle(filteredLogMessage, false, "green", false);
-  Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, "green", false);
+  Logger.logSingle(filteredLogMessage, "green");
+  Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, "green");
   return filteredTypes;
 }
 
@@ -2889,8 +2890,8 @@ class Apexdocs {
    */
   static generate(config) {
     return __async$1(this, null, function* () {
-      Logger.logSingle("Initializing...", false);
-      Logger.startSpinner();
+      Logger.logSingle("Initializing...");
+      Logger.startSpinner("Processing files...");
       try {
         const fileBodies = ApexFileReader.processFiles(new DefaultFileSystem(), config.sourceDir, config.includeMetadata);
         switch (config.targetGenerator) {
@@ -2902,7 +2903,7 @@ class Apexdocs {
             break;
         }
       } finally {
-        Logger.stopSpinner();
+        Logger.succeedSpinner("Files processed.");
       }
     });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.0.0-alpha.4",
+  "version": "3.0.0-alpha.6",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -68,7 +68,7 @@
     "fp-ts": "^2.16.8",
     "handlebars": "^4.7.8",
     "js-yaml": "^4.1.0",
-    "log-update": "4.0.0",
+    "ora": "^5.4.1",
     "type-fest": "^4.23.0",
     "yargs": "^17.7.2"
   },

package/src/application/Apexdocs.ts

@@ -14,8 +14,8 @@ export class Apexdocs {
    * Generates documentation out of Apex source files.
    */
   static async generate(config: UserDefinedConfig): Promise<void> {
-    Logger.logSingle('Initializing...', false);
-    Logger.startSpinner();
+    Logger.logSingle('Initializing...');
+    Logger.startSpinner('Processing files...');
 
     try {
       const fileBodies = ApexFileReader.processFiles(new DefaultFileSystem(), config.sourceDir, config.includeMetadata);
@@ -29,7 +29,8 @@ export class Apexdocs {
           break;
       }
     } finally {
-      Logger.stopSpinner();
+      // TODO: Allow for failures
+      Logger.succeedSpinner('Files processed.');
     }
   }
 }

package/src/application/generators/markdown.ts

@@ -13,7 +13,7 @@ import { referenceGuideTemplate } from '../../core/markdown/templates/reference-
 import * as TE from 'fp-ts/TaskEither';
 import { isSkip } from '../../core/shared/utils';
 
-export default function generate(bundles: UnparsedSourceFile[], config: UserDefinedMarkdownConfig) {
+export default async function generate(bundles: UnparsedSourceFile[], config: UserDefinedMarkdownConfig) {
   return pipe(
     generateDocumentationBundle(bundles, config),
     TE.map((files) => writeFilesToSystem(files, config.targetDir)),
@@ -47,8 +47,9 @@ function writeFilesToSystem(files: PostHookDocumentationBundle, outputDir: strin
       // Filter out any files that should be skipped
       .filter((file) => !isSkip(file)) as PageData[],
     outputDir,
-    (file: PageData) => {
-      Logger.logSingle(`${file.outputDocPath} processed.`, false, 'green', false);
+    () => {
+      // TODO: Don't do this here, send things back up.
+      //Logger.logSingle(`${file.outputDocPath} processed.`, 'green');
     },
   );
 }

package/src/application/generators/openapi.ts

@@ -19,7 +19,7 @@ export default function openApi(fileBodies: UnparsedSourceFile[], config: UserDe
   const generatedFiles = processor.fileBuilder().files();
 
   FileWriter.write(generatedFiles, config.targetDir, (file: PageData) => {
-    Logger.logSingle(`${file.outputDocPath} processed.`, false, 'green', false);
+    Logger.logSingle(`${file.outputDocPath} processed.`, 'green');
   });
 
   // Error logging
@@ -48,9 +48,8 @@ function filterByScopes(manifest: Manifest) {
   const filteredLogMessage = `Filtered ${
     manifest.types.length - filteredTypes.length
   } file(s), only keeping classes annotated as @RestResource.`;
-  Logger.clear();
 
-  Logger.logSingle(filteredLogMessage, false, 'green', false);
-  Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
+  Logger.logSingle(filteredLogMessage, 'green');
+  Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, 'green');
   return filteredTypes;
 }

package/src/core/openapi/open-api-docs-processor.ts

@@ -25,7 +25,7 @@ export class OpenApiDocsProcessor {
   }
 
   onProcess(type: Type): void {
-    Logger.logSingle(`Processing ${type.name}`, false, 'green', false);
+    Logger.logSingle(`Processing ${type.name}`, 'green');
 
     const endpointPath = this.getEndpointPath(type);
     if (!endpointPath) {

package/src/util/logger.ts

@@ -1,14 +1,11 @@
 import chalk from 'chalk';
-import logUpdate from 'log-update';
-
+import ora from 'ora';
 /**
  * Logs messages to the console.
  */
 export class Logger {
   static currentFrame = 0;
-
-  static frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
-  static spinnerInterval: NodeJS.Timeout | null = null;
+  static spinner = ora();
 
   /**
    * Logs a message with optional arguments.
@@ -28,48 +25,33 @@ export class Logger {
    * @param args Optional arguments.
    */
   public static error(message: unknown, ...args: string[]) {
-    this.logSingle(message, false, 'red', false);
+    this.logSingle(message, 'red');
     args.forEach(() => {
-      this.logSingle(message, false, 'red', false);
+      this.logSingle(message, 'red');
     });
   }
 
-  public static logSingle(text: unknown, showSpinner = true, color: 'green' | 'red' = 'green', overrideConsole = true) {
+  public static logSingle(text: unknown, color: 'green' | 'red' = 'green') {
     if (this.currentFrame > 9) {
       this.currentFrame = 0;
     }
-    const spinner = showSpinner ? `${this.frames[this.currentFrame++]}` : '';
-    let logMessage;
-    if (color === 'green') {
-      logMessage = `${chalk.green(new Date().toLocaleString() + ': ')}${text}\n`;
-    } else {
-      logMessage = `${chalk.red(new Date().toLocaleString() + ': ')}${text}\n`;
-    }
-    if (overrideConsole) {
-      logUpdate(`${spinner} ${logMessage}`);
-    } else {
-      process.stdout.write(`${spinner} ${logMessage}`);
-    }
+
+    const logMessage = `${this.getChalkFn(color)(new Date().toLocaleString() + ': ')}${text}\n`;
+    process.stdout.write(logMessage);
   }
 
-  public static clear() {
-    logUpdate.clear();
+  private static getChalkFn(color: 'green' | 'red') {
+    return color === 'green' ? chalk.green : chalk.red;
   }
 
-  public static startSpinner() {
-    if (this.spinnerInterval) {
-      clearInterval(this.spinnerInterval);
-    }
-    this.spinnerInterval = setInterval(() => {
-      this.logSingle('Processing...', true, 'green', true);
-    }, 80);
+  // TODO: This isn't really working and I don't think its worth it. Let's just completely remove the ora dependency.
+
+  public static startSpinner(text: string) {
+    this.spinner.text = text;
+    this.spinner.start();
   }
 
-  public static stopSpinner() {
-    if (this.spinnerInterval) {
-      clearInterval(this.spinnerInterval);
-      this.spinnerInterval = null;
-      this.clear();
-    }
+  public static succeedSpinner(text: string) {
+    this.spinner.succeed(text);
   }
 }