Remove any use of process.cwd(), and clean up directory options across functions (#40)

* Clean up arguments for multiple functions

- Use `cwd` consistently across functions
- Remove unnecessary extra directory args for `commitChangesFromRepo`
- Introduce `recursivelyFindRoot` argument

* Fix node tests

Author: s0

.changeset/blue-carpets-jam.md

@@ -0,0 +1,21 @@
+---
+"@changesets/ghcommit": major
+---
+
+Refactor & clean up options for multiple functions
+
+- For `commitFilesFromDirectory`:
+  - Rename `workingDirectory` to `cwd` for consistency across repos,
+    and utils like `exec`
+  - Make `cwd` a required argument
+- For `commitChangesFromRepo`:
+  - Merge `repoDirectory` and `addFromDirectory` into a single required argument
+    `cwd`. This folder will now both be used to filter which files are added,
+    and to find the root of the repository.
+  - Introduce `recursivelyFindRoot` option (default: `true`),
+    to optionally search for the root of the repository,
+    by checking for existence of `.git` directory in parent directories,
+    starting from `cwd`.
+
+This effectively removes all usage of process.cwd() within the package,
+instead requiring all usage to be very explicit with specifying paths.

README.md

@@ -82,6 +82,13 @@ In addition to `CommitFilesBasedArgs`, this function has the following arguments
 
 ```ts
 {
+  /**
+   * The directory used to find the repository root,
+   * and search for changed files to commit.
+   *
+   * Any files that have been changed outside of this directory will be ignored.
+   */
+  cwd: string;
   /**
    * The base commit to build your changes on-top of
    *
@@ -91,21 +98,13 @@ In addition to `CommitFilesBasedArgs`, this function has the following arguments
     commit: string;
   };
   /**
-   * The root of the repository.
-   *
-   * When unspecified, the root of the repository will be found by recursively
-   * searching for the `.git` directory from the current working directory.
-   */
-  repoDirectory?: string;
-  /**
-   * The starting directory to recurse from when detecting changed files.
-   *
-   * Useful for monorepos where you want to add files from a specific directory only.
+   * Don't require {@link cwd} to be the root of the repository,
+   * and use it as a starting point to recursively search for the `.git`
+   * directory in parent directories.
    *
-   * Defaults to resolved value of {@link repoDirectory},
-   * which will add all changed files in the repository.
+   * @default true
    */
-  addFromDirectory?: string;
+  recursivelyFindRoot?: boolean;
   /**
    * An optional function that can be used to filter which files are included
    * in the commit. True should be returned for files that should be included.
@@ -131,6 +130,7 @@ await commitChangesFromRepo({
   ...context.repo,
   branch: "new-branch-to-create",
   message: "[chore] do something",
+  cwd: process.cwd(),
 });
 
 // Commit & push the files from a specific directory
@@ -141,7 +141,7 @@ await commitChangesFromRepo({
   repository: "my-repo",
   branch: "another-new-branch-to-create",
   message: "[chore] do something else\n\nsome more details",
-  repoDirectory: "/tmp/some-repo",
+  cwd: "/tmp/some-repo",
 });
 
 // Commit & push the files from the current directory,
@@ -154,6 +154,7 @@ await commitChangesFromRepo({
     headline: "[chore] do something else",
     body: "some more details",
   },
+  cwd: process.cwd(),
   base: {
     // This will be the original sha from the workflow run,
     // even if we've made commits locally
@@ -178,7 +179,7 @@ In addition to `CommitFilesBasedArgs`, this function has the following arguments
    * The directory to consider the root of the repository when calculating
    * file paths
    */
-  workingDirectory?: string;
+  cwd: string;
   /**
    * The file paths, relative to {@link workingDirectory},
    * to add or delete from the branch on GitHub.
@@ -210,7 +211,7 @@ await commitFilesFromDirectory({
   base: {
     branch: "main",
   },
-  workingDirectory: "foo/bar",
+  cwd: "foo/bar",
   fileChanges: {
     additions: ["package-lock.json", "package.json"],
   },
@@ -226,7 +227,7 @@ await commitFilesFromDirectory({
   base: {
     tag: "v1.0.0",
   },
-  workingDirectory: "some-dir",
+  cwd: "some-dir",
   fileChanges: {
     additions: ["index.html"],
   },

package.json

@@ -74,7 +74,6 @@
     "eslint-plugin-jest": "^28.6.0",
     "eslint-plugin-only-warn": "^1.1.0",
     "jest": "^29.7.0",
-    "mock-cwd": "^1.0.0",
     "pino": "^9.3.2",
     "pino-pretty": "^11.2.2",
     "prettier": "^3.3.3",

pnpm-lock.yaml

@@ -8,15 +8,15 @@ import {
 } from "./interface.js";
 
 export const commitFilesFromDirectory = async ({
-  workingDirectory = process.cwd(),
+  cwd,
   fileChanges,
   ...otherArgs
 }: CommitFilesFromDirectoryArgs): Promise<CommitFilesResult> => {
   const additions: FileAddition[] = await Promise.all(
     (fileChanges.additions || []).map(async (p) => {
       return {
         path: p,
-        contents: await fs.readFile(path.join(workingDirectory, p)),
+        contents: await fs.readFile(path.join(cwd, p)),
       };
     }),
   );

src/fs.ts

@@ -6,7 +6,7 @@ import {
   CommitFilesFromBuffersArgs,
   CommitFilesResult,
 } from "./interface";
-import { isAbsolute, relative } from "path";
+import { relative, resolve } from "path";
 
 /**
  * @see https://isomorphic-git.org/docs/en/walk#walkerentry-mode
@@ -20,18 +20,20 @@ const FILE_MODES = {
 
 export const commitChangesFromRepo = async ({
   base,
-  repoDirectory,
-  addFromDirectory,
+  cwd: workingDirectory,
+  recursivelyFindRoot = true,
   filterFiles,
   log,
   ...otherArgs
 }: CommitChangesFromRepoArgs): Promise<CommitFilesResult> => {
   const ref = base?.commit ?? "HEAD";
-  const resolvedRepoDirectory =
-    repoDirectory ?? (await git.findRoot({ fs, filepath: process.cwd() }));
+  const cwd = resolve(workingDirectory);
+  const repoRoot = recursivelyFindRoot
+    ? await git.findRoot({ fs, filepath: cwd })
+    : cwd;
   const gitLog = await git.log({
     fs,
-    dir: resolvedRepoDirectory,
+    dir: repoRoot,
     ref,
     depth: 1,
   });
@@ -42,18 +44,12 @@ export const commitChangesFromRepo = async ({
     throw new Error(`Could not determine oid for ${ref}`);
   }
 
-  if (addFromDirectory && !isAbsolute(addFromDirectory)) {
-    throw new Error(
-      `addFromDirectory must be an absolute path, got ${addFromDirectory}`,
-    );
-  }
-
   /**
    * The directory to add files from. This is relative to the repository
    * root, and is used to filter files.
    */
   const relativeStartDirectory =
-    addFromDirectory && relative(resolvedRepoDirectory, addFromDirectory) + "/";
+    cwd === repoRoot ? null : relative(repoRoot, cwd) + "/";
 
   // Determine changed files
   const trees = [git.TREE({ ref: oid }), git.WORKDIR()];
@@ -65,14 +61,14 @@ export const commitChangesFromRepo = async ({
   };
   await git.walk({
     fs,
-    dir: resolvedRepoDirectory,
+    dir: repoRoot,
     trees,
     map: async (filepath, [commit, workdir]) => {
       // Don't include ignored files
       if (
         await git.isIgnored({
           fs,
-          dir: resolvedRepoDirectory,
+          dir: repoRoot,
           filepath,
         })
       ) {

src/git.ts

@@ -72,20 +72,27 @@ export interface CommitFilesFromDirectoryArgs
    * The directory to consider the root of the repository when calculating
    * file paths
    */
-  workingDirectory?: string;
+  cwd: string;
   /**
-   * The file paths, relative to {@link workingDirectory},
+   * The file paths, relative to {@link cwd},
    * to add or delete from the branch on GitHub.
    */
   fileChanges: {
-    /** File paths, relative to {@link workingDirectory}, to remove from the repo. */
+    /** File paths, relative to {@link cwd}, 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 directory used to find the repository root,
+   * and search for changed files to commit.
+   *
+   * Any files that have been changed outside of this directory will be ignored.
+   */
+  cwd: string;
   /**
    * The base commit to build your changes on-top of.
    *
@@ -105,21 +112,13 @@ export interface CommitChangesFromRepoArgs extends CommitFilesBasedArgs {
     commit: string;
   };
   /**
-   * The root of the repository.
-   *
-   * When unspecified, the root of the repository will be found by recursively
-   * searching for the `.git` directory from the current working directory.
-   */
-  repoDirectory?: string;
-  /**
-   * The starting directory to recurse from when detecting changed files.
-   *
-   * Useful for monorepos where you want to add files from a specific directory only.
+   * Don't require {@link cwd} to be the root of the repository,
+   * and use it as a starting point to recursively search for the `.git`
+   * directory in parent directories.
    *
-   * Defaults to resolved value of {@link repoDirectory},
-   * which will add all changed files in the repository.
+   * @default true
    */
-  addFromDirectory?: string;
+  recursivelyFindRoot?: boolean;
   /**
    * An optional function that can be used to filter which files are included
    * in the commit. True should be returned for files that should be included.

src/interface.ts

@@ -37,7 +37,7 @@ describe("fs", () => {
           headline: "Test commit",
           body: "This is a test commit",
         },
-        workingDirectory: tmpDir,
+        cwd: tmpDir,
         fileChanges: {
           additions: ["foo.txt"],
         },