stdin-glob 1.0.7 → 1.3.0

package/README.md

@@ -25,9 +25,12 @@ This pipes all relevant TypeScript/TSX files directly into my clipboard, ready t
 
 - Expand glob patterns to find matching files
 - Output file contents with syntax highlighting markers
-- Copy output directly to clipboard with `--copy` flag
+- **Limit output to a specific number of lines per file** with `--max-lines`
+- **Show line numbers** with `--line-numbers` for better code reference
+- **Auto-copy output** directly to clipboard with `--copy` flag
 - 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
 - Written in TypeScript
 
 ## Installation
@@ -44,13 +47,15 @@ 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 |
-| `-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          |
+| `-V, --version`       | Output the version number                                             |
+| `-h, --help`          | Display help information                                              |
 
 ### Arguments
 
@@ -92,6 +97,75 @@ function add(a, b) {
 ```
 ````
 
+### Limit lines per file
+
+Show only the first 10 lines of each TypeScript file - perfect for quick overviews:
+
+```bash
+stdin-glob "src/**/*.ts" --max-lines 10
+```
+
+Output:
+
+````
+```ts
+// src/index.ts
+
+import { Command } from 'commander';
+import { version } from '../package.json';
+import { readFile } from 'fs/promises';
+import glob from 'fast-glob';
+import path from 'path';
+import clipboard from 'clipboardy';
+// ... (23 more lines truncated)
+```
+````
+
+### Show line numbers
+
+Display line numbers alongside the code, just like in your editor:
+
+```bash
+stdin-glob "src/**/*.js" --line-numbers
+```
+
+Output:
+
+````
+```js
+// src/index.js
+
+ 1 | import { Command } from 'commander';
+ 2 | import { version } from '../package.json';
+ 3 | import { readFile } from 'fs/promises';
+ 4 | import glob from 'fast-glob';
+ 5 | import path from 'path';
+```
+````
+
+### Combine with line limits
+
+Get a preview with line numbers for better context:
+
+```bash
+stdin-glob "src/**/*.ts" --max-lines 5 --line-numbers
+```
+
+Output:
+
+````
+```ts
+// src/index.ts
+
+ 1 | import { Command } from 'commander';
+ 2 | import { version } from '../package.json';
+ 3 | import { readFile } from 'fs/promises';
+ 4 | import glob from 'fast-glob';
+ 5 | import path from 'path';
+// ... (23 more lines truncated)
+```
+````
+
 ### Copy to clipboard
 
 Copy all TypeScript file contents directly to clipboard:
@@ -148,6 +222,17 @@ Output:
 /home/pedrito/project/src/types/index.ts
 ```
 
+### Binary file handling
+
+When encountering binary files (like images, compiled binaries, etc.), the tool safely displays metadata instead of attempting to show unreadable content:
+
+````
+```png
+// assets/logo.png
+// [BINARY FILE] - Size: 0.024 MB
+```
+````
+
 ### Integration with other commands
 
 Use with grep to search for specific content:

package/dist/index.js

@@ -9,14 +9,22 @@ 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 binary_1 = require("./utils/binary");
+const pipes_1 = require("./utils/pipes");
 const program = new commander_1.Command();
 program
     .name('stdin-glob')
     .description('Expand glob patterns and output file contents and paths')
     .version(package_json_1.version)
     .option('--no-content', 'Do not show file contents, only list matching paths')
-    .option('--absolute', 'Show the absolute path for entries')
-    .option('-c, --copy', 'Copy the output to clipboard instead of printing to console')
+    .option('--absolute', 'Show the absolute path for entries', false)
+    .option('-c, --copy', 'Copy the output to clipboard instead of printing to console', false)
+    .option('-m, --max-lines <int>', 'Show a limited number of lines in the file. If you not provide a number of lines it will show the full file content.', (value) => {
+    if (isNaN(parseInt(value)))
+        throw new Error('Lines must be a number');
+    return parseInt(value);
+})
+    .option('-n, --line-numbers', 'Show line numbers next to each line, like in IDE sidebars', false)
     .argument('[patterns...]', 'Glob patterns to match files')
     .action(async (patterns, options) => {
     if (patterns.length === 0) {
@@ -35,7 +43,7 @@ program
     let output = '';
     for (const file of files) {
         if (options.content) {
-            const fileOutput = await getFileContent(file);
+            const fileOutput = await getFileContent(file, options.maxLines ?? undefined, options.lineNumbers ?? false);
             output += fileOutput;
         }
         else {
@@ -68,18 +76,47 @@ const findMaxConsecutiveBackticks = (str) => {
 };
 /**
  * Get file content with markdown format
+ * @param filePath - The path to the file
+ * @param maxLines - The number of lines to show. If you not provide a number of lines it will show the full file content.
+ * @param showLineNumbers - Whether to show line numbers
+ * @returns The file content with markdown format
  */
-const getFileContent = async (filePath) => {
+const getFileContent = async (filePath, maxLines, showLineNumbers) => {
     try {
-        const content = await (0, promises_1.readFile)(filePath, 'utf-8');
+        const fileBuffer = await (0, promises_1.readFile)(filePath);
+        if ((0, binary_1.isBinaryFile)(fileBuffer)) {
+            // is binary!! not show content
+            const stats = await (0, promises_1.stat)(filePath);
+            const fileSize = stats.size;
+            const extension = path_1.default.extname(filePath).replace('.', '');
+            const sizeFormatted = (0, pipes_1.formatSizeInMB)(fileSize);
+            return ('```' +
+                extension +
+                '\n' +
+                `// ${filePath}\n` +
+                `// [BINARY FILE] - Size: ${sizeFormatted}\n` +
+                '```\n\n');
+        }
+        // is text file!! proceed with normal processing
+        const content = fileBuffer.toString('utf-8');
+        const lines = content.split('\n');
+        // maxLines if exists
+        const linesToShow = maxLines ? lines.slice(0, maxLines) : lines;
+        let contentToShow = linesToShow.join('\n');
+        if (showLineNumbers)
+            contentToShow = (0, pipes_1.addLineNumbers)(linesToShow.join('\n'), 1);
         const extension = path_1.default.extname(filePath).replace('.', '');
         const maxBackticks = findMaxConsecutiveBackticks(content);
         const wrapper = '`'.repeat(Math.max(3, maxBackticks + 1));
+        const truncation = maxLines && lines.length > maxLines
+            ? `\n// ... (${lines.length - maxLines} more lines truncated)`
+            : '';
         return (wrapper +
             extension +
             '\n' +
             `// ${filePath}\n\n` +
-            content +
+            contentToShow +
+            truncation +
             '\n' +
             wrapper +
             '\n\n');

package/dist/utils/binary.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Check if a file is binary
+ * @see https://gist.github.com/magnetikonline/7a21ec5f5bcdbf7adb92f9d617e6198f
+ */
+export declare const isBinaryFile: (buffer: Buffer) => boolean;
+//# sourceMappingURL=binary.d.ts.map

package/dist/utils/binary.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBinaryFile = void 0;
+/**
+ * Check if a file is binary
+ * @see https://gist.github.com/magnetikonline/7a21ec5f5bcdbf7adb92f9d617e6198f
+ */
+const isBinaryFile = (buffer) => {
+    // check for null bytes or control characters that indicate binary
+    for (let i = 0; i < Math.min(buffer.length, 512); i++) {
+        const byte = buffer[i];
+        // Null byte or control character
+        if (byte === 0 || (byte < 32 && byte !== 9 && byte !== 10 && byte !== 13)) {
+            return true;
+        }
+    }
+    return false;
+};
+exports.isBinaryFile = isBinaryFile;
+//# sourceMappingURL=binary.js.map

package/dist/utils/pipes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Add line numbers to content
+ */
+export declare const addLineNumbers: (content: string, startLine?: number) => string;
+/**
+ * Format file size in MB with 3 decimal places
+ */
+export declare const formatSizeInMB: (bytes: number) => string;
+//# sourceMappingURL=pipes.d.ts.map

package/dist/utils/pipes.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatSizeInMB = exports.addLineNumbers = void 0;
+/**
+ * Add line numbers to content
+ */
+const addLineNumbers = (content, startLine = 1) => {
+    const lines = content.split('\n');
+    // calculate width of bar
+    const paddingWidth = (startLine + lines.length - 1).toString().length;
+    return lines
+        .map((line, index) => {
+        const lineNumber = startLine + index;
+        const paddedNumber = lineNumber.toString().padStart(paddingWidth, ' ');
+        return `${paddedNumber} | ${line}`;
+    })
+        .join('\n');
+};
+exports.addLineNumbers = addLineNumbers;
+/**
+ * Format file size in MB with 3 decimal places
+ */
+const formatSizeInMB = (bytes) => {
+    const mb = bytes / (1024 * 1024);
+    return mb.toFixed(3) + ' MB';
+};
+exports.formatSizeInMB = formatSizeInMB;
+//# sourceMappingURL=pipes.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stdin-glob",
-  "version": "1.0.7",
+  "version": "1.3.0",
   "description": "Expand glob patterns and output file contents.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,6 +12,10 @@
     "prepare": "npm run build",
     "prepublishOnly": "npm run build"
   },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
   "keywords": [
     "glob",
     "stdin",

package/.github/workflows/npm-publish.yml

@@ -1,26 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: NPM Package
-
-on:
-  push:
-    tags:
-      - 'v*'
-
-permissions:
-  id-token: write # Required for OIDC
-  contents: read
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '24'
-          registry-url: 'https://registry.npmjs.org'
-
-      - run: npm install
-      - run: npm publish

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,yCAAoC;AACpC,kDAA0C;AAC1C,0CAAuC;AACvC,0DAA6B;AAC7B,gDAAwB;AACxB,4DAAmC;AAQnC,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,YAAY,CAAC;KAClB,WAAW,CAAC,yDAAyD,CAAC;KACtE,OAAO,CAAC,sBAAO,CAAC;KAChB,MAAM,CAAC,cAAc,EAAE,qDAAqD,CAAC;KAC7E,MAAM,CAAC,YAAY,EAAE,oCAAoC,CAAC;KAC1D,MAAM,CACL,YAAY,EACZ,6DAA6D,CAC9D;KACA,QAAQ,CAAC,eAAe,EAAE,8BAA8B,CAAC;KACzD,MAAM,CAAC,KAAK,EAAE,QAAkB,EAAE,OAAgB,EAAE,EAAE;IACrD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC9C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,aAAa;IACb,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAI,EAAC,QAAQ,EAAE;QACjC,SAAS,EAAE,IAAI;QACf,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,KAAK;KACpC,CAAC,CAAC;IAEH,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;QACtD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,MAAM,GAAG,EAAE,CAAC;IAEhB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;YAC9C,MAAM,IAAI,UAAU,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,IAAI,GAAG,IAAI,CAAC;QACxB,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,IAAI,CAAC;YACH,MAAM,oBAAS,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACrC,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,KAAK,CAAC,CAAC;YACvD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7B,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAE5B;;GAEG;AACH,MAAM,2BAA2B,GAAG,CAAC,GAAW,EAAU,EAAE;IAC1D,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACjC,IAAI,CAAC,OAAO;QAAE,OAAO,CAAC,CAAC;IACvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,cAAc,GAAG,KAAK,EAAE,QAAgB,EAAmB,EAAE;IACjE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,IAAA,mBAAQ,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC1D,MAAM,YAAY,GAAG,2BAA2B,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC;QAE1D,OAAO,CACL,OAAO;YACP,SAAS;YACT,IAAI;YACJ,MAAM,QAAQ,MAAM;YACpB,OAAO;YACP,IAAI;YACJ,OAAO;YACP,MAAM,CACP,CAAC;IACJ,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CAAC,sBAAsB,QAAQ,GAAG,EAAE,CAAC,CAAC,CAAC;QACpD,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC,CAAC"}

package/src/index.ts

@@ -1,103 +0,0 @@
-import { Command } from 'commander';
-import { version } from '../package.json';
-import { readFile } from 'fs/promises';
-import glob from 'fast-glob';
-import path from 'path';
-import clipboard from 'clipboardy';
-
-interface Options {
-  content?: boolean;
-  absolute?: boolean;
-  copy?: boolean;
-}
-
-const program = new Command();
-
-program
-  .name('stdin-glob')
-  .description('Expand glob patterns and output file contents and paths')
-  .version(version)
-  .option('--no-content', 'Do not show file contents, only list matching paths')
-  .option('--absolute', 'Show the absolute path for entries')
-  .option(
-    '-c, --copy',
-    'Copy the output to clipboard instead of printing to console',
-  )
-  .argument('[patterns...]', 'Glob patterns to match files')
-  .action(async (patterns: string[], options: Options) => {
-    if (patterns.length === 0) {
-      console.error('Error: No patterns provided.');
-      process.exit(1);
-    }
-
-    //expand glob
-    const files = await glob(patterns, {
-      onlyFiles: true,
-      absolute: options.absolute ?? false,
-    });
-
-    if (files.length === 0) {
-      console.error('No files matched the given patterns.');
-      process.exit(1);
-    }
-
-    let output = '';
-
-    for (const file of files) {
-      if (options.content) {
-        const fileOutput = await getFileContent(file);
-        output += fileOutput;
-      } else {
-        output += file + '\n';
-      }
-    }
-
-    if (options.copy) {
-      try {
-        await clipboard.write(output.trim());
-        console.log('-> Output copied to clipboard successfully!');
-      } catch (error) {
-        console.error('-X Error copying to clipboard:', error);
-        process.exit(1);
-      }
-    } else {
-      console.log(output.trim());
-    }
-  });
-
-program.parse(process.argv);
-
-/**
- * Find the maximum number of consecutive backticks in a string
- */
-const findMaxConsecutiveBackticks = (str: string): number => {
-  const matches = str.match(/`+/g);
-  if (!matches) return 0;
-  return Math.max(...matches.map((m) => m.length));
-};
-
-/**
- * Get file content with markdown format
- */
-const getFileContent = async (filePath: string): Promise<string> => {
-  try {
-    const content = await readFile(filePath, 'utf-8');
-    const extension = path.extname(filePath).replace('.', '');
-    const maxBackticks = findMaxConsecutiveBackticks(content);
-    const wrapper = '`'.repeat(Math.max(3, maxBackticks + 1));
-
-    return (
-      wrapper +
-      extension +
-      '\n' +
-      `// ${filePath}\n\n` +
-      content +
-      '\n' +
-      wrapper +
-      '\n\n'
-    );
-  } catch (e) {
-    console.error(`Error reading file ${filePath}:`, e);
-    return '';
-  }
-};

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "commonjs",
-    "lib": ["ES2020"],
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "resolveJsonModule": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}