Allow for easier committing from subdirectories (#33)

* Allow for easier committing from subdirectories

fixes #29

* chore: rename addDirectory -> addFromDirectory

* feat: Introduce `filterFiles` argument

* tests: add tests for new functionality in git.ts

* Fix addFromDirectory implementation

Author: s0

.changeset/light-days-fry.md

@@ -0,0 +1,8 @@
+---
+"@changesets/ghcommit": minor
+---
+
+Introduce `filterFiles` argument for `commitChangesFromRepo`
+
+Allow for a custom function to be specified to filter which files should be
+included in the commit

.changeset/mean-trainers-develop.md

@@ -0,0 +1,10 @@
+---
+"@changesets/ghcommit": minor
+---
+
+Introduce `addFromDirectory` option for `commitChangesFromRepo` to allow users to
+specify a subdirectory of the git repository that should be used to add files
+from, rather then adding all changed files.
+
+This is useful when trying to emulate the behavior of running `git add .`
+from a subdirectory of the repository.

.changeset/old-kings-collect.md

@@ -0,0 +1,11 @@
+---
+"@changesets/ghcommit": minor
+---
+
+Automatically find root in `commitChangesFromRepo`
+when `repoDirectory` is unspecified.
+
+While this does result in a behavioral change for an existing argument,
+it's considered non-breaking as before `commitChangesFromRepo` would just not
+work when run from a subdirectory of a repo when `repoDirectory` was not
+specified.

README.md

@@ -93,9 +93,26 @@ In addition to `CommitFilesBasedArgs`, this function has the following arguments
   /**
    * The root of the repository.
    *
-   * @default process.cwd()
+   * 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.
+   *
+   * Defaults to resolved value of {@link repoDirectory},
+   * which will add all changed files in the repository.
+   */
+  addFromDirectory?: string;
+  /**
+   * 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.
+   *
+   * By default, all files are included.
+   */
+  filterFiles?: (file: string) => boolean;
 }
 ```
 

package.json

@@ -54,8 +54,8 @@
   },
   "devDependencies": {
     "@actions/github": "^6.0.0",
-    "@changesets/cli": "^2.27.7",
     "@changesets/changelog-github": "^0.5.1",
+    "@changesets/cli": "^2.27.7",
     "@graphql-codegen/cli": "^5.0.2",
     "@graphql-codegen/import-types-preset": "^3.0.0",
     "@graphql-codegen/typescript": "^4.0.4",
@@ -74,6 +74,7 @@
     "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

@@ -6,6 +6,7 @@ import {
   CommitFilesFromBuffersArgs,
   CommitFilesResult,
 } from "./interface";
+import { isAbsolute, relative } from "path";
 
 /**
  * @see https://isomorphic-git.org/docs/en/walk#walkerentry-mode
@@ -19,14 +20,18 @@ const FILE_MODES = {
 
 export const commitChangesFromRepo = async ({
   base,
-  repoDirectory = process.cwd(),
+  repoDirectory,
+  addFromDirectory,
+  filterFiles,
   log,
   ...otherArgs
 }: CommitChangesFromRepoArgs): Promise<CommitFilesResult> => {
   const ref = base?.commit ?? "HEAD";
+  const resolvedRepoDirectory =
+    repoDirectory ?? (await git.findRoot({ fs, filepath: process.cwd() }));
   const gitLog = await git.log({
     fs,
-    dir: repoDirectory,
+    dir: resolvedRepoDirectory,
     ref,
     depth: 1,
   });
@@ -37,6 +42,19 @@ 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) + "/";
+
   // Determine changed files
   const trees = [git.TREE({ ref: oid }), git.WORKDIR()];
   const additions: CommitFilesFromBuffersArgs["fileChanges"]["additions"] = [];
@@ -47,14 +65,14 @@ export const commitChangesFromRepo = async ({
   };
   await git.walk({
     fs,
-    dir: repoDirectory,
+    dir: resolvedRepoDirectory,
     trees,
     map: async (filepath, [commit, workdir]) => {
       // Don't include ignored files
       if (
         await git.isIgnored({
           fs,
-          dir: repoDirectory,
+          dir: resolvedRepoDirectory,
           filepath,
         })
       ) {
@@ -88,6 +106,17 @@ export const commitChangesFromRepo = async ({
         // Iterate through these directories
         return true;
       }
+      if (
+        relativeStartDirectory &&
+        !filepath.startsWith(relativeStartDirectory)
+      ) {
+        // Ignore files that are not in the specified directory
+        return null;
+      }
+      if (filterFiles && !filterFiles(filepath)) {
+        // Ignore out files that don't match any specified filter
+        return null;
+      }
       if (!workdir) {
         // File was deleted
         deletions.push(filepath);

src/git.ts

@@ -107,7 +107,24 @@ export interface CommitChangesFromRepoArgs extends CommitFilesBasedArgs {
   /**
    * The root of the repository.
    *
-   * @default process.cwd()
+   * 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.
+   *
+   * Defaults to resolved value of {@link repoDirectory},
+   * which will add all changed files in the repository.
+   */
+  addFromDirectory?: string;
+  /**
+   * 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.
+   *
+   * By default, all files are included.
+   */
+  filterFiles?: (file: string) => boolean;
 }