Clean up interfaces & arguments

Author: s0

src/core.ts

@@ -1,56 +1,18 @@
-import type {
-  CommitMessage,
-  FileChanges,
-} from "./github/graphql/generated/types.js";
 import {
   createCommitOnBranchQuery,
   createRefMutation,
   getRepositoryMetadata,
-  GitHubClient,
   updateRefMutation,
 } from "./github/graphql/queries.js";
 import type {
   CreateCommitOnBranchMutationVariables,
   GetRepositoryMetadataQuery,
 } from "./github/graphql/generated/operations.js";
-import type { Logger } from "./logging.js";
-
-export type CommitFilesResult = {
-  refId: string | null;
-};
-
-export type GitBase =
-  | {
-      branch: string;
-    }
-  | {
-      tag: string;
-    }
-  | {
-      commit: string;
-    };
-
-export type CommitFilesFromBase64Args = {
-  octokit: GitHubClient;
-  owner: string;
-  repository: string;
-  branch: string;
-  /**
-   * The current branch, tag or commit that the new branch should be based on.
-   */
-  base: GitBase;
-  /**
-   * Push the commit even if the branch exists and does not match what was
-   * specified as the base.
-   */
-  force?: boolean;
-  /**
-   * The commit message
-   */
-  message: CommitMessage;
-  fileChanges: FileChanges;
-  log?: Logger;
-};
+import {
+  CommitFilesFromBase64Args,
+  CommitFilesResult,
+  GitBase,
+} from "./interface.js";
 
 const getBaseRef = (base: GitBase): string => {
   if ("branch" in base) {

src/fs.ts

@@ -1,23 +1,11 @@
 import { promises as fs } from "fs";
 import * as path from "path";
 import type { FileAddition } from "./github/graphql/generated/types.js";
-import { CommitFilesFromBase64Args, CommitFilesResult } from "./core.js";
 import { commitFilesFromBuffers } from "./node.js";
-
-export type CommitFilesFromDirectoryArgs = Omit<
-  CommitFilesFromBase64Args,
-  "fileChanges"
-> & {
-  /**
-   * The directory to consider the root of the repository when calculating
-   * file paths
-   */
-  workingDirectory?: string;
-  fileChanges: {
-    additions?: string[];
-    deletions?: string[];
-  };
-};
+import {
+  CommitFilesFromDirectoryArgs,
+  CommitFilesResult,
+} from "./interface.js";
 
 export const commitFilesFromDirectory = async ({
   workingDirectory = process.cwd(),

src/git.ts

@@ -1,25 +1,17 @@
 import { promises as fs } from "fs";
 import git from "isomorphic-git";
-import { CommitFilesFromBase64Args } from "./core";
-import { commitFilesFromBuffers, CommitFilesFromBuffersArgs } from "./node";
-
-export type CommitChangesFromRepoArgs = Omit<
-  CommitFilesFromBase64Args,
-  "fileChanges" | "base"
-> & {
-  /**
-   * The root of the repository.
-   *
-   * @default process.cwd()
-   */
-  repoDirectory?: string;
-};
+import { commitFilesFromBuffers } from "./node";
+import {
+  CommitChangesFromRepoArgs,
+  CommitFilesFromBuffersArgs,
+  CommitFilesResult,
+} from "./interface";
 
 export const commitChangesFromRepo = async ({
   repoDirectory = process.cwd(),
   log,
   ...otherArgs
-}: CommitChangesFromRepoArgs) => {
+}: CommitChangesFromRepoArgs): Promise<CommitFilesResult> => {
   const gitLog = await git.log({
     fs,
     dir: repoDirectory,

src/interface.ts

@@ -0,0 +1,89 @@
+import type {
+  CommitMessage,
+  FileChanges,
+} from "./github/graphql/generated/types.js";
+import type { GitHubClient } from "./github/graphql/queries.js";
+
+import type { Logger } from "./logging.js";
+
+export type CommitFilesResult = {
+  refId: string | null;
+};
+
+export type GitBase =
+  | {
+      branch: string;
+    }
+  | {
+      tag: string;
+    }
+  | {
+      commit: string;
+    };
+
+export interface CommitFilesBasedArgs {
+  octokit: GitHubClient;
+  owner: string;
+  repository: string;
+  branch: string;
+  /**
+   * Push the commit even if the branch exists and does not match what was
+   * specified as the base.
+   */
+  force?: boolean;
+  /**
+   * The commit message
+   */
+  message: CommitMessage;
+  log?: Logger;
+}
+
+export interface CommitFilesSharedArgsWithBase extends CommitFilesBasedArgs {
+  /**
+   * The current branch, tag or commit that the new branch should be based on.
+   */
+  base: GitBase;
+}
+
+export interface CommitFilesFromBase64Args
+  extends CommitFilesSharedArgsWithBase {
+  fileChanges: FileChanges;
+}
+
+export interface CommitFilesFromBuffersArgs
+  extends CommitFilesSharedArgsWithBase {
+  fileChanges: {
+    additions?: Array<{
+      path: string;
+      contents: Buffer;
+    }>;
+    deletions?: string[];
+  };
+}
+
+export interface CommitFilesFromDirectoryArgs extends CommitFilesSharedArgsWithBase {
+  /**
+   * The directory to consider the root of the repository when calculating
+   * file paths
+   */
+  workingDirectory?: string;
+  /**
+   * The file paths, relative to {@link workingDirectory},
+   * to add or delete from the branch on GitHub.
+   */
+  fileChanges: {
+    /** File paths, relative to {@link workingDirectory}, to remove from the repo. */
+    additions?: string[];
+    /** File paths, relative to the repository root, to remove from the repo. */
+    deletions?: string[];
+  };
+}
+
+export interface CommitChangesFromRepoArgs extends CommitFilesBasedArgs {
+  /**
+   * The root of the repository.
+   *
+   * @default process.cwd()
+   */
+  repoDirectory?: string;
+}

src/node.ts

@@ -1,21 +1,5 @@
-import {
-  commitFilesFromBase64,
-  CommitFilesFromBase64Args,
-  CommitFilesResult,
-} from "./core.js";
-
-export type CommitFilesFromBuffersArgs = Omit<
-  CommitFilesFromBase64Args,
-  "fileChanges"
-> & {
-  fileChanges: {
-    additions?: Array<{
-      path: string;
-      contents: Buffer;
-    }>;
-    deletions?: string[];
-  };
-};
+import { commitFilesFromBase64 } from "./core.js";
+import { CommitFilesFromBuffersArgs, CommitFilesResult } from "./interface.js";
 
 export const commitFilesFromBuffers = async ({
   fileChanges,

tsup.config.ts

@@ -6,6 +6,7 @@ export default defineConfig({
     "src/core.ts",
     "src/git.ts",
     "src/fs.ts",
+    "src/interfaces.ts",
     "src/node.ts",
   ],
   format: ["cjs", "esm"],