flatten-tool 1.6.1 → 1.6.3

package/README.md

@@ -4,6 +4,9 @@
 
 A CLI utility to flatten directory structures, with perfect GitHub Flavored Markdown compatibility.
 
+[![Video thumbnail](https://i.ytimg.com/vi/LCbSoK0Mkjk/maxresdefault.jpg)](https://youtu.be/LCbSoK0Mkjk)  
+*Watch the YouTube video for an example of why you might need to flatten project files into a single document for AI discussions and code reviews.*
+
 [![asciicast](docs/demo.gif)](https://asciinema.org/a/ThswNC1vrdlK0wdD)
 
 ## Installation
@@ -140,6 +143,16 @@ This project uses Bun for runtime, TypeScript for type safety, and follows the g
 
 ## Changelog
 
+### v1.6.3
+- Enhanced safety: Automatically exclude common binary file extensions (PNG, JPEG, PDF, archives, executables, etc.) when merging to Markdown to prevent corruption.
+- Added `--ignore` CLI option: Allow additional glob patterns to ignore (e.g., `*.log`, `temp/**`).
+- Minor clean-ups: Improved variable naming and code consistency.
+- Added YouTube video link in README demonstrating use case for AI discussions.
+
+### v1.6.2
+- Updated AGENTS.md with revised coding guidelines.
+- Added '..' links in subdirectory file trees for navigation to parent directories.
+
 ### v1.6.1
 - Added instructions for running flatten-tool directly with npx and bunx.
 

package/index.ts

@@ -67,20 +67,28 @@ export async function flattenDirectory(
     return;
   }
 
-  const negativeIgnores = ignorePatterns.map(pattern => `!${pattern}`);
+  // Patterns explicitly ignored (in addition to .gitignore when enabled)
+  const extraIgnores = ignorePatterns.map(pattern => `!${pattern}`);
 
-  const ignoreFiles = ['.git'];
+  const defaultIgnores = ['.git'];
   if (!flattenToDirectory) {
-    ignoreFiles.push('**/*.gif');
+    // Common binary/media extensions that would corrupt UTF-8 text output
+    const binaryExts = [
+      'gif', 'png', 'jpg', 'jpeg', 'webp', 'svg', 'bmp', 'ico',
+      'pdf', 'zip', 'tar', 'gz', 'xz', '7z',
+      'mp3', 'mp4', 'webm', 'ogg', 'wav',
+      'exe', 'dll', 'so', 'dylib', 'bin'
+    ];
+    defaultIgnores.push(`**/*.{${binaryExts.join(',')}}`);
   }
 
-   const files = await globby(['**', ...negativeIgnores], {
+  const files = await globby(['**', ...extraIgnores], {
     cwd: absSource,
     gitignore: respectGitignore,
     absolute: true,
     dot: true,
     onlyFiles: true,
-    ignore: ignoreFiles,
+    ignore: defaultIgnores,
   });
 
   if (!flattenToDirectory) {
@@ -147,6 +155,8 @@ export async function flattenDirectory(
       }
     }
 
+    sections.push({ path: '', headerText: 'Project File Tree' });
+
     collectSections(treeObj, '');
 
     const anchorMap = new Map<string, string>();
@@ -161,10 +171,21 @@ export async function flattenDirectory(
       node: any,
       depth: number = 0,
       prefix: string = '',
-      anchorMap: Map<string, string>
+      anchorMap: Map<string, string>,
+      parentPath: string | null  // null for global root (no ..)
     ): string {
       let result = '';
       const indent = '  '.repeat(depth);
+
+      // Add .. if we have a parent
+      if (parentPath !== null) {
+        const parentAnchor = anchorMap.get(parentPath) ?? '';
+        result += `${indent}- [..](#${parentAnchor})\n`;
+      }
+
+      // Determine indentation for direct children
+      const entryIndent = '  '.repeat(depth);
+
       const entries: [string, any][] = Object.entries(node);
 
       entries.sort(([a], [b]) => {
@@ -180,17 +201,27 @@ export async function flattenDirectory(
         const display = isDir ? name + '/' : name;
         const pathHere = prefix ? `${prefix}/${name}` : name;
         const anchor = anchorMap.get(pathHere) ?? '';
-        result += `${indent}- [${display}](#${anchor})\n`;
+
+        result += `${entryIndent}- [${display}](#${anchor})\n`;
+
         if (isDir) {
-          result += renderMarkdownTree(value, depth + 1, pathHere, anchorMap);
+          // Recurse with increased depth; child's parent is current prefix
+          result += renderMarkdownTree(
+            value,
+            depth + 1,
+            pathHere,
+            anchorMap,
+            prefix
+          );
         }
       }
+
       return result;
     }
 
     // Render global tree with correct anchors
-    let treeMarkdown = "# Project File Tree\n\n- .\n";
-    treeMarkdown += renderMarkdownTree(treeObj, 1, '', anchorMap);
+    let treeMarkdown = "# Project File Tree\n\n";
+    treeMarkdown += renderMarkdownTree(treeObj, 0, '', anchorMap, null);
     treeMarkdown += "\n\n";
 
     const writeStream = createWriteStream(absTarget);
@@ -230,8 +261,12 @@ export async function flattenDirectory(
       if (currentPath) {
         writeStream.write(`# ${currentPath}\n\n`);
         writeStream.write(`File Tree\n\n`);
-        writeStream.write(`- .\n`);
-        writeStream.write(renderMarkdownTree(node, 1, currentPath, anchorMap));
+
+        const parentPath = currentPath.includes('/')
+          ? currentPath.slice(0, currentPath.lastIndexOf('/'))
+          : '';
+
+        writeStream.write(renderMarkdownTree(node, 0, currentPath, anchorMap, parentPath));
         writeStream.write('\n');
       }
 
@@ -334,13 +369,20 @@ if (import.meta.url === `file://${process.argv[1]}`) {
           type: 'boolean',
           default: false,
         })
+        .option('ignore', {
+          alias: 'i',
+          type: 'string',
+          array: true,
+          describe: 'Additional glob patterns to ignore (e.g. "*.log" "temp/**")',
+          default: [],
+        })
     }, async (argv) => {
       let source = argv.source as string;           // now always defined (default '.')
       let target = argv.target as string;           // may be undefined
 
       const move: boolean = argv.move as boolean;
       const overwrite: boolean = argv.overwrite as boolean;
-      const ignorePatterns: string[] = argv.ignore as string[] || [];
+      const ignorePatterns: string[] = (argv.ignore as string[] | undefined) ?? [];
       const respectGitignore: boolean = argv.gitignore as boolean;
       const flattenToDirectory: boolean = argv.directory as boolean;
 

package/package.json

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