@gesslar/bedoc 1.3.1 → 1.4.1

package/dist/types/core/Configuration.d.ts

@@ -1,4 +1,4 @@
-import { Environment } from './Core';
+import { EnvironmentType } from './Core';
 
 interface ConfigurationOption {
     value: unknown;
@@ -11,7 +11,7 @@ interface ConfigurationOptions {
 
 interface ValidateParams {
     options: ConfigurationOptions;
-    source: typeof Environment;
+    source: EnvironmentType;
 }
 
 interface ValidationResult {

package/dist/types/core/Logger.d.ts

@@ -10,6 +10,14 @@ interface LoggerOptions {
 type LogLevel = 'debug' | 'warn' | 'info' | 'error';
 type DebugLevel = 0 | 1 | 2 | 3 | 4;
 
+export declare const loggerColours: {
+    debug: string[];
+    info: string;
+    warn: string;
+    error: string;
+    reset: string;
+};
+
 /**
  * Logger class
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gesslar/bedoc",
-  "version": "1.3.1",
+  "version": "1.4.1",
   "description": "Pluggable documentation engine for any language and format",
   "publisher": "gesslar",
   "main": "./src/core/Core.js",

package/src/cli.js

@@ -75,6 +75,11 @@ const {resolveDirectory} = FDUtil
     const filesToProcess = bedoc.options.input.map(f => f.absolutePath)
     const result = await bedoc.processFiles(filesToProcess)
     const errored = result.errored
+    const warned = result.warned
+
+    if(warned.length > 0)
+      warned.forEach(w => bedoc.logger.warn(w.warning))
+
     if(errored.length > 0)
       throw new AggregateError(errored.map(e => e.error), "Error processing files")
   } catch(error) {

package/src/core/Conveyor.js

@@ -6,6 +6,7 @@ const {readFile, writeFile, composeFilename} = FDUtil
 
 export default class Conveyor {
   #succeeded = []
+  #warned  = []
   #errored = []
 
   constructor(parse, print, logger, output) {
@@ -33,8 +34,10 @@ export default class Conveyor {
       const slot = Promise.race(semaphore) // Wait for an available slot
       semaphore.push(slot.then(async() => {
         const result = await this.#processFile(file)
-        if(result.status === "success" || result.status === "warning")
+        if(result.status === "success")
           this.#succeeded.push({input: file, output: result.file})
+        else if(result.status === "warning")
+          this.#warned.push({input: file, warning: result.warning})
         else {
           this.#errored.push({input: file, error: result.error})
         }
@@ -49,7 +52,11 @@ export default class Conveyor {
     await this.parse.cleanupAction()
     await this.print.cleanupAction()
 
-    return {succeeded: this.#succeeded, errored: this.#errored}
+    return {
+      succeeded: this.#succeeded,
+      errored: this.#errored,
+      warned: this.#warned
+    }
   }
 
   /**
@@ -78,7 +85,15 @@ export default class Conveyor {
       if(parseResult.status === "error")
         return parseResult
 
-      debug("Parsed file successfully: `%s`", 2, file.path)
+      if(parseResult.status === "warning")
+        debug("Parsed file successfully, but with warnings: `%s`", 2, file.path)
+      else
+        debug("Parsed file successfully: `%s`", 2, file.path)
+
+      if(!parseResult.result?.functions?.length) {
+        const mess = format("No functions found in `%s`. No file written.", file.path)
+        return {status: "warning", file, warning: mess}
+      }
 
       // Step 3: Print file
       const printResult = await print.runAction({

package/src/core/Core.js

@@ -2,7 +2,7 @@ import process from "node:process"
 
 import Discovery from "./Discovery.js"
 import HookManager from "./HookManager.js"
-import Logger from "./Logger.js"
+import Logger, {loggerColours} from "./Logger.js"
 import ParseManager from "./action/ParseManager.js"
 import PrintManager from "./action/PrintManager.js"
 import Conveyor from "./Conveyor.js"
@@ -149,11 +149,21 @@ export default class Core {
 
     // Grab the results
     const totalFiles = input.length
-    const errored = result.errored
     const succeeded = result.succeeded
+    const warned = result.warned
+    const errored = result.errored
+
+    const {
+      info: succeedColour, warn: warnColour, error: errorColour, reset
+    } = loggerColours
+
+
+    const success = `${succeedColour}${succeeded.length}${reset}`
+    const warn = `${warnColour}${warned.length}${reset}`
+    const error = `${errorColour}${errored.length}${reset}`
 
-    const message = `Processed ${totalFiles} files: ${succeeded.length} succeeded, ${errored.length} errored ` +
-      `in ${processEnd}ms [total: ${endTime}ms]`
+    const message = `Processed ${totalFiles} files: ${success} succeeded, ${error} errored, ` +
+      `${warn} warned in ${processEnd}ms [total: ${endTime}ms]`
 
     this.logger.debug(message, 1)
 

package/src/core/Logger.js

@@ -33,7 +33,7 @@ import * as StringUtil from "./util/StringUtil.js"
 const {resolveFilename} = FDUtil
 const {capitalize} = StringUtil
 
-const loggerColours = {
+export const loggerColours = {
   debug: [
     "\x1b[38;5;19m", // Debug level 0: Dark blue
     "\x1b[38;5;27m", // Debug level 1: Medium blue