@aaronshaf/ger 1.2.1 → 1.2.3

package/.eslintrc.js

@@ -0,0 +1,12 @@
+export default {
+  env: {
+    browser: true,
+    es2022: true,
+  },
+  extends: "eslint:recommended",
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+  },
+  rules: {},
+};

package/README.md

@@ -1,2 +1,9 @@
-# ger
-gerrit cli
+## Usage
+
+```bash
+# list branches with gerrit info
+ger branch
+
+# list branches with expanded gerrit info
+ger branch -v
+```

package/bin/ger

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+/* eslint-disable no-undef */
+
+const path = require("path");
+const { spawnSync } = require("child_process");
+
+const projectDir = path.resolve(__dirname, "..");
+const tsNodePath = path.resolve(projectDir, "node_modules", ".bin", "ts-node");
+const gerTsPath = path.resolve(projectDir, "src", "ger.ts");
+
+const args = process.argv.slice(2);
+
+const result = spawnSync(tsNodePath, [gerTsPath, ...args], {
+  stdio: "inherit",
+  shell: true,
+});
+
+process.exit(result.status);

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@aaronshaf/ger",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Gerrit CLI",
-  "main": "ger.js",
+  "main": "src/ger.ts",
   "bin": {
-    "ger": "./bin/ger.sh"
+    "ger": "./bin/ger"
   },
   "repository": {
     "type": "git",
@@ -18,5 +18,16 @@
   "bugs": {
     "url": "https://github.com/aaronshaf/ger/issues"
   },
-  "homepage": "https://github.com/aaronshaf/ger#readme"
+  "homepage": "https://github.com/aaronshaf/ger#readme",
+  "devDependencies": {
+    "@commander-js/extra-typings": "^10.0.3",
+    "@types/node": "^18.16.1",
+    "cli-table3": "^0.6.3",
+    "eslint": "^8.39.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "dependencies": {
+    "commander": "^10.0.1"
+  }
 }

package/src/commands/branch.ts

@@ -0,0 +1,176 @@
+import { execSync } from "child_process";
+import { createInterface } from "readline";
+import {
+  abbreviateApproverDescription,
+  bold,
+  darkBrown,
+  getGerritData,
+  getLocalBranchData,
+  getLocalBranchNames,
+  green,
+  grey,
+  normalizeApproverName,
+  normalizeValue,
+  yellow,
+} from "../utils";
+import type {
+  LocalBranchDataMap,
+  LocalBranchData,
+  GerritDataMap,
+} from "../types.d";
+
+const Table = require("cli-table3");
+
+export function branch({
+  v: isVerbose,
+  d: shouldPromptForMergedBranchDeletion,
+}: {
+  v?: boolean;
+  d?: boolean;
+}) {
+  const localBranchNameList = getLocalBranchNames();
+  const localBranchDataMap = getLocalBranchData(localBranchNameList);
+  const changeIds: string[] = Object.values<LocalBranchData>(localBranchDataMap)
+    .map((b) => b.changeId)
+    .filter(Boolean) as string[];
+  const gerritOutputByChangeId = getGerritData(changeIds);
+
+  const mergedBranches = localBranchNameList.filter((name) => {
+    const changeId = localBranchDataMap[name].changeId;
+    if (changeId) {
+      const gerritData = gerritOutputByChangeId[changeId];
+      return gerritData?.status === "MERGED";
+    }
+    return false;
+  });
+
+  output(
+    localBranchNameList,
+    localBranchDataMap,
+    gerritOutputByChangeId,
+    Boolean(isVerbose)
+  );
+
+  if (shouldPromptForMergedBranchDeletion) {
+    promptForMergedBranchDeletion(mergedBranches);
+  }
+}
+
+function output(
+  localBranchNameList: string[],
+  localBranchDataMap: LocalBranchDataMap,
+  gerritOutputMap: GerritDataMap,
+  isVerbose: boolean
+) {
+  const tableOptions = {
+    chars: {
+      top: "",
+      "top-mid": "",
+      "top-left": "",
+      "top-right": "",
+      bottom: "",
+      "bottom-mid": "",
+      "bottom-left": "",
+      "bottom-right": "",
+      left: "",
+      "left-mid": "",
+      mid: isVerbose ? "─" : "",
+      "mid-mid": "",
+      right: "",
+      "right-mid": "",
+      middle: " ",
+    },
+    style: { "padding-left": 0, "padding-right": 0 },
+  };
+  const table = new Table(tableOptions);
+
+  for (const localBranch of localBranchNameList) {
+    const changeId = localBranchDataMap[localBranch].changeId;
+    if (changeId && gerritOutputMap[changeId]) {
+      const gerritData = gerritOutputMap[changeId];
+      const subject = gerritData.subject;
+      const isWip = gerritData.wip || subject.toLowerCase().startsWith("WIP");
+      const isMerged = gerritData.status === "MERGED";
+      const isAbandoned = gerritData.status === "ABANDONED";
+      const labels = [
+        isWip && darkBrown("WIP"),
+        isAbandoned && grey("Abandoned"),
+        isMerged && green("Merged"),
+      ]
+        .filter(Boolean)
+        .map((str) => `[${str}]`) as string[];
+
+      const approvals = gerritData.currentPatchSet.approvals.map((a) => {
+        let description = a.description;
+        if (a.type === "SUBM" && !description) {
+          description = "Submitted";
+        }
+        return isVerbose
+          ? `${description || a.type}: ${normalizeValue(
+              a.value
+            )} (${normalizeApproverName(a.by.name)})`
+          : `${abbreviateApproverDescription(
+              description || a.type
+            )}${normalizeValue(a.value)}`;
+      });
+
+      const approvalText = approvals.join(isVerbose ? "\n" : ", ");
+
+      if (isVerbose) {
+        table.push([
+          `${bold(localBranch)}\n${localBranchDataMap[localBranch].shortHash}`,
+          labels.join(" "),
+          `${subject}\n${yellow(gerritData.url.replace("https://", ""))}`,
+          approvalText,
+        ]);
+      } else {
+        table.push([
+          localBranch,
+          labels.join(" "),
+          yellow(String(gerritData.number)),
+          subject,
+          approvalText,
+        ]);
+      }
+    } else {
+      if (isVerbose) {
+        table.push([
+          `${bold(localBranch)}\n${localBranchDataMap[localBranch].shortHash}`,
+          "",
+          localBranchDataMap[localBranch].subject,
+          "",
+        ]);
+      } else {
+        table.push([
+          localBranch,
+          "",
+          "",
+          localBranchDataMap[localBranch].subject,
+          "",
+        ]);
+      }
+    }
+  }
+  console.log(table.toString());
+}
+
+async function promptForMergedBranchDeletion(mergedBranches: string[]) {
+  const readline = createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  for (const mergedLocalBranch of mergedBranches) {
+    const answer: string = await new Promise((resolve) => {
+      readline.question(
+        `Delete merged local branch ${bold(mergedLocalBranch)}? (y/n) `,
+        resolve
+      );
+    });
+    if (answer.toLowerCase() === "y") {
+      execSync(`git branch -D ${mergedLocalBranch}`);
+      console.log(`  Deleted ${bold(mergedLocalBranch)}`);
+    }
+  }
+  process.exit(0);
+}

package/src/ger.ts

@@ -0,0 +1,21 @@
+#!/usr/bin/env ts-node
+
+import { Command } from '@commander-js/extra-typings';
+import { branch } from "./commands/branch";
+
+const version = require("../package.json").version;
+
+const program = new Command();
+program.name("ger").description("Gerrit CLI").version(version);
+
+program
+  .command("branch")
+  .description("Get a list of local branches with Gerrit info")
+  .option("-v", "Show extra information, i.e. approvals")
+  .action((
+    _program: any,
+  ) => {
+    branch(_program);
+  });
+
+program.parse();

package/src/types.d.ts

@@ -0,0 +1,34 @@
+export type LocalBranchData = {
+  changeId: string | null;
+  shortHash: string
+  subject: string;
+}
+
+export type LocalBranchDataMap = {
+  [branchName: string]: LocalBranchData;
+}
+
+export type GerritApproval = {
+  type: 'SUBM';
+  description: string;
+  value: string;
+  by: {
+    name: string;
+  }
+}
+
+export type GerritData = {
+  currentPatchSet: {
+    approvals: GerritApproval[]
+  }
+  id: string;
+  status: 'MERGED' | 'ABANDONED';
+  subject: string;
+  url: string;
+  wip: boolean;
+  number: number
+}
+
+export type GerritDataMap = {
+  [changeId: string]: GerritData;
+}

package/src/utils.ts

@@ -0,0 +1,133 @@
+import { execSync } from "child_process";
+import {
+  GerritData,
+  GerritDataMap,
+  LocalBranchData,
+  LocalBranchDataMap,
+} from "./types.d";
+
+type Row = string[];
+
+export function bold(text: string) {
+  return `\x1b[1m${text}\x1b[0m`;
+}
+
+// grey background
+export function grey(text: string) {
+  return `\x1b[47m\x1b[30m${text}\x1b[0m`;
+}
+
+// brown with transparent background
+export function darkBrown(text: string) {
+  // return `\x1b[43m\x1b[30m${text}\x1b[0m`;
+  return `\x1b[33m${text}\x1b[0m`;
+}
+
+export function green(text: string) {
+  return `\x1b[42m\x1b[30m${text}\x1b[0m`;
+}
+
+// yellow text with transparent background
+export function yellow(text: string) {
+  // return `\x1b[33m\x1b[40m${text}\x1b[0m`;
+  return `\x1b[33m${text}\x1b[0m`;
+}
+
+export function getChangeIdFromCommitMessage(message: string) {
+  // Extract the Change-Id
+  const regex = /Change-Id: .{41}/;
+  const change_id_match = message.match(regex);
+
+  if (change_id_match) {
+    const change_id = change_id_match[0].substring(11);
+    return change_id;
+  }
+  return null;
+}
+
+export function getLocalBranchNames(): string[] {
+  // Extract local branch names
+  const stdout = execSync(
+    `git for-each-ref --sort=committerdate refs/heads/ --format='%(refname:lstrip=2)' | grep -v '^master$'`
+  );
+  return stdout.toString().trim().split("\n");
+}
+
+export function getGerritData(changeIds: string[]) {
+  const query = changeIds.map((cid) => `change:${cid}`).join(" OR ");
+
+  // if query is empty
+  if (!query) {
+    console.log("No change IDs found");
+    process.exit(0);
+  }
+
+  // Run the gerrit query command
+  const gerrit_output = execSync(
+    `ssh gerrit "gerrit query --current-patch-set --format=JSON '${query}'"`
+  )
+    .toString()
+    .trim()
+    .split("\n")
+    .map((line) => JSON.parse(line) as GerritData);
+
+  return gerrit_output.reduce<GerritDataMap>((acc, change) => {
+    return {
+      ...acc,
+      [change.id]: change,
+    };
+  }, {});
+}
+
+export function getLocalBranchData(branchNames: string[]) {
+  return branchNames.reduce<LocalBranchDataMap>((acc, branchName) => {
+    // Get the latest commit SHA and message
+    const gitLogOutput = execSync(`git log -1 --pretty=format:%h%n%B ${branchName}`)
+      .toString()
+      .trim();
+
+    // Split the output into commit SHA and message
+    const [shortHash, ...commitMessageLines] = gitLogOutput.split("\n");
+
+    const localBranchData: LocalBranchData = {
+      changeId: getChangeIdFromCommitMessage(commitMessageLines.join("\n")) || null,
+      subject: commitMessageLines[0],
+      shortHash,
+    };
+
+    return {
+      ...acc,
+      [branchName]: localBranchData,
+    };
+  }, {});
+}
+
+export const normalizeValue = (value: string) => {
+  if (value === "1" || value === "2") {
+    return `+${value}`;
+  }
+  return value;
+};
+
+export function normalizeApproverName(name: string) {
+  return name
+    .replace(" (Bot)", "")
+    .replace("Service Cloud Jenkins", "Jenkins")
+    .replace("Larry Gergich", "Gergich");
+}
+
+export function abbreviateApproverDescription(name: string) {
+  if (name === "Lint-Review") {
+    return `Lint `;
+  }
+  if (name === "Code-Review") {
+    return `CR `;
+  }
+  if (name === "Product-Review") {
+    return `PR `;
+  }
+  if (name === "QA-Review") {
+    return `QA `;
+  }
+  return `${name} `;
+}

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "commonjs",
+    "noEmit": true,
+    "strict": true,
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"]
+}

package/bin/ger.sh

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-require('../ger.js')

package/commands/branch.js

@@ -1,132 +0,0 @@
-const {execSync} = require('child_process')
-
-// Extract local branch names
-const stdout = execSync(
-  `git for-each-ref --sort=committerdate refs/heads/ --format='%(refname:lstrip=2)' | grep -v '^master$'`
-)
-const localBranches = stdout.toString().trim().split('\n')
-
-const localBranchToChangeId = {}
-
-// Initialize an empty query string
-let query = ''
-
-localBranches.forEach(branch => {
-  // Get the latest commit message
-  const commit_message = execSync(`git log -1 --pretty=%B ${branch}`).toString().trim()
-
-  // Extract the Change-Id
-  const regex = /Change-Id: .{41}/
-  const change_id_match = commit_message.match(regex)
-
-  if (change_id_match) {
-    const change_id = change_id_match[0].substring(11)
-    localBranchToChangeId[branch] = change_id
-
-    // Append the Change-Id to the query string
-    query += `change:${change_id} OR `
-  } else {
-    localBranchToChangeId[branch] = null
-  }
-})
-
-// if query is empty
-if (!query) {
-  console.log('No change IDs found')
-  process.exit(0)
-}
-
-// Remove the trailing " OR "
-query = query.replace(/ OR $/, '')
-
-// Run the gerrit query command
-const gerrit_output = execSync(
-  `ssh gerrit "gerrit query --current-patch-set --format=JSON '${query}'"`
-)
-  .toString()
-  .trim()
-  .split('\n')
-  .map(line => JSON.parse(line))
-
-const gerritOutputByChangeId = {}
-for (const change of gerrit_output) {
-  gerritOutputByChangeId[change.id] = change
-}
-
-function bold(text) {
-  return `\x1b[1m${text}\x1b[0m`
-}
-// grey background
-function grey(text) {
-  return `\x1b[47m\x1b[30m${text}\x1b[0m`
-}
-function darkBrown(text) {
-  return `\x1b[43m\x1b[30m${text}\x1b[0m`
-}
-function green(text) {
-  return `\x1b[42m\x1b[30m${text}\x1b[0m`
-}
-// function red(text) {
-//   return `\x1b[41m\x1b[30m${text}\x1b[0m`
-// }
-
-const mergedBranches = localBranches.filter(localBranch => {
-  const changeId = localBranchToChangeId[localBranch]
-  const gerritData = gerritOutputByChangeId[changeId]
-  return gerritData?.status === 'MERGED'
-})
-
-for (const localBranch of localBranches) {
-  const changeId = localBranchToChangeId[localBranch]
-  if (changeId && gerritOutputByChangeId[changeId]) {
-    const gerritData = gerritOutputByChangeId[changeId]
-    const isWip = gerritData.wip || gerritData.subject.toLowerCase().startsWith('WIP')
-    const isMerged = gerritData.status === 'MERGED'
-    const isAbandoned = gerritData.status === 'ABANDONED'
-    const labels = [
-      isWip && darkBrown('WIP'),
-      isAbandoned && grey('Abandoned'),
-      isMerged && green('Merged'),
-    ].filter(Boolean)
-    console.log(`${bold(localBranch)}: ${gerritData.subject} ${labels.join(' ')}`)
-    console.log(`  ${gerritData.url.replace('https://', '')}`)
-    for (const approval of gerritData.currentPatchSet.approvals) {
-      let description = approval.description
-      if (approval.type === 'SUBM' && !description) {
-        description = 'Submitted'
-      }
-      console.log(
-        `    ${description || approval.type}: ${approval.value} (${approval.by.name.replace(
-          ' (Bot)',
-          ''
-        )})`
-      )
-    }
-  } else {
-    console.log(`${localBranch}`)
-  }
-  // blank line
-  console.log('')
-}
-
-// if -d flag is passed
-if (process.argv[3] === '-d') {
-  async function promptForMergedBranchDeletion() {
-    const readline = require('readline').createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    })
-
-    for (const mergedLocalBranch of mergedBranches) {
-      const answer = await new Promise(resolve => {
-        readline.question(`Delete merged local branch ${bold(mergedLocalBranch)}? (y/n) `, resolve)
-      })
-      if (answer.toLowerCase() === 'y') {
-        execSync(`git branch -D ${mergedLocalBranch}`)
-        console.log(`  Deleted ${bold(mergedLocalBranch)}`)
-      }
-    }
-    process.exit(0)
-  }
-  promptForMergedBranchDeletion()
-}

package/ger.js

@@ -1,5 +0,0 @@
-const branch = require('./commands/branch.js')
-
-if (process.argv[2] === 'branch') {
-  branch()
-}