sfdx-git-delta 7.0.1 → 7.2.0

package/README.md

@@ -119,7 +119,7 @@ It's also important to implement a way to switch back to full deployment in case
 
 ### Prerequisites
 
-The plugin requires git command line on the running environment.
+No `git` binary is required: the plugin reads the repository's git object store in-process.
 
 **Node v22 or above is required**.
 To check if Salesforce CLI runs under a supported node version for SGD, run `sf --version`. You should see a node version of v22 or above to use SGD.
@@ -201,9 +201,13 @@ FLAG DESCRIPTIONS
     * If the folder exists, its contents will be processed.
     * If the folder doesn't exist, it usually won't show any output—unless the folder was recently deleted and is part
     of a diff, in which case changes may still be picked up.
+
+    Each value must be a literal repository-relative path: wildcards (`*`, `?`, `[`), git pathspec magic (`:(...)`),
+    absolute paths, `..` and the empty string are all rejected. Matching is rooted at the repository root, so
+    `--source-dir force-app` does not match `nested/force-app/...`.
 ```
 
-_See code: [src/commands/sgd/source/delta.ts](https://github.com/scolladon/sfdx-git-delta/blob/v7.0.1/src/commands/sgd/source/delta.ts)_
+_See code: [src/commands/sgd/source/delta.ts](https://github.com/scolladon/sfdx-git-delta/blob/v7.2.0/src/commands/sgd/source/delta.ts)_
 <!-- commandsstop -->
 
 ### Windows users
@@ -511,6 +515,10 @@ $ tree
 $ sf sgd source delta --from commit --source-dir force-app/unpackaged/admin --source-dir force-app/unpackaged/ui
 ```
 
+Each `--source-dir` value is a **literal** repository-relative folder (or file) path, matched from the repository root — `--source-dir force-app` matches `force-app/...` but never `nested/force-app/...`. A trailing slash or a leading `./` is accepted and canonicalised (`force-app/`, `./force-app` and `force-app` all scope the same folder).
+
+Wildcards (`*`, `?`, `[`), git pathspec magic (`:(exclude)…`, `:!…`, `:(glob)…`, …), absolute paths, `..`, and the empty string are all rejected with an error — `--source-dir` never matches a glob pattern. For pattern matching, repeat `--source-dir` once per folder, or use `--include-file [-n]` / `--ignore-file [-i]` (gitignore-spec patterns) instead.
+
 > The ignored patterns specified using `--ignore-file [-i]` and `--ignore-destructive-file [-D]` still apply.
 > The `--source-dir` path must be relative to the `--repo-dir` path
 
@@ -525,7 +533,7 @@ sf sgd source delta --from baseline --to HEAD --output-dir ./delta --generate-de
   $(jq -r '.packageDirectories[] | "--source-dir", .path' sfdx-project.json)
 ```
 
-[jq](https://jqlang.github.io/jq/) reads every `packageDirectories[].path` entry and expands it into a `--source-dir` argument.
+[jq](https://jqlang.github.io/jq/) reads every `packageDirectories[].path` entry and expands it into a `--source-dir` argument. `sfdx-project.json` package directory paths commonly carry a trailing slash (e.g. `"force-app/"`); since `--source-dir` canonicalises trailing slashes away, this recipe works unchanged whether or not your `packageDirectories[].path` entries end in `/`.
 
 > See [Scoping delta generation to specific folders](#scoping-delta-generation-to-specific-folders) for the `--source-dir` behavior.
 > Prefer `--ignore-file [-i]` when you only need to skip a few known paths (e.g. `**/.claude/**`) without coupling to `sfdx-project.json`.
@@ -604,6 +612,7 @@ const work = await sgd({
   output: '', // source package specific output. [default : "./output"]
   apiVersion: '', // salesforce API version. [default : latest]
   repo: '', // git repository location. [default : "."]
+  source: ['.'], // (required) one or more repo-relative folders to scope the diff to; '.' (or an empty array) means the whole repository
 })
 
 console.log(JSON.stringify(work))

package/lib/adapter/GitAdapter.d.ts

@@ -1,91 +1,52 @@
-import { type Readable } from 'node:stream';
+import { Readable } from 'node:stream';
+import { type ObjectId, type Repository } from '@scolladon/tsgit';
 import type { Config } from '../types/config.js';
 import type { FileGitRef } from '../types/git.js';
-import { GitBatchCatFile } from './gitBatchCatFile.js';
-import type { GitBlobReader, SpawnFn } from './gitBlobReader.js';
+import type { Pathspec } from '../utils/pathspec.js';
+import { type GitBlobReader } from './gitBlobReader.js';
 import { TreeIndex } from './treeIndex.js';
+export type DiffScopeVerdict = {
+    changesSeen: number;
+    linesYielded: number;
+};
 export default class GitAdapter implements GitBlobReader {
     protected readonly config: Config;
     private static instances;
     private static keyFor;
     static getInstance(config: Config): GitAdapter;
+    static closeAll(): Promise<void>;
     protected readonly treeIndex: Map<string, TreeIndex>;
-    protected batchCatFile: GitBatchCatFile | null;
-    private readonly streamingChildren;
-    private static readonly STDERR_BUFFER_CAP;
-    private static readonly LFS_POINTER_CAP;
-    private spawnFn;
+    protected readonly blobIdIndex: Map<string, Map<string, ObjectId>>;
+    private repoHandle;
     private constructor();
-    /**
-     * Testability seam: lets unit tests swap in a fake spawn for streaming
-     * subprocesses. Production always uses `child_process.spawn`.
-     */
-    setSpawnFn(spawnFn: SpawnFn): void;
-    protected getBatchCatFile(): GitBatchCatFile;
-    closeBatchProcess(): void;
-    static closeAll(): void;
+    protected getRepo(): Promise<Repository>;
+    close(): Promise<void>;
     configureRepository(): Promise<void>;
     parseRev(ref: string): Promise<string>;
     preBuildTreeIndex(revision: string, scopePaths: string[]): Promise<void>;
-    /**
-     * Spawns `git <args>`, streams stdout through a readline interface, and
-     * yields one line at a time. Replaces the old "run command, split on EOL"
-     * pattern that accumulated a multi-MB string for megarepo diffs / tree
-     * listings before any downstream consumer ran.
-     *
-     * The spawned child is pushed into streamingChildren so closeAll()
-     * kills it if teardown happens mid-stream. stderr is drained to the
-     * debug log; a non-zero exit code rejects the iterator on next read.
-     */
-    protected _spawnLines(args: string[]): AsyncGenerator<string>;
-    /**
-     * One-shot buffered git invocation. Spawns `git <args>`, drains stdout
-     * fully, and returns the trimmed UTF-8 string. Used by callers that
-     * need the complete output as a single string (revparse, raw-style
-     * commands, config writes) rather than a line-by-line stream.
-     *
-     * Mirrors _spawnLines' exit-code handling: non-zero exits throw with
-     * the stderr tail (capped at STDERR_BUFFER_CAP) in the message. Output
-     * is trimmed so callers receive the same shape they used to get from
-     * the legacy `simpleGit({ trimmed: true })` configuration.
-     */
-    protected _gitBuffered(args: string[]): Promise<string>;
-    private _buildExitError;
-    private _trackChild;
+    protected indexRevision(revision: string): Promise<Map<string, ObjectId>>;
     protected pathExistsImpl(path: string, revision: string): boolean;
     pathExists(path: string, revision?: string): Promise<boolean>;
     getFirstCommitRef(): Promise<string>;
+    protected resolveObjectId(forRef: FileGitRef): Promise<ObjectId>;
+    protected readBlobBuffer(forRef: FileGitRef): Promise<Buffer>;
     getBufferContent(forRef: FileGitRef): Promise<Buffer>;
     getBufferContentOrEscalate(forRef: FileGitRef): Promise<Buffer>;
-    /**
-     * Streams a directory from `revision` as `git archive --format=tar`
-     * entries. Yields `{ path, stream }` per file entry (directories are
-     * skipped). The tar subprocess is registered in streamingChildren so
-     * closeAll kills it on teardown.
-     *
-     * Callers MUST consume each entry's stream — even when skipping the
-     * entry — otherwise tar-stream back-pressures and halts parsing. For
-     * skip cases use `stream.resume()` to drain-and-discard.
-     */
+    streamContent(forRef: FileGitRef): Readable;
+    private pipeBlobContent;
+    private pipeLfsObject;
     streamArchive(path: string, revision: string): AsyncGenerator<{
         path: string;
         stream: Readable;
     }>;
-    /**
-     * Spawns a dedicated `git cat-file blob <oid>` subprocess and returns a
-     * Readable that peeks the first chunks for LFS pointer magic. On match,
-     * the spawned subprocess is killed and the Readable is fed from the
-     * resolved LFS object file. Otherwise bytes are forwarded as-is.
-     */
-    streamContent(forRef: FileGitRef): Readable;
-    private _wireStreamContent;
-    private _handoffToLfs;
     getStringContent(forRef: FileGitRef): Promise<string>;
     protected getFilesPathCached(path: string, revision: string): string[];
     getFilesPath(paths: string | string[], revision?: string): Promise<string[]>;
     listDirAtRevision(dir: string, revision: string): Promise<string[]>;
-    gitGrep(pattern: string, path: string | string[], revision?: string): Promise<string[]>;
-    streamDiffLines(): AsyncGenerator<string>;
-    protected _getNumstatLines(changeType: string, detectRenames: boolean): Promise<string[]>;
-    private _getRenameLines;
+    grepUnderPaths(pattern: string, path: string | string[], revision?: string): Promise<string[]>;
+    grepMatchingPathspecs(pattern: string, path: string | string[], revision?: string): Promise<string[]>;
+    private grepBlobs;
+    streamDiffLines(verdict: DiffScopeVerdict, scopes: readonly Pathspec[]): AsyncGenerator<string>;
+    getUnmatchedSourceScopes(verdict: DiffScopeVerdict, scopes: readonly Pathspec[]): readonly string[];
+    private requestDiff;
 }