@plugjs/plug 0.0.2 → 0.0.5

package/src/plugs/filter.ts

@@ -1,5 +1,4 @@
 import { Files } from '../files.js'
-import { log } from '../log.js'
 import { resolveRelativeChildPath } from '../paths.js'
 import { install, Plug } from '../pipe.js'
 import { Run } from '../run.js'
@@ -31,12 +30,12 @@ export class Filter implements Plug<Files> {
 
     for (const file of files.absolutePaths()) {
       const relative = resolveRelativeChildPath(builder.directory, file)
-      if (relative && matcher(relative)) builder.add(relative)
+      if (relative && matcher(relative)) builder.unchecked(relative)
     }
 
     const result = builder.build()
     const discarded = files.length - result.length
-    log.debug('Filtered', result.length, 'files (discarded', discarded, 'files)')
+    run.log.debug('Filtered', result.length, 'files (discarded', discarded, 'files)')
 
     return result
   }

package/src/plugs/rmf.ts

@@ -0,0 +1,42 @@
+import { Files } from '../files.js'
+import { $gry, $p } from '../log.js'
+import { install, Plug } from '../pipe.js'
+import { Run } from '../run.js'
+import { rm } from '../utils/asyncfs.js'
+
+/** Remove some files using globs. */
+export class Rmf implements Plug<undefined> {
+  private readonly _dryRun: boolean
+
+  constructor(dryRun?: boolean) {
+    this._dryRun = !! dryRun
+  }
+
+  async pipe(files: Files, run: Run): Promise<undefined> {
+    if (this._dryRun) {
+      for (const file of files.absolutePaths()) {
+        run.log.notice('Not removing file', $p(file), $gry('(dry-run)'))
+      }
+    } else {
+      for (const file of files.absolutePaths()) {
+        run.log.notice('Removing file', $p(file))
+        await rm(file)
+      }
+    }
+
+    return undefined
+  }
+}
+
+/* ========================================================================== *
+ * INSTALLATION                                                               *
+ * ========================================================================== */
+
+install('rmf', Rmf)
+
+declare module '../pipe.js' {
+  export interface Pipe {
+    /** Remove all {@link Files} piped in. */
+    rmf: PipeExtension<typeof Rmf>
+  }
+}

package/src/plugs.ts

@@ -31,3 +31,4 @@ export * from './plugs/debug.js'
 export * from './plugs/esbuild.js'
 export * from './plugs/exec.js'
 export * from './plugs/filter.js'
+export * from './plugs/rmf.js'

package/src/run.ts

@@ -51,8 +51,8 @@ export interface Run {
    * Resolve a path in the context of this {@link Run}.
    *
    * If the path starts with `@...` it is considered to be relative to the
-   * {@link process.cwd | current working directory}, otherwise it will be
-   * resolved against the build file where the task was originally defined in.
+   * _directory containing the build file where the task was defined_, otherwise
+   * it will be relative to the {@link process.cwd | current working directory}.
    */
   resolve(...paths: string[]): AbsolutePath
 
@@ -116,12 +116,12 @@ export class RunImpl implements Run {
     if (path.startsWith('@')) {
       const relative = path.substring(1)
       assert(! isAbsolutePath(relative), `Path component of "${path}" is absolute`)
-      return resolveAbsolutePath(getCurrentWorkingDirectory(), relative)
+      return resolveAbsolutePath(this.buildDir, relative)
     }
 
     if (isAbsolutePath(path)) return path
 
-    return resolveAbsolutePath(this.buildDir, path)
+    return resolveAbsolutePath(getCurrentWorkingDirectory(), path)
   }
 
   files(files: Files): FilesBuilder
@@ -142,7 +142,7 @@ export class RunImpl implements Run {
     const promise = Promise.resolve().then(async () => {
       const builder = this.files(directory || '.')
       for await (const file of walk(builder.directory, [ glob, ...params ], options)) {
-        builder.add(file)
+        builder.unchecked(file)
       }
       return builder.build()
     })

package/types/files.d.ts

@@ -1,13 +1,24 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" />
+/// <reference types="node" />
 import { inspect } from 'node:util';
 import { AbsolutePath } from './paths.js';
 /** The {@link FilesBuilder} interface defines a builder for {@link Files}. */
 export interface FilesBuilder {
     /** The (resolved) directory the {@link Files} will be associated with */
     readonly directory: AbsolutePath;
-    /** Push files into the {@link Files} instance being built */
+    /**
+     * Push files into the {@link Files} instance being built **checking for
+     * their existance on disk**.
+     *
+     * This _will_ be slow, use {@link FilesBuilder.unchecked} when absolutely
+     * sure the file already exist.
+     */
     add(...files: string[]): this;
+    /**
+     * Push files into the {@link Files} instance being built without checking
+     * they exist on disk _(use with care!)_.
+     */
+    unchecked(...files: string[]): this;
     /** Merge orther {@link Files} instance to the {@link Files} being built */
     merge(...files: Files[]): this;
     /** Write a file and add it to the {@link Files} instance being built */

package/types/helpers.d.ts

@@ -18,15 +18,15 @@ export declare function setLogLevel(level: LogLevelString): void;
  * Resolve a path into an {@link AbsolutePath}.
  *
  * If the path starts with `@...` it is considered to be relative to the
- * {@link process.cwd | current working directory}, otherwise it will be
- * resolved against the build file where the task was originally defined in.
+ * _directory containing the build file where the task was defined_, otherwise
+ * it will be relative to the {@link process.cwd | current working directory}.
  */
 export declare function resolve(...paths: string[]): AbsolutePath;
 /**
  * Create a new {@link Files} instance.
  */
 export declare function files(files: Files): FilesBuilder;
-export declare function files(...paths: string[]): FilesBuilder;
+export declare function files(directory: string, ...paths: string[]): FilesBuilder;
 /**
  * Merge multiple {@link Files} instance.
  */
@@ -37,13 +37,3 @@ export declare function merge(args: (Files | Promise<Files>)[]): Promise<Files>
 export declare function find(glob: string, ...args: ParseOptions<FindOptions>): Pipe & Promise<Files>;
 /** Create a {@link Pipe} from a {@link Files} instance. */
 export declare function pipe(files: Files | Promise<Files>): Pipe & Promise<Files>;
-/** Await for the settlement of all the promises, then return their results. */
-export declare function parallel<P extends readonly any[]>(promises: P): Promise<ParallelResult<P>>;
-declare type ParallelResult<T extends readonly any[]> = T extends readonly [infer First, ...infer Rest] ? [
-    Awaited<First>,
-    ...ParallelResult<Rest>
-] : T extends readonly [infer Only] ? [
-    Awaited<Only>
-] : T extends readonly [] ? [
-] : never;
-export {};

package/types/log/options.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" />
+/// <reference types="node" />
 import { Writable } from 'node:stream';
 import { InspectOptions } from 'node:util';
 import { LogLevel } from './levels.js';

package/types/plugs/rmf.d.ts

@@ -0,0 +1,15 @@
+import { Files } from '../files.js';
+import { Plug } from '../pipe.js';
+import { Run } from '../run.js';
+/** Remove some files using globs. */
+export declare class Rmf implements Plug<undefined> {
+    private readonly _dryRun;
+    constructor(dryRun?: boolean);
+    pipe(files: Files, run: Run): Promise<undefined>;
+}
+declare module '../pipe.js' {
+    interface Pipe {
+        /** Remove all {@link Files} piped in. */
+        rmf: PipeExtension<typeof Rmf>;
+    }
+}

package/types/plugs.d.ts

@@ -14,3 +14,4 @@ export * from './plugs/debug.js';
 export * from './plugs/esbuild.js';
 export * from './plugs/exec.js';
 export * from './plugs/filter.js';
+export * from './plugs/rmf.js';

package/types/run.d.ts

@@ -43,8 +43,8 @@ export interface Run {
      * Resolve a path in the context of this {@link Run}.
      *
      * If the path starts with `@...` it is considered to be relative to the
-     * {@link process.cwd | current working directory}, otherwise it will be
-     * resolved against the build file where the task was originally defined in.
+     * _directory containing the build file where the task was defined_, otherwise
+     * it will be relative to the {@link process.cwd | current working directory}.
      */
     resolve(...paths: string[]): AbsolutePath;
     /** Create a {@link FilesBuilder} cloning an existing {@link Files}. */

package/types/utils/asyncfs.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" />
 import { constants } from 'node:fs';
 import fsp from 'node:fs/promises';
 declare const fs: typeof fsp & {