@plugjs/plug 0.4.7 → 0.4.8

package/src/logging/emit.ts

@@ -40,8 +40,8 @@ export type LogEmitter = (options: LogEmitterOptions, args: any[]) => void
 
 /* ========================================================================== */
 
-/** Emit in full colors! */
-export const emitColor: LogEmitter = (options: LogEmitterOptions, args: any[]): void => {
+/** Emit in full colors with spinner support and whatnot! */
+export const emitFancy: LogEmitter = (options: LogEmitterOptions, args: any[]): void => {
   const { taskName, level, prefix = '', indent = 0 } = options
   const logPrefix = ''.padStart(indent * _indentSize) + prefix
 
@@ -50,7 +50,7 @@ export const emitColor: LogEmitter = (options: LogEmitterOptions, args: any[]):
 
   /* Task name or blank padding */
   prefixes.push(''.padStart(_taskLength - taskName.length, ' ')) // padding
-  prefixes.push(`${$t(taskName)}`) // task name
+  prefixes.push(`${$t(taskName, false)}`) // task name
 
   /* Level indicator (our little colorful squares) */
   if (level <= TRACE) {
@@ -83,7 +83,7 @@ export const emitColor: LogEmitter = (options: LogEmitterOptions, args: any[]):
 
 /* ========================================================================== */
 
-/** Emit in plain text! (no colors) */
+/** Emit in plain text (maybe with some colors?) */
 export const emitPlain: LogEmitter = (options: LogEmitterOptions, args: any[]): void => {
   const { taskName, level, prefix = '', indent = 0 } = options
   const logPrefix = ''.padStart(indent * _indentSize) + prefix
@@ -91,20 +91,20 @@ export const emitPlain: LogEmitter = (options: LogEmitterOptions, args: any[]):
   const prefixes: string[] = []
 
   const pad = ''.padStart(_taskLength - taskName.length, ' ')
-  prefixes.push(`${pad}${taskName}`)
+  prefixes.push(`${pad}${$t(taskName, false)}`)
 
   if (level <= TRACE) {
-    prefixes.push(' \u2502  trace \u2502 ')
+    prefixes.push(` ${$gry('\u2502')} ${$gry(' trace')} ${$gry('\u2502')} `)
   } else if (level <= DEBUG) {
-    prefixes.push(' \u2502  debug \u2502 ')
+    prefixes.push(` ${$gry('\u2502')} ${$gry(' debug')} ${$gry('\u2502')} `)
   } else if (level <= INFO) {
-    prefixes.push(' \u2502   info \u2502 ')
+    prefixes.push(` ${$gry('\u2502')} ${$grn('  info')} ${$gry('\u2502')} `)
   } else if (level <= NOTICE) {
-    prefixes.push(' \u2502 notice \u2502 ')
+    prefixes.push(` ${$gry('\u2502')} ${$blu('notice')} ${$gry('\u2502')} `)
   } else if (level <= WARN) {
-    prefixes.push(' \u2502   warn \u2502 ')
+    prefixes.push(` ${$gry('\u2502')} ${$ylw('  warn')} ${$gry('\u2502')} `)
   } else {
-    prefixes.push(' \u2502  error \u2502 ')
+    prefixes.push(` ${$gry('\u2502')} ${$red(' error')} ${$gry('\u2502')} `)
   }
 
   /* The prefix (task name and level) */

package/src/logging/github.ts

@@ -5,14 +5,17 @@ import { logOptions } from './options'
 
 import type { AbsolutePath } from '../paths'
 
+/* Strip ANSI from strings */
+const ansiRegExp = new RegExp([
+  '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
+  '(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-nq-uy=><~]))',
+].join('|'), 'g')
 
 /* Initial values, and subscribe to changes */
-let _colors = logOptions.colors
 let _output = logOptions.output
 let _inspectOptions = logOptions.inspectOptions
 let _githubAnnotations = logOptions.githubAnnotations
 logOptions.on('changed', (options) => {
-  _colors = options.colors
   _output = options.output
   _githubAnnotations = options.githubAnnotations
   _inspectOptions = { ...options.inspectOptions, breakLength: Infinity }
@@ -21,6 +24,7 @@ logOptions.on('changed', (options) => {
 
 function escapeData(data: string): string {
   return data
+      .replace(ansiRegExp, '')
       .replace(/%/g, '%25')
       .replace(/\r/g, '%0D')
       .replace(/\n/g, '%0A')
@@ -28,6 +32,7 @@ function escapeData(data: string): string {
 
 function escapeProp(prop: string | number): string {
   return `${prop}`
+      .replace(ansiRegExp, '')
       .replace(/%/g, '%25')
       .replace(/\r/g, '%0D')
       .replace(/\n/g, '%0A')
@@ -51,7 +56,7 @@ export function githubAnnotation(type: GithubAnnotationType, message: string, ..
 export function githubAnnotation(options: GithubAnnotationOptions, message: string, ...args: any[]): void
 
 export function githubAnnotation(options: GithubAnnotationType | GithubAnnotationOptions, ...args: any[]): void {
-  if (_colors || (! _githubAnnotations)) return
+  if (! _githubAnnotations) return
 
   if (typeof options === 'string') options = { type: options }
   const { type, ...parameters } = options

package/src/logging/logger.ts

@@ -1,7 +1,7 @@
 import { formatWithOptions } from 'node:util'
 
 import { BuildFailure } from '../asserts'
-import { emitColor, emitPlain } from './emit'
+import { emitFancy, emitPlain } from './emit'
 import { DEBUG, ERROR, INFO, NOTICE, TRACE, WARN } from './levels'
 import { logOptions } from './options'
 import { ReportImpl } from './report'
@@ -16,11 +16,11 @@ import type { Report } from './report'
 
 /* Initial value of log colors, and subscribe to changes */
 let _level = logOptions.level
-let _colors = logOptions.colors
+let _format = logOptions.format
 let _defaultTaskName = logOptions.defaultTaskName
-logOptions.on('changed', ({ defaultTaskName, colors, level }) => {
+logOptions.on('changed', ({ defaultTaskName, format, level }) => {
   _defaultTaskName = defaultTaskName
-  _colors = colors
+  _format = format
   _level = level
 })
 
@@ -67,7 +67,7 @@ export interface Logger extends Log {
 export function getLogger(task: string = _defaultTaskName): Logger {
   let logger = _loggers.get(task)
   if (! logger) {
-    const emitter = _colors ? emitColor : emitPlain
+    const emitter = _format === 'fancy' ? emitFancy : emitPlain
     logger = new LoggerImpl(task, emitter)
     _loggers.set(task, logger)
   }

package/src/logging/options.ts

@@ -18,6 +18,8 @@ export interface LogOptions {
   level: LogLevel,
   /** Whether to log in colors or not. */
   colors: boolean,
+  /** The format of the log to use: `plain` or `fancy`. */
+  format: 'plain' | 'fancy',
   /** Whether to enable the tasks spinner or not. */
   spinner: boolean,
   /** Width of the current terminal (if any) or `80`. */
@@ -62,6 +64,7 @@ class LogOptionsImpl extends EventEmitter implements LogOptions {
   private _output: Writable = process.stderr
   private _level: LogLevel = NOTICE
   private _colors = (<NodeJS.WriteStream> this._output).isTTY
+  private _format: 'fancy' | 'plain' = this._colors ? 'fancy' : 'plain'
   private _colorsSet = false // have colors been set manually?
   private _spinner = true // by default, the spinner is enabled
   private _lineLength = (<NodeJS.WriteStream> this._output).columns || 80
@@ -88,8 +91,13 @@ class LogOptionsImpl extends EventEmitter implements LogOptions {
       // Other values don't change the value of `options.colors`
     }
 
-    /* If the `GITHUB_ACTIONS` is `true` then enable annotations */
+    /* If the `GITHUB_ACTIONS` is `true` then enable annotations and use plain logs */
     this._githubAnnotations = process.env.GITHUB_ACTIONS === 'true'
+    if (this._githubAnnotations) {
+      this._colors = true
+      this._format = 'plain'
+      this._spinner = false
+    }
 
     /*
      * The `__LOG_OPTIONS` variable is a JSON-serialized `LogOptions` object
@@ -154,6 +162,15 @@ class LogOptionsImpl extends EventEmitter implements LogOptions {
     this._notifyListeners()
   }
 
+  get format(): 'plain' | 'fancy' {
+    return this._format
+  }
+
+  set format(format: 'plain' | 'fancy') {
+    this._format = format === 'fancy' ? 'fancy' : 'plain'
+    this._notifyListeners()
+  }
+
   get spinner(): boolean {
     return this._spinner
   }

package/src/logging/spinner.ts

@@ -14,11 +14,13 @@ export const zapSpinner = '\u001b[0G\u001b[2K'
 /* Initial value of log colors, and subscribe to changes */
 let _output = logOptions.output
 let _colors = logOptions.colors
+let _format = logOptions.format
 let _spinner = logOptions.spinner
 let _taskLength = logOptions.taskLength
-logOptions.on('changed', ({ output, colors, spinner, taskLength }) => {
+logOptions.on('changed', ({ output, colors, format, spinner, taskLength }) => {
   _output = output
   _colors = colors
+  _format = format
   _spinner = spinner
   _taskLength = taskLength
   setupSpinner()
@@ -68,5 +70,7 @@ function spin(): void {
 /* Start or stop the spinner */
 export function setupSpinner(): void {
   if (_interval) clearInterval(_interval)
-  if (_colors && _spinner) _interval = setInterval(spin, 150).unref()
+  if (_colors && _spinner && (_format === 'fancy')) {
+    _interval = setInterval(spin, 150).unref()
+  }
 }

package/src/plugs/esbuild.ts

@@ -15,7 +15,10 @@ import type { Logger, ReportLevel, ReportRecord } from '../logging'
 import type { AbsolutePath } from '../paths'
 import type { Context, PipeParameters, Plug } from '../pipe'
 
-export type ESBuildOptions = Omit<BuildOptions, 'absWorkingDir' | 'entryPoints' | 'watch'>
+export type ESBuildOptions = Omit<BuildOptions, 'absWorkingDir' | 'entryPoints' | 'watch'> & {
+  /** Add support for `__filename` and `__dirname` in ESM modules (default: `true`). */
+  enableEsmPathHelpers?: boolean
+}
 
 export * from './esbuild/bundle-locals'
 export * from './esbuild/fix-extensions'
@@ -46,6 +49,7 @@ install('esbuild', class ESBuild implements Plug<Files> {
   async pipe(files: Files, context: Context): Promise<Files> {
     const entryPoints = [ ...files ]
     const absWorkingDir = files.directory
+    const { enableEsmPathHelpers = true, ...esbuildOptions } = this._options
 
     const options: BuildOptions = {
       /* Default our platform/target to NodeJS, current major version */
@@ -59,7 +63,7 @@ install('esbuild', class ESBuild implements Plug<Files> {
       outbase: absWorkingDir,
 
       /* Merge in the caller's options */
-      ...this._options,
+      ...esbuildOptions,
 
       /* Always override */
       absWorkingDir,
@@ -71,6 +75,20 @@ install('esbuild', class ESBuild implements Plug<Files> {
       options.define = Object.assign({ __fileurl: '__filename' }, options.define)
     } else if (options.format === 'esm') {
       options.define = Object.assign({ __fileurl: 'import.meta.url' }, options.define)
+
+      /* If enabled, add support for `__filename` and `__dirname` in ESM */
+      if (enableEsmPathHelpers) {
+        options.define['__dirname'] = '__$$_esm_paths_helper.__dirname'
+        options.define['__filename'] = '__$$_esm_paths_helper.__filename'
+        options.banner = { ...options.banner,
+          js: (options.banner?.js || '') +
+            ';const __$$_esm_paths_helper = await (async() => {\n' +
+            '  const __filename = (await import("node:url")).fileURLToPath(import.meta.url);\n' +
+            '  const __dirname = (await import("node:path")).dirname(__filename);\n' +
+            '  return { __filename, __dirname };\n' +
+            '})();',
+        }
+      }
     }
 
     /* Sanity check on output file/directory */