stdin-glob 1.3.0 → 1.4.0

package/README.md

@@ -31,6 +31,7 @@ This pipes all relevant TypeScript/TSX files directly into my clipboard, ready t
 - Support for absolute or relative paths
 - Option to show only file paths without content
 - **Intelligent handling of binary files** - shows metadata instead of attempting to display unreadable content
+- **Automatic .gitignore filtering** - respects your project's ignore rules by default
 - Written in TypeScript
 
 ## Installation
@@ -47,15 +48,16 @@ stdin-glob [options] [patterns...]
 
 ### Options
 
-| Option                | Description                                                           |
-| --------------------- | --------------------------------------------------------------------- |
-| `--no-content`        | Do not show file contents, only list matching paths                   |
-| `--absolute`          | Show absolute paths for entries                                       |
-| `-c, --copy`          | Copy the output to clipboard instead of printing to console           |
-| `-m, --max-lines <n>` | Show only the first N lines of each file (shows full file if omitted) |
-| `-n, --line-numbers`  | Display line numbers next to each line, like in IDE sidebars          |
-| `-V, --version`       | Output the version number                                             |
-| `-h, --help`          | Display help information                                              |
+| Option                | Description                                                                 |
+| --------------------- | --------------------------------------------------------------------------- |
+| `--no-content`        | Do not show file contents, only list matching paths                         |
+| `--absolute`          | Show absolute paths for entries                                             |
+| `-c, --copy`          | Copy the output to clipboard instead of printing to console                 |
+| `-m, --max-lines <n>` | Show only the first N lines of each file (shows full file if omitted)       |
+| `-n, --line-numbers`  | Display line numbers next to each line, like in IDE sidebars                |
+| `--no-gitignore`      | Disable .gitignore filtering (include files that would normally be ignored) |
+| `-V, --version`       | Output the version number                                                   |
+| `-h, --help`          | Display help information                                                    |
 
 ### Arguments
 
@@ -251,3 +253,20 @@ stdin-glob "src/**/*.ts" --no-content | pbcopy
 stdin-glob "src/**/*.ts" --content
 stdin-glob "src/**/*.ts" --copy
 ```
+
+
+### .gitignore Support
+
+By default, `stdin-glob` automatically respects your project's `.gitignore` rules. This means files and directories listed in `.gitignore` won't appear in the output. This is especially useful when you want to avoid including build artifacts, dependencies, or environment files in your context.
+
+The gitignore pattern matching implementation is based on the official [gitignore pattern format documentation](https://git-scm.com/docs/gitignore#_pattern_format), ensuring compatibility with how git itself handles ignore rules.
+
+#### Including ignored files
+
+If you need to include files that would normally be ignored, use the `--no-gitignore` flag:
+
+```bash
+stdin-glob "dist/**/*.js" --no-gitignore
+```
+
+This disables all `.gitignore` filtering and includes every file matching your patterns.

package/dist/index.js

@@ -9,8 +9,10 @@ const promises_1 = require("fs/promises");
 const fast_glob_1 = __importDefault(require("fast-glob"));
 const path_1 = __importDefault(require("path"));
 const clipboardy_1 = __importDefault(require("clipboardy"));
+const ignore_1 = __importDefault(require("ignore"));
 const binary_1 = require("./utils/binary");
 const pipes_1 = require("./utils/pipes");
+const gitignore_1 = require("./utils/gitignore");
 const program = new commander_1.Command();
 program
     .name('stdin-glob')
@@ -25,25 +27,35 @@ program
     return parseInt(value);
 })
     .option('-n, --line-numbers', 'Show line numbers next to each line, like in IDE sidebars', false)
+    .option('--no-gitignore', 'Disable .gitignore filtering (include files that would normally be ignored)')
     .argument('[patterns...]', 'Glob patterns to match files')
     .action(async (patterns, options) => {
     if (patterns.length === 0) {
         console.error('Error: No patterns provided.');
         process.exit(1);
     }
-    //expand glob
-    const files = await (0, fast_glob_1.default)(patterns, {
+    // Expand glob
+    let files = await (0, fast_glob_1.default)(patterns, {
         onlyFiles: true,
-        absolute: options.absolute ?? false,
+        dot: true,
+        absolute: false,
     });
     if (files.length === 0) {
         console.error('No files matched the given patterns.');
         process.exit(1);
     }
+    // Apply gitignore filtering if not disabled
+    if (options.gitignore) {
+        files = await filterByGitignore(files);
+        if (files.length === 0) {
+            console.error('No files remained after applying .gitignore rules.');
+            process.exit(1);
+        }
+    }
     let output = '';
     for (const file of files) {
         if (options.content) {
-            const fileOutput = await getFileContent(file, options.maxLines ?? undefined, options.lineNumbers ?? false);
+            const fileOutput = await getFileContent(options.absolute ? path_1.default.join(process.cwd(), file) : file, options.maxLines ?? undefined, options.lineNumbers ?? false);
             output += fileOutput;
         }
         else {
@@ -65,6 +77,29 @@ program
     }
 });
 program.parse(process.argv);
+/**
+ * Filter files by .gitignore rules recursively
+ */
+const filterByGitignore = async (files) => {
+    try {
+        // Find all .gitignore files in the project
+        const gitignoreFiles = await (0, gitignore_1.findGitignoreFiles)();
+        if (gitignoreFiles.length === 0) {
+            return files;
+        }
+        // Create ignore instance with all rules
+        const ig = (0, ignore_1.default)().add(await (0, gitignore_1.loadGitignoreRules)(gitignoreFiles));
+        return files.filter((file) => {
+            // Get relative path from the root where gitignore rules apply
+            const relativePath = path_1.default.relative(process.cwd(), file);
+            return !ig.ignores(relativePath);
+        });
+    }
+    catch (error) {
+        console.warn('Warning: Error processing .gitignore files, proceeding without filtering:', error);
+        return files;
+    }
+};
 /**
  * Find the maximum number of consecutive backticks in a string
  */

package/dist/utils/gitignore.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Find all .gitignore files in the project
+ */
+export declare const findGitignoreFiles: () => Promise<string[]>;
+/**
+ * Load and combine rules from recursive/multiple .gitignore files
+ * @see https://git-scm.com/docs/gitignore#_pattern_format
+ */
+export declare const loadGitignoreRules: (gitignoreFiles: string[]) => Promise<string[]>;
+//# sourceMappingURL=gitignore.d.ts.map

package/dist/utils/gitignore.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadGitignoreRules = exports.findGitignoreFiles = void 0;
+const promises_1 = require("fs/promises");
+const fast_glob_1 = __importDefault(require("fast-glob"));
+const path_1 = __importDefault(require("path"));
+/**
+ * Find all .gitignore files in the project
+ */
+const findGitignoreFiles = async () => {
+    try {
+        const files = await (0, fast_glob_1.default)('**/.gitignore', {
+            cwd: process.cwd(),
+            ignore: ['**/node_modules/**'],
+        });
+        return files;
+    }
+    catch (error) {
+        console.warn('Warning: Error finding .gitignore files:', error);
+        return [];
+    }
+};
+exports.findGitignoreFiles = findGitignoreFiles;
+/**
+ * Parse a .gitignore file and return its rules
+ */
+const parseGitignore = (content) => {
+    return content
+        .split('\n')
+        .map((line) => line.trim())
+        .filter((line) => line && // Not empty
+        !line.startsWith('#'));
+};
+/**
+ * Load and combine rules from recursive/multiple .gitignore files
+ * @see https://git-scm.com/docs/gitignore#_pattern_format
+ */
+const loadGitignoreRules = async (gitignoreFiles) => {
+    const allRules = [];
+    for (const file of gitignoreFiles) {
+        try {
+            const content = await (0, promises_1.readFile)(file, 'utf-8');
+            const rules = parseGitignore(content);
+            // directory of this .gitignore
+            const gitignoreDir = path_1.default.dirname(file);
+            // to be relative to the gitignore location
+            const dirRelativeRules = rules.map((rule) => {
+                //handle negations
+                if (rule.startsWith('!')) {
+                    return `!${path_1.default.join(gitignoreDir, rule.slice(1))}`;
+                }
+                return path_1.default.join(gitignoreDir, rule);
+            });
+            allRules.push(...dirRelativeRules);
+        }
+        catch (error) {
+            console.warn(`Warning: Error reading .gitignore file ${file}:`, error);
+        }
+    }
+    return allRules;
+};
+exports.loadGitignoreRules = loadGitignoreRules;
+//# sourceMappingURL=gitignore.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stdin-glob",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Expand glob patterns and output file contents.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -36,7 +36,8 @@
   "dependencies": {
     "clipboardy": "^5.3.1",
     "commander": "^11.1.0",
-    "fast-glob": "^3.3.3"
+    "fast-glob": "^3.3.3",
+    "ignore": "^7.0.5"
   },
   "devDependencies": {
     "@types/node": "^25.3.3",