@git-lazy/const

Constants for git subprocess execution, including buffer size limits to prevent ENOBUFS errors

Installation

npm install @git-lazy/const
# or
pnpm add @git-lazy/const
# or
yarn add @git-lazy/const

Usage

import { GitExecMaxBuffer } from '@git-lazy/const';
import { execSync } from 'child_process';

// 執行可能產生大量輸出的 git 命令
// Execute git commands that may produce large output
const output = execSync('git log --all --oneline', {
  maxBuffer: GitExecMaxBuffer,
});

API

GitExecMaxBuffer

Git 執行緩衝區上限常數 / Git execution buffer size limit constant

防止 git 子程序執行時因輸出過大而觸發 ENOBUFS（緩衝區溢出）錯誤。當 git 命令產生大量輸出（如大型倉庫的 git log 或 git diff）時，預設緩衝區大小不足會導致程序異常終止。

Prevents ENOBUFS (buffer overflow) errors when executing git subprocesses due to excessive output. When git commands produce large amounts of output (such as git log or git diff for large repositories), the default buffer size may be insufficient, causing the process to terminate abnormally.

Value: 104857600 (100 MB / 1024 * 1024 * 100)

Example:

import { GitExecMaxBuffer } from '@git-lazy/const';
import { execSync } from 'child_process';

// 使用 execSync 執行 git 命令
// Execute git command with execSync
const output = execSync('git log --all --oneline', {
  maxBuffer: GitExecMaxBuffer,
});

import { GitExecMaxBuffer } from '@git-lazy/const';
import { execa } from 'execa';

// 使用 execa 執行 git 命令
// Execute git command with execa
const { stdout } = await execa('git', ['diff', '--stat'], {
  maxBuffer: GitExecMaxBuffer,
});

License

ISC