@bridge-ds/core 0.9.0 → 0.10.0

package/dist/node/suggestion-apply-node.d.ts

@@ -0,0 +1,69 @@
+import { type BridgeConfig } from '../config';
+import { type PlanSuggestionApplyInput, type SuggestionApplyOutcome, type SuggestionApplyPlan, type SuggestionWorkspace } from '../suggestion-apply';
+/** 3-way merge of three texts with `git merge-file -p`: the merged text, with conflict markers when not clean. */
+export declare function mergeText(root: string, input: {
+    ours: string;
+    base: string;
+    theirs: string;
+}): Promise<{
+    clean: boolean;
+    text: string;
+    conflicts: number;
+}>;
+/** A unified diff of one file between two texts (null: absent), with a/ and b/ paths like `git diff`. */
+export declare function fileDiff(path: string, before: string | null, after: string | null): Promise<string>;
+export interface GitWorkspaceOptions {
+    /** Read this commit or branch. Absent: the working tree. */
+    ref?: string | undefined;
+    /** When the base commit is not in the clone, how to read a file there (for example GitHubClient.readFile). */
+    readBase?: ((path: string, sha: string) => Promise<string | null>) | undefined;
+}
+/**
+ * The workspace a suggestion plans against on a git checkout: the working tree (to write files there) or a ref (to
+ * commit on top of it). The base commit is fetched from origin when the clone lacks it.
+ */
+export declare function gitWorkspace(root: string, opts?: GitWorkspaceOptions): SuggestionWorkspace;
+export type LocalApplyMode = 'branch' | 'write' | 'patch';
+export interface ApplySuggestionLocallyInput extends Omit<PlanSuggestionApplyInput, 'workspace' | 'config'> {
+    /** Repository root (a git checkout). */
+    root: string;
+    /** The issue number, for the branch name and the commit message. */
+    number: number;
+    /** Default: bridge.config.json read where the plan reads (the base ref, or the working tree for "write"). */
+    config?: BridgeConfig | undefined;
+    /** Default "branch". */
+    mode?: LocalApplyMode | undefined;
+    /** Plan and diff only: nothing is written. */
+    dryRun?: boolean | undefined;
+    /** The ref the branch or patch builds on. Default "HEAD". Ignored by "write" (the working tree). */
+    base?: string | undefined;
+    /** Branch name. Default `<branchPrefix>suggestion-<n>-<slug>`, then -2, -3 when taken. */
+    branch?: string | undefined;
+    /** GitHub login of the developer, for the applied comment. */
+    by?: string | undefined;
+    readBase?: GitWorkspaceOptions['readBase'];
+    /** Clock for the applied comment (tests). */
+    now?: (() => string) | undefined;
+}
+export type LocalApplyStatus = 'dry-run' | 'branch-created' | 'branch-exists' | 'written' | 'patch' | Exclude<SuggestionApplyOutcome, 'ready'>;
+export interface LocalSuggestionApply {
+    status: LocalApplyStatus;
+    exitCode: 0 | 1 | 3;
+    message: string;
+    plan: SuggestionApplyPlan;
+    branch?: string | undefined;
+    commit?: string | undefined;
+    /** `git format-patch` text (mode "patch"). */
+    patch?: string | undefined;
+    /** Unified diff of what is (or, in a dry run, would be) written. */
+    diff?: string | undefined;
+    /** Files written into the working tree (mode "write"). */
+    written?: string[] | undefined;
+    /** The applied record to post on the issue once a branch or files exist (posting is the caller's). */
+    appliedComment?: string | undefined;
+}
+/**
+ * Plans a suggestion against the local checkout and hands the result over as a branch (default), files in the
+ * working tree, or a patch. Refused, blocked, conflicting or already applied plans write nothing.
+ */
+export declare function applySuggestionLocally(input: ApplySuggestionLocallyInput): Promise<LocalSuggestionApply>;