codeowners-git 1.5.0 → 1.7.0

package/README.md

@@ -6,7 +6,7 @@
 
 Managing large-scale migrations in big monorepos with multiple codeowners can be overwhelming. Massive PRs touching thousands of files make it hard for teams to review changes efficiently.
 
-`codeowners-git` solves this by:
+`codeowners-git` (or `cg` for short) solves this by:
 
 - Identifying files owned by specific teams using the CODEOWNERS file.
 - Creating compact, team-specific branches with only their affected files.
@@ -24,6 +24,8 @@ Run commands directly without installation:
 
 ```bash
 npx codeowners-git <command>
+# or use the short alias
+npx cg <command>
 ```
 
 ### Install globally via npm
@@ -36,6 +38,8 @@ Then run commands directly:
 
 ```bash
 codeowners-git <command>
+# or use the short alias
+cg <command>
 ```
 
 ## Configuration
@@ -46,6 +50,29 @@ The tool automatically detects CODEOWNERS files in:
 2. `docs/CODEOWNERS`
 3. `CODEOWNERS` (root directory)
 
+### Pull Request Features
+
+The `--pr` and `--draft-pr` options require the [GitHub CLI (`gh`)](https://cli.github.com/) to be installed and authenticated:
+
+```bash
+# Install GitHub CLI (macOS)
+brew install gh
+
+# Install GitHub CLI (Windows)
+winget install --id GitHub.cli
+
+# Install GitHub CLI (Linux)
+sudo apt install gh
+
+# Authenticate with GitHub
+gh auth login
+```
+
+The tool will automatically:
+- Use PR templates if they exist in your repository (`.github/pull_request_template.md`, etc.)
+- Set the PR title to your commit message
+- Create PRs against the repository's default branch
+
 ## Commands
 
 ### `--version`
@@ -58,6 +85,8 @@ Usage:
 codeowners-git --version
 # or
 codeowners-git -V
+# or using the short alias
+cg --version
 ```
 
 ### `list`
@@ -68,6 +97,8 @@ Usage:
 
 ```bash
 codeowners-git list [options]
+# or
+cg list [options]
 ```
 
 Options:
@@ -79,6 +110,8 @@ Example:
 
 ```bash
 codeowners-git list -o @myteam
+# or
+cg list -o @myteam
 ```
 
 ### `branch`
@@ -89,6 +122,8 @@ Usage:
 
 ```bash
 codeowners-git branch [options]
+# or
+cg branch [options]
 ```
 
 Options:
@@ -103,15 +138,25 @@ Options:
 - `--force, -f` Force push to remote
 - `--keep-branch-on-failure, -k` Keep the created branch even if operation fails
 - `--append` Add commits to existing branch instead of creating a new one
+- `--pr` Create a pull request after pushing (requires `--push` and GitHub CLI)
+- `--draft-pr` Create a draft pull request after pushing (requires `--push` and GitHub CLI)
 
 Example:
 
 ```bash
 # Create a new branch
 codeowners-git branch -o @myteam -b "feature/new-feature" -m "Add new feature" -p
+# or
+cg branch -o @myteam -b "feature/new-feature" -m "Add new feature" -p
+
+# Create a branch and automatically create a pull request
+cg branch -o @myteam -b "feature/new-feature" -m "Add new feature" -p --pr
+
+# Create a branch and automatically create a draft pull request
+cg branch -o @myteam -b "feature/new-feature" -m "Add new feature" -p --draft-pr
 
 # Add more commits to the same branch later
-codeowners-git branch -o @myteam -b "feature/new-feature" -m "Add more changes" --append -p
+cg branch -o @myteam -b "feature/new-feature" -m "Add more changes" --append -p
 ```
 
 ### `multi-branch`
@@ -122,6 +167,8 @@ Usage:
 
 ```bash
 codeowners-git multi-branch [options]
+# or
+cg multi-branch [options]
 ```
 
 Options:
@@ -138,6 +185,8 @@ Options:
 - `--ignore` Comma-separated patterns to exclude codeowners (e.g., 'team-a,team-b')
 - `--include` Comma-separated patterns to include codeowners (e.g., 'team-_,@org/_')
 - `--append` Add commits to existing branches instead of creating new ones
+- `--pr` Create pull requests after pushing (requires `--push` and GitHub CLI)
+- `--draft-pr` Create draft pull requests after pushing (requires `--push` and GitHub CLI)
 
 > **Note:** You cannot use both `--ignore` and `--include` options at the same time.
 
@@ -146,18 +195,26 @@ Example:
 ```bash
 # Create branches for all codeowners
 codeowners-git multi-branch -b "feature/new-feature" -m "Add new feature" -p
+# or
+cg multi-branch -b "feature/new-feature" -m "Add new feature" -p
+
+# Create branches and automatically create pull requests for each
+cg multi-branch -b "feature/new-feature" -m "Add new feature" -p --pr
+
+# Create branches and automatically create draft pull requests for each
+cg multi-branch -b "feature/new-feature" -m "Add new feature" -p --draft-pr
 
 # Exclude specific teams
-codeowners-git multi-branch -b "feature/new-feature" -m "Add new feature" --ignore "@ce-orca,@ce-ece"
+cg multi-branch -b "feature/new-feature" -m "Add new feature" --ignore "@ce-orca,@ce-ece"
 
 # Include only specific patterns
-codeowners-git multi-branch -b "feature/new-feature" -m "Add new feature" --include "@team-*"
+cg multi-branch -b "feature/new-feature" -m "Add new feature" --include "@team-*"
 
 # Use default owner when no codeowners found
-codeowners-git multi-branch -b "feature/new-feature" -m "Add new feature" -d "@default-team"
+cg multi-branch -b "feature/new-feature" -m "Add new feature" -d "@default-team"
 
 # Add more commits to existing branches
-codeowners-git multi-branch -b "feature/new-feature" -m "Add more changes" --append -p
+cg multi-branch -b "feature/new-feature" -m "Add more changes" --append -p
 ```
 
 This will:

package/dist/cli.js

@@ -14686,6 +14686,24 @@ var pushBranch = async (branchName, {
     throw new Error(`Push failed: ${error}`);
   }
 };
+var getDefaultBranch = async () => {
+  try {
+    const result = await git.raw(["symbolic-ref", "refs/remotes/origin/HEAD"]);
+    const match = result.match(/refs\/remotes\/origin\/(.+)/);
+    if (match) {
+      return match[1].trim();
+    }
+  } catch {
+    const branches = await git.branch(["-r"]);
+    if (branches.all.includes("origin/main")) {
+      return "main";
+    }
+    if (branches.all.includes("origin/master")) {
+      return "master";
+    }
+  }
+  return "main";
+};
 
 // src/utils/codeowners.ts
 var codeowners;
@@ -14776,6 +14794,105 @@ var listCodeowners = async (options) => {
   }
 };
 
+// src/utils/github.ts
+import { spawn as spawn3 } from "child_process";
+import { readFile } from "fs/promises";
+var isGitHubCliInstalled = async () => {
+  return new Promise((resolve) => {
+    const process3 = spawn3("gh", ["--version"], { stdio: "pipe" });
+    process3.on("close", (code) => {
+      resolve(code === 0);
+    });
+    process3.on("error", () => {
+      resolve(false);
+    });
+  });
+};
+var findPRTemplate = async () => {
+  const possiblePaths = [
+    ".github/pull_request_template.md",
+    ".github/PULL_REQUEST_TEMPLATE.md",
+    ".github/PULL_REQUEST_TEMPLATE/pull_request_template.md",
+    "docs/pull_request_template.md",
+    "docs/PULL_REQUEST_TEMPLATE.md",
+    "pull_request_template.md",
+    "PULL_REQUEST_TEMPLATE.md"
+  ];
+  for (const templatePath of possiblePaths) {
+    try {
+      const content = await readFile(templatePath, "utf-8");
+      log.info(`Found PR template at: ${templatePath}`);
+      return { path: templatePath, content: content.trim() };
+    } catch {}
+  }
+  return null;
+};
+var createPullRequest = async (options) => {
+  const { title, body, draft = false, base = "main", head } = options;
+  if (!await isGitHubCliInstalled()) {
+    throw new Error("GitHub CLI (gh) is not installed. Please install it to create pull requests.");
+  }
+  const args = ["pr", "create", "--title", title];
+  args.push("--body", body || "");
+  if (draft) {
+    args.push("--draft");
+  }
+  if (base) {
+    args.push("--base", base);
+  }
+  if (head) {
+    args.push("--head", head);
+  }
+  return new Promise((resolve, reject) => {
+    const process3 = spawn3("gh", args, { stdio: "pipe" });
+    let output = "";
+    let errorOutput = "";
+    process3.stdout.on("data", (data) => {
+      output += data.toString();
+    });
+    process3.stderr.on("data", (data) => {
+      errorOutput += data.toString();
+    });
+    process3.on("close", (code) => {
+      if (code === 0) {
+        const urlMatch = output.match(/https:\/\/github\.com\/[^\s]+/);
+        const numberMatch = output.match(/#(\d+)/);
+        if (urlMatch && numberMatch) {
+          const url = urlMatch[0];
+          const number = parseInt(numberMatch[1], 10);
+          log.success(`${draft ? "Draft " : ""}Pull request created: ${url}`);
+          resolve({ url, number });
+        } else {
+          log.success(`${draft ? "Draft " : ""}Pull request created successfully`);
+          resolve({ url: output.trim(), number: 0 });
+        }
+      } else {
+        const error = new Error(`Failed to create pull request: ${errorOutput || output}`);
+        log.error(error.message);
+        reject(error);
+      }
+    });
+    process3.on("error", (error) => {
+      reject(new Error(`Failed to execute gh command: ${error.message}`));
+    });
+  });
+};
+var createPRWithTemplate = async (title, branchName, options = {}) => {
+  const template = await findPRTemplate();
+  let body = "";
+  if (template) {
+    body = template.content;
+    log.info("Using PR template for pull request body");
+  }
+  return createPullRequest({
+    title,
+    body,
+    draft: options.draft,
+    base: options.base,
+    head: branchName
+  });
+};
+
 // src/commands/branch.ts
 var branch = async (options) => {
   let originalBranch = "";
@@ -14786,6 +14903,12 @@ var branch = async (options) => {
     if (!options.branch || !options.message || !options.owner) {
       throw new Error("Missing required options for branch creation");
     }
+    if ((options.pr || options.draftPr) && !options.push) {
+      throw new Error("Pull request creation requires --push option");
+    }
+    if (options.pr && options.draftPr) {
+      throw new Error("Cannot use both --pr and --draft-pr options");
+    }
     log.info(options.append ? "Starting branch update process..." : "Starting branch creation process...");
     originalBranch = await getCurrentBranch();
     log.info(`Currently on branch: ${originalBranch}`);
@@ -14823,6 +14946,21 @@ var branch = async (options) => {
           noVerify: !options.verify
         });
       }
+      if ((options.pr || options.draftPr) && options.push) {
+        try {
+          const defaultBranch = await getDefaultBranch();
+          const prResult = await createPRWithTemplate(options.message, options.branch, {
+            draft: options.draftPr,
+            base: defaultBranch
+          });
+          if (prResult) {
+            log.success(`${options.draftPr ? "Draft " : ""}Pull request #${prResult.number} created: ${prResult.url}`);
+          }
+        } catch (prError) {
+          log.error(`Failed to create pull request: ${prError}`);
+          log.info("Branch was successfully created and pushed, but PR creation failed");
+        }
+      }
       log.info(`Checking out original branch "${originalBranch}"...`);
       await checkout(originalBranch);
       if (branchAlreadyExists && options.append) {
@@ -14876,6 +15014,12 @@ var multiBranch = async (options) => {
     if (options.ignore && options.include) {
       throw new Error("Cannot use both --ignore and --include options at the same time");
     }
+    if ((options.pr || options.draftPr) && !options.push) {
+      throw new Error("Pull request creation requires --push option");
+    }
+    if (options.pr && options.draftPr) {
+      throw new Error("Cannot use both --pr and --draft-pr options");
+    }
     log.info(options.append ? "Starting multi-branch update process..." : "Starting multi-branch creation process...");
     const changedFiles = await getChangedFiles();
     if (changedFiles.length === 0) {
@@ -14924,7 +15068,9 @@ var multiBranch = async (options) => {
     }
     const results = {
       success: [],
-      failure: []
+      failure: [],
+      prSuccess: [],
+      prFailure: []
     };
     for (const owner of codeowners2) {
       try {
@@ -14943,9 +15089,14 @@ var multiBranch = async (options) => {
           force: options.force,
           keepBranchOnFailure: options.keepBranchOnFailure,
           isDefaultOwner: owner === options.defaultOwner,
-          append: options.append
+          append: options.append,
+          pr: options.pr,
+          draftPr: options.draftPr
         });
         results.success.push(owner);
+        if ((options.pr || options.draftPr) && options.push) {
+          results.prSuccess.push(owner);
+        }
       } catch (error) {
         log.error(`Failed to ${options.append ? "update" : "create"} branch for ${owner}: ${error}`);
         results.failure.push(owner);
@@ -14959,13 +15110,20 @@ var multiBranch = async (options) => {
     if (results.failure.length) {
       log.error(`Failed: ${results.failure.join(", ")}`);
     }
+    if (options.pr || options.draftPr) {
+      log.header(`${options.draftPr ? "Draft " : ""}Pull request creation summary`);
+      log.info(`Successfully created ${options.draftPr ? "draft " : ""}pull requests for ${results.prSuccess.length} of ${results.success.length} successful branches`);
+      if (results.prSuccess.length) {
+        log.success(`${options.draftPr ? "Draft " : ""}PRs created for: ${results.prSuccess.join(", ")}`);
+      }
+    }
   } catch (err) {
     log.error(`Multi-branch operation failed: ${err}`);
     process.exit(1);
   }
 };
 // package.json
-var version = "1.5.0";
+var version = "1.7.0";
 
 // src/commands/version.ts
 function getVersion() {
@@ -14974,8 +15132,8 @@ function getVersion() {
 
 // src/cli.ts
 var program2 = new Command;
-program2.name("codeowners").description("CLI tool for grouping and managing staged files by CODEOWNERS").version(getVersion());
+program2.name("codeowners-git (cg)").description("CLI tool for grouping and managing staged files by CODEOWNERS").version(getVersion());
 program2.command("list").description("Lists all git changed files by CODEOWNER").option("-o, --owner <owner>", "Filter by specific code owner").option("-i, --include <patterns>", "Filter by owner patterns").action(listCodeowners);
-program2.command("branch").description("Create new branch with codeowner changes").requiredOption("-o, --owner <owner>", "Code owner name").requiredOption("-b, --branch <branch>", "Branch name").requiredOption("-m, --message <message>", "Commit message").option("-n, --no-verify", "Skip lint-staged or any other ci checks").option("-p, --push", "Push branch to remote after commit").option("-r, --remote <remote>", "Remote name to push to", "origin").option("-u, --upstream <upstream>", "Upstream branch name (defaults to local branch name)").option("-f, --force", "Force push to remote").option("-k, --keep-branch-on-failure", "Keep the created branch even if operation fails").option("--append", "Add commits to existing branch instead of creating a new one").action(branch);
-program2.command("multi-branch").description("Create branches for all codeowners").requiredOption("-b, --branch <branch>", "Base branch name (will be suffixed with codeowner name)").requiredOption("-m, --message <message>", "Base commit message (will be suffixed with codeowner name)").option("-n, --no-verify", "Skip lint-staged or any other ci checks").option("-p, --push", "Push branches to remote after commit").option("-r, --remote <remote>", "Remote name to push to", "origin").option("-u, --upstream <upstream>", "Upstream branch name pattern (defaults to local branch name)").option("-f, --force", "Force push to remote").option("-k, --keep-branch-on-failure", "Keep created branches even if operation fails").option("-d, --default-owner <defaultOwner>", "Default owner to use when no codeowners are found for changed files").option("--ignore <patterns>", "Comma-separated patterns to exclude codeowners (e.g., 'team-a,team-b')").option("--include <patterns>", "Comma-separated patterns to include codeowners (e.g., 'team-*,@org/*')").option("--append", "Add commits to existing branches instead of creating new ones").action(multiBranch);
+program2.command("branch").description("Create new branch with codeowner changes").requiredOption("-o, --owner <owner>", "Code owner name").requiredOption("-b, --branch <branch>", "Branch name").requiredOption("-m, --message <message>", "Commit message").option("-n, --no-verify", "Skip lint-staged or any other ci checks").option("-p, --push", "Push branch to remote after commit").option("-r, --remote <remote>", "Remote name to push to", "origin").option("-u, --upstream <upstream>", "Upstream branch name (defaults to local branch name)").option("-f, --force", "Force push to remote").option("-k, --keep-branch-on-failure", "Keep the created branch even if operation fails").option("--append", "Add commits to existing branch instead of creating a new one").option("--pr", "Create a pull request after pushing (requires --push)").option("--draft-pr", "Create a draft pull request after pushing (requires --push)").action(branch);
+program2.command("multi-branch").description("Create branches for all codeowners").requiredOption("-b, --branch <branch>", "Base branch name (will be suffixed with codeowner name)").requiredOption("-m, --message <message>", "Base commit message (will be suffixed with codeowner name)").option("-n, --no-verify", "Skip lint-staged or any other ci checks").option("-p, --push", "Push branches to remote after commit").option("-r, --remote <remote>", "Remote name to push to", "origin").option("-u, --upstream <upstream>", "Upstream branch name pattern (defaults to local branch name)").option("-f, --force", "Force push to remote").option("-k, --keep-branch-on-failure", "Keep created branches even if operation fails").option("-d, --default-owner <defaultOwner>", "Default owner to use when no codeowners are found for changed files").option("--ignore <patterns>", "Comma-separated patterns to exclude codeowners (e.g., 'team-a,team-b')").option("--include <patterns>", "Comma-separated patterns to include codeowners (e.g., 'team-*,@org/*')").option("--append", "Add commits to existing branches instead of creating new ones").option("--pr", "Create pull requests after pushing (requires --push)").option("--draft-pr", "Create draft pull requests after pushing (requires --push)").action(multiBranch);
 program2.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeowners-git",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "module": "src/cli.ts",
   "type": "module",
   "private": false,
@@ -32,13 +32,19 @@
     "build": "bun build src/cli.ts --compile --outfile bin/codeowners-git",
     "build:dist": "bun build src/cli.ts --outdir dist/ --target node",
     "test": "bun test --watch",
-    "test:ci": "bun test --watch",
+    "test:unit": "bun test src/**",
+    "test:e2e": "bun test test/e2e",
+    "test:e2e:local": "TEST_REPO_URL=../cg-test bun test test/e2e",
+    "test:all": "bun run test:unit && bun run test:e2e",
+    "test:ci": "bun run test:all",
+    "type-check": "bun tsc",
     "format": "biome format --write ./src",
     "lint": "biome lint ./src",
-    "prepublish": "bun run build:dist && bun test"
+    "prepublish": "bun run build:dist && bun run test:all"
   },
   "bin": {
-    "codeowners-git": "dist/cli.js"
+    "codeowners-git": "dist/cli.js",
+    "cg": "dist/cli.js"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.12",