flatten-tool 1.3.1 → 1.5.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,13 @@ This project uses Bun for runtime, TypeScript for type safety, and follows the g
 
 ## Changelog
 
+### v1.5.0
+- Improved navigation: project file tree is now a clickable nested Markdown list with links to each file's content section using standard markdown anchors.
+- Simplified file headers: removed custom anchors from section headers.
+
+### 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.
 

package/index.ts

@@ -12,6 +12,62 @@ function escapePathComponent(component: string): string {
   return component.replace(/_/g, '__');
 }
 
+function generateMarkdownAnchor(text: string): string {
+  return text
+    .toLowerCase()
+    .replace(/[^\w\s-]/g, '') // Remove punctuation except hyphens and underscores
+    .replace(/\s+/g, '-') // Replace spaces with hyphens
+    .replace(/^-+|-+$/g, ''); // Remove leading/trailing hyphens
+}
+
+function buildTreeObject(relPaths: string[]): any {
+  const tree: any = {};
+  for (const path of relPaths) {
+    const parts = path.split('/');
+    let node = tree;
+    const currentParts: string[] = [];
+    for (const [index, part] of parts.entries()) {
+      currentParts.push(part);
+      const isDir = index < parts.length - 1;
+      const key = isDir ? `${part}/` : part;
+      if (node[key] === undefined) {
+        node[key] = isDir ? {} : currentParts.join('/');
+      }
+      if (isDir) {
+        node = node[key];
+      }
+    }
+  }
+  return tree;
+}
+
+function renderMarkdownTree(node: any, depth: number): string {
+  let result = '';
+  const indent = '  '.repeat(depth);
+  const entries: [string, any][] = Object.entries(node);
+
+  entries.sort(([a], [b]) => {
+    const aDir = a.endsWith('/');
+    const bDir = b.endsWith('/');
+    if (aDir !== bDir) return aDir ? -1 : 1;
+    return a.toLowerCase().localeCompare(b.toLowerCase());
+  });
+
+  for (const [key, value] of entries) {
+    const isDir = key.endsWith('/');
+    const display = isDir ? key.slice(0, -1) + '/' : key;
+    if (isDir) {
+      result += `${indent}- ${display}\n`;
+      result += renderMarkdownTree(value, depth + 1);
+    } else {
+      const fullPath = value as string;
+      const anchor = generateMarkdownAnchor(fullPath);
+      result += `${indent}- [${display}](#${anchor})\n`;
+    }
+  }
+  return result;
+}
+
 async function removeEmptyDirs(dir: string, root?: string): Promise<void> {
   const entries = await readdir(dir, { withFileTypes: true });
   for (const entry of entries) {
@@ -52,7 +108,7 @@ export async function flattenDirectory(
     ignoreFiles.push('**/*.gif');
   }
 
-  const files = await globby(['**', ...negativeIgnores], {
+   const files = await globby(['**', ...negativeIgnores], {
     cwd: absSource,
     gitignore: respectGitignore,
     absolute: true,
@@ -73,25 +129,40 @@ export async function flattenDirectory(
       if (err.code !== 'ENOENT') throw err;
     }
 
+    // Sort files for consistent content order
+    const fileEntries = files.map(srcPath => ({
+      srcPath,
+      relPath: relative(absSource, srcPath).replace(/\\/g, '/')
+    }));
+    fileEntries.sort((a, b) => a.relPath.toLowerCase().localeCompare(b.relPath.toLowerCase()));
+
+    const relPaths = fileEntries.map(e => e.relPath);
+
+    // Build tree structure
+    const treeObj = buildTreeObject(relPaths);
+
+    // Render as clickable nested Markdown list
+    let treeMarkdown = "# Project File Tree\n\n- .\n";
+    treeMarkdown += renderMarkdownTree(treeObj, 1);
+    treeMarkdown += "\n";
+
     const writeStream = createWriteStream(absTarget);
     writeStream.setMaxListeners(0);
 
-    for (const srcPath of files) {
-      const relPath = relative(absSource, srcPath).replace(/\\/g, '/');
+    writeStream.write(treeMarkdown);
+
+    // Write file contents (now in sorted order)
+    for (const { srcPath, relPath } of fileEntries) {
       let ext = extname(srcPath).slice(1) || 'text';
+      const lang = ext;
       const isMd = ['md', 'markdown'].includes(ext.toLowerCase());
       const ticks = isMd ? '````' : '```';
 
-      // Write header synchronously
-      writeStream.write(`# ${relPath}\n\n${ticks}${ext}\n`);
+      writeStream.write(`## ${relPath}\n\n${ticks}${lang}\n`);
 
-      // Stream file content (preserve original UTF-8 text behavior)
       const readStream = createReadStream(srcPath, { encoding: 'utf8' });
-
-      // Pipe with { end: false } so writeStream stays open for next files
       await pipeline(readStream, writeStream, { end: false });
 
-      // Write closing fence
       writeStream.write(`\n${ticks}\n\n`);
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flatten-tool",
-  "version": "1.3.1",
+  "version": "1.5.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"
   }
 }