flatten-tool 1.2.1 → 1.2.3

package/README.md

@@ -4,6 +4,8 @@
 
 A CLI utility to flatten directory structures.
 
+[![asciicast](docs/demo.gif)](https://asciinema.org/a/ThswNC1vrdlK0wdD)
+
 ## Installation
 
 Requires [Bun](https://bun.sh) runtime (v1.1+).
@@ -111,6 +113,15 @@ This project uses Bun for runtime, TypeScript for type safety, and follows the g
 
 ## Changelog
 
+### v1.2.3
+- Added demo.gif to docs/ and linked in README.md.
+
+### v1.2.2
+- Added `setMaxListeners(0)` on WriteStream in Markdown merging to silence listener warnings when processing many files.
+
+### v1.2.1
+- Fixed memory leak warnings in Markdown merging by refactoring to use `pipeline` and `finished` from `node:stream/promises`.
+
 ### v1.2.0
 - Implemented streaming for Markdown merging to improve memory efficiency for large files/directories.
 - Updated documentation and coding guidelines.

package/index.ts

@@ -2,6 +2,7 @@
 import { copyFile, rename, rm, stat, mkdir, readdir, rmdir, readFile, writeFile } from 'node:fs/promises';
 import { join, relative, sep, resolve, extname } from 'node:path';
 import { createReadStream, createWriteStream } from 'node:fs';
+import { pipeline, finished } from 'node:stream/promises';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { globby } from 'globby';
@@ -68,6 +69,7 @@ export async function flattenDirectory(
     }
 
     const writeStream = createWriteStream(absTarget);
+    writeStream.setMaxListeners(0);
 
     for (const srcPath of files) {
       const relPath = relative(absSource, srcPath).replace(/\\/g, '/');
@@ -75,32 +77,22 @@ export async function flattenDirectory(
       const isMd = ['md', 'markdown'].includes(ext.toLowerCase());
       const ticks = isMd ? '````' : '```';
 
-      // Header + opening fence
+      // Write header synchronously
       writeStream.write(`# ${relPath}\n\n${ticks}${ext}\n`);
 
-      // Stream file content as UTF-8 text (matches previous readFile(..., 'utf8') behavior)
+      // Stream file content (preserve original UTF-8 text behavior)
       const readStream = createReadStream(srcPath, { encoding: 'utf8' });
 
-      await new Promise<void>((resolve, reject) => {
-        readStream.pipe(writeStream, { end: false });
+      // Pipe with { end: false } so writeStream stays open for next files
+      await pipeline(readStream, writeStream, { end: false });
 
-        readStream.on('end', () => {
-          // Closing fence + trailing newlines
-          writeStream.write(`\n${ticks}\n\n`);
-          resolve();
-        });
-
-        readStream.on('error', reject);
-        writeStream.on('error', reject);
-      });
+      // Write closing fence
+      writeStream.write(`\n${ticks}\n\n`);
     }
 
-    // Finalise the output file
-    await new Promise<void>((resolve, reject) => {
-      writeStream.end();
-      writeStream.on('close', resolve);
-      writeStream.on('error', reject);
-    });
+    // Close the output file and wait for it to finish
+    writeStream.end();
+    await finished(writeStream);
 
     if (move) {
       for (const srcPath of files) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flatten-tool",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "CLI tool to flatten directory structures: merge files into a single Markdown file (default) or copy/move to a flat directory with escaped filenames. Respects .gitignore, supports move/overwrite, and more.",
   "module": "index.ts",
   "type": "module",
@@ -43,12 +43,12 @@
     "@types/yargs": "^17.0.35"
   },
   "peerDependencies": {
-    "typescript": "^5"
+    "typescript": "^5.9.3"
   },
   "dependencies": {
     "globby": "^16.1.0",
     "ignore": "^7.0.5",
-    "minimatch": "^10.1.1",
+    "minimatch": "^10.1.2",
     "yargs": "^18.0.0"
   }
 }