@plugjs/plug 0.0.2 → 0.0.3

package/types/files.d.ts

@@ -6,8 +6,19 @@ import { AbsolutePath } from './paths.js';
 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.
  */

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}. */