@plugjs/plug 0.0.14 → 0.0.16

package/src/helpers.ts

@@ -1,32 +1,61 @@
-import {
-  AbsolutePath,
-  commonPath,
-  getCurrentWorkingDirectory,
-  resolveDirectory,
-  resolveFile,
-} from './paths.js'
+import { assert } from './assert'
+import { requireContext } from './async'
+import { Files } from './files'
+import { $p, log } from './log'
+import { AbsolutePath, getCurrentWorkingDirectory, resolveDirectory, resolveFile } from './paths'
+import { Pipe } from './pipe'
+import { rm } from './utils/asyncfs'
+import { ParseOptions, parseOptions } from './utils/options'
+import { walk, WalkOptions } from './utils/walk'
+
+/* ========================================================================== *
+ * EXTERNAL HELPERS                                                           *
+ * ========================================================================== */
+
+/** The {@link FindOptions} interface defines the options for finding files. */
+export interface FindOptions extends WalkOptions {
+  /** The directory where to start looking for files. */
+  directory?: string
+}
 
-import { assert } from './assert.js'
-import { currentRun } from './async.js'
-import { Files, FilesBuilder } from './files.js'
-import { $p, log, LogLevelString } from './log.js'
-import { Pipe } from './pipe.js'
-import { FindOptions } from './run.js'
-import { rm } from './utils/asyncfs.js'
-import { ParseOptions } from './utils/options.js'
+/** Find files in the current directory using the specified _glob_. */
+export function find(glob: string): Pipe
+/** Find files in the current directory using the specified _globs_. */
+export function find(glob: string, ...globs: string[]): Pipe
+/** Find files using the specified _glob_ and {@link FindOptions | options}. */
+export function find(glob: string, options: FindOptions): Pipe
+/** Find files using the specified _globs_ and {@link FindOptions | options}. */
+export function find(glob: string, ...extra: [...globs: string[], options: FindOptions]): Pipe
+/* Overload */
+export function find(...args: ParseOptions<FindOptions>): Pipe {
+  const { params: globs, options } = parseOptions(args, {})
+
+  const context = requireContext()
+  return new Pipe(context, async (): Promise<Files> => {
+    const directory = options.directory ?
+      context.resolve(options.directory) :
+      getCurrentWorkingDirectory()
+
+    const builder = Files.builder(directory)
+    for await (const file of walk(directory, globs, options)) {
+      builder.add(file)
+    }
+
+    return builder.build()
+  })
+}
 
 /**
  * Recursively remove the specified directory _**(use with care)**_.
  */
 export async function rmrf(directory: string): Promise<void> {
-  const run = currentRun()
-  assert(run, 'Unable to find files outside a running task')
-  const dir = run.resolve(directory)
+  const context = requireContext()
+  const dir = context.resolve(directory)
 
   assert(dir !== getCurrentWorkingDirectory(),
       `Cowardly refusing to wipe current working directory ${$p(dir)}`)
 
-  assert(dir !== run.buildDir,
+  assert(dir !== context.resolve('@'),
       `Cowardly refusing to wipe build file directory ${$p(dir)}`)
 
   if (! resolveDirectory(dir)) {
@@ -39,95 +68,33 @@ export async function rmrf(directory: string): Promise<void> {
 }
 
 /**
- * Set the current _log level_.
+ * Resolve a (set of) path(s) into an {@link AbsolutePath}.
  *
- * The _level_ will be applied _only_ within the execution of the current task.
+ * If the path (or first component thereof) starts with `@...`, then the
+ * resolved path will be relative to the directory containing the build file
+ * where the current task was defined, otherwise it will be relative to the
+ * current working directory.
  */
-export function setLogLevel(level: LogLevelString): void {
-  const run = currentRun()
-  assert(run, 'Unable to find files outside a running task')
-  return run.setLogLevel(level)
+export function resolve(...paths: [ string, ...string[] ]): AbsolutePath {
+  return requireContext().resolve(...paths)
 }
 
 /**
- * Resolve a path into an {@link AbsolutePath}.
+ * Return an absolute path of the file if it exist on disk.
  *
- * If the path starts with `@...` it is considered to be relative to the
- * _directory containing the build file where the task was defined_, otherwise
- * it will be relative to the {@link process.cwd | current working directory}.
- */
-export function resolve(...paths: string[]): AbsolutePath {
-  const run = currentRun()
-  assert(run, 'Unable to find files outside a running task')
-  return run.resolve(...paths)
-}
-
-
-/**
- * Create a new {@link Files} instance.
+ * See the comments on {@link resolve} to understand how paths are resolved.
  */
-export function files(files: Files): FilesBuilder
-export function files(directory: string, ...paths: string[]): FilesBuilder
-export function files(first: Files | string | undefined, ...paths: string[]): FilesBuilder {
-  const run = currentRun()
-  assert(run, 'Unable to create files builder outside a running task')
-  if (typeof first === 'string') {
-    return run.files(first, ...paths)
-  } else if (first) {
-    return run.files(first)
-  } else {
-    return run.files()
-  }
+export function isFile(...paths: [ string, ...string[] ]): AbsolutePath | undefined {
+  const path = requireContext().resolve(...paths)
+  return resolveFile(path)
 }
 
 /**
- * Merge multiple {@link Files} instance.
- */
-export function merge(args: (Files | Promise<Files>)[]): Promise<Files> & Pipe {
-  const run = currentRun()
-  assert(run, 'Unable to create files builder outside a running task')
-
-  const promise = Promise.resolve().then(async () => {
-    // No arguments, no files... Just convenience!
-    if (args.length === 0) return run.pipe(run.files().build())
-
-    // Resolve all the `Files` instances (might be from other tasks)
-    const instances = await Promise.all(args)
-    const [ first, ...others ] = instances
-
-    const firstDir = first.directory
-    const otherDirs = others.map((f) => f.directory)
-
-    const directory = commonPath(firstDir, ...otherDirs)
-
-    return run.files(directory).merge(first, ...others).build()
-  })
-
-  return run.pipe(promise)
-}
-
-/**
- * Find files according to the globs and {@link FindOptions} specified.
+ * Return an absolute path of the directory if it exist on disk.
+ *
+ * See the comments on {@link resolve} to understand how paths are resolved.
  */
-export function find(glob: string, ...args: ParseOptions<FindOptions>): Pipe & Promise<Files> {
-  const run = currentRun()
-  assert(run, 'Unable to find files outside a running task')
-  return run.find(glob, ...args)
-}
-
-/** Create a {@link Pipe} from a {@link Files} instance. */
-export function pipe(files: Files | Promise<Files>): Pipe & Promise<Files> {
-  const run = currentRun()
-  assert(run, 'Unable to create pipes outside a running task')
-  return run.pipe(files)
-}
-
-/** Return an absolute path of the file if it exist on disk */
-export function isFile(...paths: string[]): AbsolutePath | undefined {
-  return resolveFile(resolve(...paths))
-}
-
-/** Return an absolute path of the file if it exist on disk */
-export function isDirectory(...paths: string[]): AbsolutePath | undefined {
-  return resolveDirectory(resolve(...paths))
+export function isDirectory(...paths: [ string, ...string[] ]): AbsolutePath | undefined {
+  const path = requireContext().resolve(...paths)
+  return resolveDirectory(path)
 }

package/src/index.ts

@@ -1,20 +1,15 @@
 /// <reference path="../extra/webassembly.d.ts" />
 
-// Our minimal exports
-export * from './assert.js'
-export * from './build.js'
-export * from './plugs.js'
-export * from './log.js'
-export * from './helpers.js'
+export type { AbsolutePath } from './paths'
+export type { Files, FilesBuilder } from './files'
+export { Pipe } from './pipe'
 
-// Utility types
-export type { MatchOptions, MatchResult } from './utils/match.js'
-export type { ParseOptions } from './utils/options.js'
-export type { WalkOptions } from './utils/walk.js'
+// Our minimal exports
+export * from './assert'
+export * from './build'
+export * from './helpers'
+export * from './log'
 
 // PlugJS types
-export type { AbsolutePath } from './paths.js'
-export type { Files, FilesBuilder } from './files.js'
-export type { FindOptions, Run } from './run.js'
-export type { Pipe, Plug, PlugFunction } from './pipe.js'
-export type { Task } from './task.js'
+export * from './plugs'
+export * from './types'

package/src/log/colors.ts

@@ -1,6 +1,6 @@
 import { sep } from 'node:path'
-import { AbsolutePath, getCurrentWorkingDirectory, resolveRelativeChildPath } from '../paths.js'
-import { logOptions } from './options.js'
+import { AbsolutePath, getCurrentWorkingDirectory, resolveRelativeChildPath } from '../paths'
+import { logOptions } from './options'
 
 /* ========================================================================== */
 
@@ -49,7 +49,7 @@ export function $t(task: string): string {
 }
 
 /** Colorize milliseconds. */
-export function $ms(millis: number): string {
+export function $ms(millis: number, note?: string): string {
   let string: string
   if (millis >= 60000) {
     // One minute or more: style is Xm Ys
@@ -70,6 +70,7 @@ export function $ms(millis: number): string {
     // Milliseconds: style is 123ms
     string = `${millis}ms`
   }
+  if (note) string = `${note} ${string}`
   return _colors ? `${gry}[${string}]${rst}` : `[${string}]`
 }
 

package/src/log/emit.ts

@@ -1,8 +1,8 @@
 import { formatWithOptions } from 'node:util'
-import { $blu, $grn, $gry, $red, $t, $ylw } from './colors.js'
-import { DEBUG, INFO, LogLevel, NOTICE, TRACE, WARN } from './levels.js'
-import { logOptions } from './options.js'
-import { zapSpinner } from './spinner.js'
+import { $blu, $grn, $gry, $red, $t, $ylw } from './colors'
+import { DEBUG, INFO, LogLevel, NOTICE, TRACE, WARN } from './levels'
+import { logOptions } from './options'
+import { zapSpinner } from './spinner'
 
 /* ========================================================================== */
 

package/src/log/logger.ts

@@ -1,7 +1,8 @@
-import { isBuildError, isBuildFailure } from '../assert.js'
-import { emitColor, emitPlain, LogEmitter } from './emit.js'
-import { DEBUG, ERROR, INFO, LogLevel, NOTICE, TRACE, WARN } from './levels.js'
-import { logOptions } from './options.js'
+import { isBuildError, isBuildFailure } from '../assert'
+import { emitColor, emitPlain, LogEmitter } from './emit'
+import { DEBUG, ERROR, INFO, LogLevel, NOTICE, TRACE, WARN } from './levels'
+import { logOptions } from './options'
+import { Report, ReportImpl } from './report'
 
 /* ========================================================================== */
 
@@ -48,6 +49,8 @@ export interface Logger extends Log {
   leave(): this
   /** Leave a sub-level of logging, decreasing indent */
   leave(level: LogLevel, message: string): this
+  /** Create a {@link Report} associated with this instance */
+  report(title: string): Report
 }
 
 /** Return a {@link Logger} associated with the specified task name. */
@@ -149,6 +152,7 @@ class LoggerImpl implements Logger {
       const [ level, message ] = args
       this._stack.push({ level, message, indent: this._indent })
     }
+
     this._indent ++
     return this
   }
@@ -168,4 +172,8 @@ class LoggerImpl implements Logger {
 
     return this
   }
+
+  report(title: string): Report {
+    return new ReportImpl(title, this._task, this._emitter)
+  }
 }

package/src/log/options.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'node:events'
 import { Writable } from 'node:stream'
 import { InspectOptions } from 'node:util'
-import { getLevelNumber, LogLevel, LogLevelString, NOTICE } from './levels.js'
+import { getLevelNumber, LogLevel, LogLevelString, NOTICE } from './levels'
 
 /* ========================================================================== */
 

package/src/log/report.ts

@@ -1,21 +1,13 @@
-import { fail, failure } from '../assert.js'
-import { AbsolutePath } from '../paths.js'
-import { readFile } from '../utils/asyncfs.js'
-import { $blu, $cyn, $gry, $red, $und, $wht, $ylw } from './colors.js'
-import { emitColor, emitPlain, LogEmitter } from './emit.js'
-import { ERROR, LogLevels, NOTICE, WARN } from './levels.js'
-import { logOptions } from './options.js'
+import { fail, failure } from '../assert'
+import { AbsolutePath } from '../paths'
+import { readFile } from '../utils/asyncfs'
+import { $blu, $cyn, $gry, $red, $und, $wht, $ylw } from './colors'
+import { LogEmitter } from './emit'
+import { ERROR, LogLevels, NOTICE, WARN } from './levels'
+import { logOptions } from './options'
 
 /* ========================================================================== */
 
-/* Track changes for colors */
-let _colors = logOptions.colors
-logOptions.on('changed', ({ colors }) => {
-  _colors = colors
-})
-
-/* ========================================================================== *
-
 /** Levels used in a {@link Report}  */
 export type ReportLevel = LogLevels['NOTICE' | 'WARN' | 'ERROR']
 
@@ -91,12 +83,6 @@ export interface Report {
   done(showSources?: boolean | undefined): void
 }
 
-/** Create a new {@link Report} with the given title */
-export function createReport(title: string, taskName: string): Report {
-  const emitter = _colors ? emitColor : emitPlain
-  return new ReportImpl(title, taskName, emitter)
-}
-
 /* ========================================================================== *
  * REPORT IMPLEMENTATION                                                      *
  * ========================================================================== */
@@ -118,7 +104,7 @@ interface ReportInternalAnnotation {
   readonly note: string
 }
 
-class ReportImpl implements Report {
+export class ReportImpl implements Report {
   private readonly _sources = new Map<AbsolutePath, string[]>()
   private readonly _annotations = new Map<AbsolutePath, ReportInternalAnnotation>()
   private readonly _records = new Map<AbsolutePath | Null, Set<ReportInternalRecord>>()

package/src/log/spinner.ts

@@ -1,6 +1,6 @@
-import { runningTasks } from '../async.js'
-import { $cyn, $gry, $t } from './colors.js'
-import { logOptions } from './options.js'
+import { runningTasks } from '../async'
+import { $cyn, $gry, $t } from './colors'
+import { logOptions } from './options'
 
 /* ========================================================================== */
 

package/src/log.ts

@@ -1,12 +1,12 @@
-import { currentRun } from './async.js'
-import { getLogger, Log } from './log/logger.js'
-import { setupSpinner } from './log/spinner.js'
+import { currentContext } from './async'
+import { getLogger, Log } from './log/logger'
+import { setupSpinner } from './log/spinner'
 
-export * from './log/colors.js'
-export * from './log/levels.js'
-export * from './log/logger.js'
-export * from './log/options.js'
-export * from './log/report.js'
+export * from './log/colors'
+export * from './log/levels'
+export * from './log/logger'
+export * from './log/options'
+export * from './log/report'
 
 /* ========================================================================== *
  * INITIALIZATION                                                             *
@@ -25,7 +25,7 @@ export type LogFunction = ((...args: [ any, ...any ]) => void) & Log
 /** Our logging function (defaulting to the `NOTICE` level) */
 export const log: LogFunction = ((): LogFunction => {
   /* Return either the current run's log, or the default task's logger */
-  const logger = (): Log => (currentRun()?.log || getLogger())
+  const logger = (): Log => (currentContext()?.log || getLogger())
 
   /* Create a Logger wrapping the current logger */
   const wrapper: Log = {

package/src/paths.ts

@@ -2,7 +2,7 @@ import { statSync } from 'node:fs'
 import { createRequire } from 'node:module'
 import { dirname, extname, isAbsolute, join, normalize, relative, resolve, sep } from 'node:path'
 import { fileURLToPath, pathToFileURL } from 'node:url'
-import { assert } from './assert.js'
+import { assert } from './assert'
 
 /** A _branded_ `string` representing an _absolute_ path name */
 export type AbsolutePath = string & { __brand_absolute_path: never }