flatten-tool 1.3.0 → 1.4.0

package/README.md

@@ -16,7 +16,7 @@ npm install -g flatten-tool
 
 ## Usage
 
-By default, the tool merges all file contents into a single Markdown file, with each file's content placed under a header with its relative path, followed by a code block with appropriate language highlighting based on the file extension. Ignores and filters are applied as usual.
+By default, the tool merges all file contents into a single Markdown file, starting with a project file tree for navigation, followed by each file's content under a header with its relative path, in a code block with appropriate language highlighting based on the file extension. Ignores and filters are applied as usual.
 
 The `<source>` argument is optional and defaults to the current directory (`.`). The `<target>` argument is also optional and defaults to `flattened.md` (or `flattened/` when using `--directory`).
 
@@ -113,6 +113,12 @@ This project uses Bun for runtime, TypeScript for type safety, and follows the g
 
 ## Changelog
 
+### v1.4.0
+- Added project file tree to the beginning of merged Markdown output for better navigation.
+
+### v1.3.1
+- Fixed GIF exclusion pattern to work recursively in subdirectories.
+
 ### v1.3.0
 - Excluded GIF files by default when merging to Markdown to prevent binary content corruption.
 

package/index.ts

@@ -7,11 +7,65 @@ import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { globby } from 'globby';
 import pkg from './package.json' assert { type: 'json' };
+import treeify from 'treeify';
 
 function escapePathComponent(component: string): string {
   return component.replace(/_/g, '__');
 }
 
+function buildTreeObject(relPaths: string[]): any {
+  const tree: any = {};
+
+  relPaths.forEach((path) => {
+    // Normalize paths
+    path = path.replace(/\\/g, '/');
+    if (path.startsWith('./')) path = path.slice(2);
+
+    const parts = path.split('/');
+    let node = tree;
+
+    parts.forEach((part, index) => {
+      const isDir = index < parts.length - 1;
+      const key = isDir ? `${part}/` : part;
+
+      if (!node[key]) {
+        node[key] = isDir ? {} : null;
+      }
+
+      if (isDir) {
+        node = node[key];
+      }
+    });
+  });
+
+  // Recursively sort: directories first, then files, case-insensitive
+  function sortNode(node: any): void {
+    if (node === null || typeof node !== 'object') return;
+
+    const entries = Object.entries(node);
+    entries.sort(([a], [b]) => {
+      const aIsDir = a.endsWith('/');
+      const bIsDir = b.endsWith('/');
+      if (aIsDir !== bIsDir) return aIsDir ? -1 : 1; // dirs before files
+      return a.toLowerCase().localeCompare(b.toLowerCase());
+    });
+
+    // Rebuild node in sorted order (preserves insertion order for rendering)
+    const sorted: any = {};
+    entries.forEach(([key, value]) => {
+      sorted[key] = value;
+      sortNode(value);
+    });
+
+    Object.keys(node).forEach((k) => delete node[k]);
+    Object.assign(node, sorted);
+  }
+
+  sortNode(tree);
+
+  return tree;
+}
+
 async function removeEmptyDirs(dir: string, root?: string): Promise<void> {
   const entries = await readdir(dir, { withFileTypes: true });
   for (const entry of entries) {
@@ -49,10 +103,10 @@ export async function flattenDirectory(
 
   const ignoreFiles = ['.git'];
   if (!flattenToDirectory) {
-    ignoreFiles.push('*.gif');
+    ignoreFiles.push('**/*.gif');
   }
 
-  const files = await globby(['**', ...negativeIgnores], {
+   const files = await globby(['**', ...negativeIgnores], {
     cwd: absSource,
     gitignore: respectGitignore,
     absolute: true,
@@ -73,9 +127,26 @@ export async function flattenDirectory(
       if (err.code !== 'ENOENT') throw err;
     }
 
+    const relPaths: string[] = files.map((srcPath) =>
+      relative(absSource, srcPath).replace(/\\/g, '/')
+    );
+
+    // Sort paths for consistent insertion
+    relPaths.sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()));
+
+    const treeObj = buildTreeObject(relPaths);
+
+    // Wrap with root for nice "." header (empty dirs show just ".")
+    const rootTree = { '.': treeObj };
+
     const writeStream = createWriteStream(absTarget);
     writeStream.setMaxListeners(0);
 
+    writeStream.write("# Project File Tree\n\n");
+    writeStream.write("```\n");
+    writeStream.write(treeify.asTree(rootTree));
+    writeStream.write("```\n\n");
+
     for (const srcPath of files) {
       const relPath = relative(absSource, srcPath).replace(/\\/g, '/');
       let ext = extname(srcPath).slice(1) || 'text';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flatten-tool",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "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",
@@ -49,6 +49,7 @@
     "globby": "^16.1.0",
     "ignore": "^7.0.5",
     "minimatch": "^10.1.2",
+    "treeify": "^1.1.0",
     "yargs": "^18.0.0"
   }
 }