mem-fs-editor 10.0.2 → 11.0.0

package/README.md

@@ -104,7 +104,7 @@ Copy the `from` file and, if it is not a binary file, parse its content as an [e
 
 You can optionally pass a `templateOptions` object. `mem-fs-editor` automatically setup the filename option so you can easily use partials.
 
-You can also optionally pass a `copyOptions` object (see [copy() documentation for more details](#copyfrom-to-options)).
+You can also optionally pass a `copyOptions` object (see [copy() documentation for more details](#copyfrom-to-options-context-templateoptions-)).
 
 Templates syntax looks like this:
 
@@ -139,14 +139,17 @@ Move/rename a file from the `from` path to the `to` path.
 
 Returns `true` if a file exists. Returns `false` if the file is not found or deleted.
 
-### `#commit([filters,] [stream,] callback)`
+### `#commit([options,] [...transforms])`
 
-Persist every changes made to files in the mem-fs store to disk.
+Pass stored files through a pipeline and persist every changes made to files in the mem-fs store to disk.
 
-If provided, `filters` is an array of TransformStream to be applied on a stream of vinyl files (like gulp plugins).
-If provided, `stream` is a stream of vinyl files.
+If provided, `options` is the pipeline options.
+By default only modified files are passed through the pipeline.
+Pass a custom filter `options.filter` to customize files passed through the pipeline.
+If provided, `...transforms` is a vararg of TransformStream to be applied on a stream of vinyl files (like gulp plugins).
+`commitTransform` is appended to `transforms` and persists modified files to disk, non modified files are passed through.
 
-`callback` is called once the files are updated on disk.
+returns promise that is resolved once the pipeline is finished.
 
 ### `#dump([cwd,] [filter])`
 

package/dist/actions/commit-file-async.d.ts

@@ -1,2 +1,2 @@
-import type { MemFsEditor, MemFsEditorFile } from '../index.js';
-export default function commitFileAsync<EditorFile extends MemFsEditorFile>(this: MemFsEditor<EditorFile>, file: EditorFile): Promise<void>;
+import type { MemFsEditorFile } from '../index.js';
+export default function commitFileAsync<EditorFile extends MemFsEditorFile>(file: EditorFile): Promise<void>;

package/dist/actions/commit-file-async.js

@@ -1,6 +1,6 @@
 import fs from 'fs/promises';
 import path from 'path';
-import { clearFileState, isFileStateModified, isFileStateDeleted, setCommittedFile } from '../state.js';
+import { clearFileState, isFileStateModified, isFileStateDeleted, setCommittedFile, isFileNew } from '../state.js';
 async function write(file) {
     if (!file.contents) {
         throw new Error(`${file.path} cannot write an empty file`);
@@ -34,15 +34,11 @@ async function remove(file) {
     await remove(file.path, { recursive: true });
 }
 export default async function commitFileAsync(file) {
-    const existingFile = this.store.get(file.path);
-    if (!existingFile || existingFile !== file) {
-        this.store.add(file);
-    }
     if (isFileStateModified(file)) {
         setCommittedFile(file);
         await write(file);
     }
-    else if (isFileStateDeleted(file)) {
+    else if (isFileStateDeleted(file) && !isFileNew(file)) {
         setCommittedFile(file);
         await remove(file);
     }

package/dist/actions/commit.d.ts

@@ -1,6 +1,4 @@
-/// <reference types="node" resolution-mode="require"/>
-import { PipelineSource } from 'stream';
+import { type FileTransform, type PipelineOptions } from 'mem-fs';
 import type { MemFsEditor, MemFsEditorFile } from '../index.js';
-declare function commit<EditorFile extends MemFsEditorFile>(this: MemFsEditor<EditorFile>, stream?: PipelineSource<any>): any;
-declare function commit<EditorFile extends MemFsEditorFile>(this: MemFsEditor<EditorFile>, filters?: any[], stream?: PipelineSource<any>): any;
+declare function commit<EditorFile extends MemFsEditorFile>(this: MemFsEditor<EditorFile>, options?: PipelineOptions<EditorFile> | FileTransform<EditorFile>, ...transforms: FileTransform<EditorFile>[]): Promise<void>;
 export default commit;

package/dist/actions/commit.js

@@ -1,15 +1,11 @@
-import { promisify } from 'util';
-import { pipeline as _pipeline } from 'stream';
-const pipeline = promisify(_pipeline);
-import { createPendingFilesPassthrough, createCommitTransform } from '../transform.js';
+import { isFileTransform } from 'mem-fs';
+import { createCommitTransform } from '../transform.js';
 import { isFilePending } from '../state.js';
-function commit(filters, stream) {
-    if (!Array.isArray(filters)) {
-        stream = filters;
-        filters = [];
+async function commit(options, ...transforms) {
+    if (isFileTransform(options)) {
+        transforms = [options, ...transforms];
+        options = undefined;
     }
-    stream = stream ?? this.store.stream({ filter: (file) => isFilePending(file) });
-    filters = filters ?? [];
-    return pipeline(stream, createPendingFilesPassthrough(), ...filters, createCommitTransform(this));
+    await this.store.pipeline({ filter: isFilePending, ...options }, ...transforms, createCommitTransform());
 }
 export default commit;

package/dist/actions/pipeline.d.ts

@@ -0,0 +1,8 @@
+import type { MemFsEditor, MemFsEditorFile } from '../index.js';
+import { type PipelineOptions as MemFsPipelineOptions, type FileTransform as MemFsFileTransform } from 'mem-fs';
+export type PipelineOptions<EditorFile extends MemFsEditorFile> = MemFsPipelineOptions<EditorFile> & {
+    pendingFiles?: boolean;
+};
+export type FileTransform<EditorFile extends MemFsEditorFile> = MemFsFileTransform<EditorFile>;
+declare function pipeline<EditorFile extends MemFsEditorFile>(this: MemFsEditor<EditorFile>, options?: PipelineOptions<EditorFile> | FileTransform<EditorFile>, ...transforms: FileTransform<EditorFile>[]): Promise<void>;
+export default pipeline;

package/dist/actions/pipeline.js

@@ -0,0 +1,27 @@
+import { isFileTransform, } from 'mem-fs';
+import { isFilePending } from '../state.js';
+async function pipeline(options, ...transforms) {
+    let storeOptions = { filter: isFilePending };
+    if (isFileTransform(options)) {
+        transforms = [options, ...transforms];
+        storeOptions = { filter: isFilePending };
+    }
+    else if (options) {
+        const { pendingFiles = true, ...pipelineOptions } = options;
+        if (pipelineOptions.filter) {
+            const optionsfilter = pipelineOptions.filter;
+            if (pendingFiles) {
+                pipelineOptions.filter = (file) => optionsfilter(file) && isFilePending(file);
+            }
+            else {
+                pipelineOptions.filter = optionsfilter;
+            }
+        }
+        else {
+            pipelineOptions.filter = pendingFiles ? isFilePending : undefined;
+        }
+        storeOptions = pipelineOptions;
+    }
+    await this.store.pipeline(storeOptions, ...transforms);
+}
+export default pipeline;

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { Store } from 'mem-fs';
 import type Vinyl from 'vinyl';
+export type { PipelineOptions, FileTransform } from 'mem-fs';
 import read from './actions/read.js';
 import readJSON from './actions/read-json.js';
 import exists from './actions/exists.js';
@@ -16,7 +17,6 @@ import { copyAsync, _copySingleAsync } from './actions/copy-async.js';
 import copyTplAsync from './actions/copy-tpl-async.js';
 import move from './actions/move.js';
 import commit from './actions/commit.js';
-import commitFileAsync from './actions/commit-file-async.js';
 import dump from './actions/dump.js';
 export type { AppendOptions } from './actions/append.js';
 export type { CopyOptions } from './actions/copy.js';
@@ -58,7 +58,6 @@ export interface MemFsEditor<EditorFile extends MemFsEditorFile = VinylMemFsEdit
     copyTplAsync: typeof copyTplAsync;
     move: typeof move;
     commit: typeof commit<EditorFile>;
-    commitFileAsync: typeof commitFileAsync<EditorFile>;
     dump: typeof dump<EditorFile>;
 }
 export declare function create(store: any): MemFsEditor<VinylMemFsEditorFile>;

package/dist/index.js

@@ -13,8 +13,8 @@ import { copyAsync, _copySingleAsync } from './actions/copy-async.js';
 import copyTplAsync from './actions/copy-tpl-async.js';
 import move from './actions/move.js';
 import commit from './actions/commit.js';
-import commitFileAsync from './actions/commit-file-async.js';
 import dump from './actions/dump.js';
+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
 export class MemFsEditor {
     store;
     constructor(store) {
@@ -39,7 +39,6 @@ MemFsEditor.prototype._copySingleAsync = _copySingleAsync;
 MemFsEditor.prototype.copyTplAsync = copyTplAsync;
 MemFsEditor.prototype.move = move;
 MemFsEditor.prototype.commit = commit;
-MemFsEditor.prototype.commitFileAsync = commitFileAsync;
 MemFsEditor.prototype.dump = dump;
 export function create(store) {
     return new MemFsEditor(store);

package/dist/transform.d.ts

@@ -1,7 +1,4 @@
 /// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-import { Transform, TransformCallback } from 'stream';
-import type { MemFsEditor, MemFsEditorFile } from './index.js';
-export declare function createTransform<EditorFile extends MemFsEditorFile = MemFsEditorFile>(transform: (file: EditorFile, encoding: BufferEncoding, cb: TransformCallback) => void): Transform;
-export declare const createPendingFilesPassthrough: () => Transform;
-export declare const createCommitTransform: <EditorFile extends MemFsEditorFile = MemFsEditorFile>(memFsEditor: MemFsEditor<EditorFile>) => Transform;
+import { Duplex } from 'stream';
+import type { MemFsEditorFile } from './index.js';
+export declare const createCommitTransform: <EditorFile extends MemFsEditorFile = MemFsEditorFile>() => Duplex;

package/dist/transform.js

@@ -1,20 +1,8 @@
-import { Transform } from 'stream';
-import { isFilePending } from './state.js';
-export function createTransform(transform) {
-    return new Transform({
-        objectMode: true,
-        transform(...args) {
-            transform.apply(this, args);
-        },
-    });
-}
-export const createPendingFilesPassthrough = () => createTransform((file, _enc, cb) => {
-    // Don't process deleted file who haven't been commited yet.
-    cb(undefined, isFilePending(file) ? file : undefined);
-});
-export const createCommitTransform = (memFsEditor) => createTransform((file, _enc, cb) => {
-    memFsEditor
-        .commitFileAsync(file)
-        .then(() => cb())
-        .catch((error) => cb(error));
+import { Duplex } from 'stream';
+import commitFileAsync from './actions/commit-file-async.js';
+export const createCommitTransform = () => Duplex.from(async function* (generator) {
+    for await (const file of generator) {
+        await commitFileAsync(file);
+        yield file;
+    }
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mem-fs-editor",
-  "version": "10.0.2",
+  "version": "11.0.0",
   "description": "File edition helpers working on top of mem-fs",
   "type": "module",
   "scripts": {
@@ -33,34 +33,40 @@
     "dist"
   ],
   "dependencies": {
-    "@types/ejs": "^3.1.2",
-    "binaryextensions": "^4.16.0",
+    "@types/ejs": "^3.1.3",
+    "@types/node": "^18.18.5",
+    "binaryextensions": "^4.18.0",
     "commondir": "^1.0.1",
     "deep-extend": "^0.6.0",
     "ejs": "^3.1.9",
-    "globby": "^13.1.4",
+    "globby": "^13.2.2",
     "isbinaryfile": "^5.0.0",
-    "mem-fs": "^3.0.0",
-    "minimatch": "^9.0.0",
+    "minimatch": "^9.0.3",
     "multimatch": "^6.0.0",
     "normalize-path": "^3.0.0",
-    "textextensions": "^5.13.0",
+    "textextensions": "^5.16.0",
     "vinyl": "^3.0.0"
   },
+  "peerDependencies": {
+    "mem-fs": "^4.0.0"
+  },
   "devDependencies": {
-    "coveralls": "^3.0.3",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "@typescript-eslint/parser": "^6.7.5",
+    "@vitest/coverage-v8": "^0.34.6",
+    "coveralls": "^3.1.1",
     "escape-regexp": "0.0.1",
-    "eslint": "^8.5.0",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-config-xo": "^0.43.1",
-    "eslint-plugin-prettier": "^4.0.0",
-    "mem-fs": "^3.0.0",
-    "prettier": "^2.5.1",
-    "sinon": "^15.0.1",
-    "typescript": "^5.0.4",
-    "vitest": "^0.30.1"
+    "eslint-plugin-prettier": "^5.0.1",
+    "prettier": "^3.0.3",
+    "prettier-plugin-packagejson": "^2.4.6",
+    "sinon": "^16.1.0",
+    "typescript": "^5.2.2",
+    "vitest": "^0.34.6"
   },
   "engines": {
-    "node": ">=16.13.0"
+    "node": ">=18.0.0"
   }
 }