• Update git-raw-commits dependency from v4 to v5 with ESM-only API
• Replace default import with named exports getRawCommits and GitOptions
• Implement manual skip option handling in async iterator pattern
• Remove deprecated streamToPromise utility function

Migrate to git-raw-commits v5 API with skip handling

• Changed from default import gitRawCommits to named exports getRawCommits and GitOptions type
• Replaced stream-based approach with async iterator pattern using for await...of
• Implemented manual skip option handling by slicing returned data array
• Updated function signature to use imported GitOptions type instead of namespaced type

@commitlint/read/src/get-history-commits.ts

Delete deprecated stream utility function

• Removed entire file as it is no longer needed
• Functionality replaced by inline async iterator pattern in getHistoryCommits

@commitlint/read/src/stream-to-promise.ts

Bump git-raw-commits to v5 with types

• Updated git-raw-commits dependency from ^4.0.0 to ^5.0.0
• Updated @types/git-raw-commits from ^2.0.3 to ^5.0.0

@commitlint/read/package.json

Description

getHistoryCommits() passes options.skip directly to Array.slice() without validating it is a
finite non-negative integer, so a boolean/string skip value coming from --git-log-args parsing
can change which commits are linted (e.g. true becomes 1) instead of failing fast.

Code

@commitlint/read/src/get-history-commits.ts[R9-16]

+	const { skip, ...gitOptions } = options as GitOptions & { skip?: number };
+	const data: string[] = [];
+	for await (const commit of getRawCommits({ ...gitOptions, cwd: opts.cwd })) {
+		data.push(commit);
+	}
+	if (skip) {
+		return data.slice(skip);
+	}

Evidence

skip is only type-asserted (not validated) and then used as the slice index. The caller builds
GitOptions by spreading the untyped minimist() output from the user-provided gitLogArgs
string, and the CLI explicitly exposes this as “additional git log arguments”, meaning invalid
values can realistically reach this codepath.

@commitlint/read/src/get-history-commits.ts[5-17]
@commitlint/read/src/read.ts[72-79]
@commitlint/cli/src/cli.ts[99-103]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`getHistoryCommits()` reads `skip` out of the options object and uses it as an `Array.slice()` index without runtime validation. Since `gitLogArgs` is user-provided and parsed via `minimist`, `skip` can become a boolean/string and be coerced by `slice()` (e.g. `true` -> 1), changing which commits are linted.

### Issue Context
- `gitLogArgs` is explicitly an "additional git log arguments" escape hatch exposed by the CLI.
- The code currently relies on a TypeScript assertion (`{ skip?: number }`) but performs no runtime checks.

### Fix Focus Areas
- @commitlint/read/src/get-history-commits.ts[9-16]
- @commitlint/read/src/read.ts[72-79]

### Suggested approach
- Extract `skipRaw` from options.
- Compute `skipNum` safely (e.g. if number use it; if string try `Number(...)`; otherwise invalid).
- If `skipRaw` is defined but `skipNum` is not a finite integer >= 0, throw an error.
- Use `skipNum` for skipping logic (see also the memory optimization in the second finding).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Description

When skip is set, getHistoryCommits() still stores the skipped commits in data and only removes
them afterward via slice(), causing unnecessary memory/time overhead for large skip values or
large commit ranges.

Code

@commitlint/read/src/get-history-commits.ts[R10-16]

+	const data: string[] = [];
+	for await (const commit of getRawCommits({ ...gitOptions, cwd: opts.cwd })) {
+		data.push(commit);
+	}
+	if (skip) {
+		return data.slice(skip);
+	}

Evidence

The function buffers all commits into data unconditionally, then discards the first skip
elements by slicing. This means skipped commits are still retained in memory even though they are
never returned.

@commitlint/read/src/get-history-commits.ts[9-16]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
When `skip` is provided, `getHistoryCommits()` currently buffers all commits (including the ones to be skipped) and then drops them with `data.slice(skip)`. This retains unnecessary data in memory and does extra work.

### Issue Context
- `getRawCommits()` is iterated as an async iterable, so commits can be skipped on the fly.
- This optimization is independent of the correctness validation (but pairs well with it).

### Fix Focus Areas
- @commitlint/read/src/get-history-commits.ts[9-16]

### Suggested approach
- After validating/coercing `skip`, do something like:
 - `let remainingToSkip = skipNum ?? 0;`
 - In the loop, if `remainingToSkip > 0`, decrement and `continue` without pushing.
 - Otherwise `data.push(commit)`.
- Return `data` directly (no slicing), and avoid allocating/retaining skipped commits.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools