Initial commit

Author: VChet

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: / # Location of package manifests
+    schedule:
+      interval: monthly

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: build
+
+on:
+  push:
+    branch: master
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+          run_install: true
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: pnpm
+
+      - name: Run linters
+        run: pnpm run lint:all
+
+      - name: Run build
+        run: pnpm run build
+
+      - name: Run tests
+        run: pnpm run test

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

README.md

@@ -0,0 +1,88 @@
+# git-merged-branches CLI
+
+`git-merged-branches` is a simple command-line utility that allows you to view all branches that have been merged into a selected base branch, such as master.
+
+## Installation
+
+To install `git-merged-branches` globally, use the following command:
+
+```bash
+npm install --global git-merged-branches
+```
+
+## Usage
+
+After installation, you can use the `git-merged-branches` command in your terminal. By default, it will show a list of branches that have been merged into the base branch (e.g., master or main).
+
+The utility checks for the default base branch (**master** or **main**), and if neither exists, it will notify you.
+
+When you run the `git-merged-branches` command, it will show a list of branches that have been merged into the base branch:
+
+```bash
+$ git-merged-branches
+Branches merged into 'master':
+feature/add-new-feature
+bugfix/fix-crash-on-start
+hotfix/urgent-fix
+```
+
+Also, you may use `gmb` as an alias for `git-merged-branches`.
+
+## Configuration
+
+You can configure the behavior of the `git-merged-branches` command by adding a `git-merged-branches` object to your `package.json`.
+The configuration allows you to specify:
+
+- **issueUrlFormat**: The base URL for your issue tracker. Must be a valid URL. If it's not, the utility will warn you.
+- **issueUrlPrefix**: The prefix used to identify issues in branch names. Must consist of letters. If it's not, the utility will warn you.
+
+Here is an example of how to add the configuration:
+
+```json
+"git-merged-branches": {
+  "issueUrlFormat": "https://your-jira-instance.net",
+  "issueUrlPrefix": "TOKEN-"
+}
+```
+
+With this configuration, `git-merged-branches` will detect branches with the prefix **TOKEN** and generate links to the issue tracker:
+
+```bash
+$ git-merged-branches
+Branches merged into 'master':
+TOKEN-800_new-feature <https://your-jira-instance.net/TOKEN-800>
+fix/TOKEN-123_some-fix <https://your-jira-instance.net/TOKEN-123>
+fix/EXTERNAL-391
+hotfix
+```
+
+If the configuration is invalid, `git-merged-branches` will display warnings and skip formatting the issue URLs.
+
+## Development
+
+- Clone the repository:
+
+  ```bash
+  git clone https://github.com/VChet/git-merged-branches.git
+  cd git-merged-branches
+  ```
+
+- Install dependencies:
+
+  ```bash
+  npm install
+  ```
+
+- Build:
+
+  ```bash
+  npm run build
+  ```
+
+- Link it locally for testing:
+
+  ```bash
+  npm link
+  ```
+
+Now you can run `git-merged-branches` on your local machine.

build.js

@@ -0,0 +1,15 @@
+import { build } from "esbuild";
+
+build({
+  entryPoints: ["./src/index.ts"],
+  outfile: "dist/index.js",
+  banner: { js: "#!/usr/bin/env node" },
+  bundle: true,
+  platform: "node",
+  format: "esm"
+})
+  .then(() => {
+    console.info("Build complete.");
+    process.exit(0);
+  })
+  .catch(() => process.exit(1));

eslint.config.js

@@ -0,0 +1,15 @@
+import { defineConfig, globalIgnores } from "eslint/config";
+import neostandard from "neostandard";
+
+export default defineConfig([
+  globalIgnores(["dist"]),
+  ...neostandard(),
+  {
+    rules: {
+      "@stylistic/comma-dangle": ["error", "never"],
+      "@stylistic/quotes": ["error", "double"],
+      "@stylistic/semi": ["error", "always"],
+      "@stylistic/space-before-function-paren": ["error", "never"]
+    }
+  }
+]);

package.json

@@ -0,0 +1,31 @@
+{
+  "name": "git-merged-branches",
+  "description": "CLI tool to list merged Git branches",
+  "type": "module",
+  "version": "0.1.0",
+  "author": "VChet",
+  "license": "MIT",
+  "bin": {
+    "git-merged-branches": "./dist/index.js",
+    "gmb": "./dist/index.js"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && node build.js",
+    "lint:ts": "tsc --noEmit",
+    "lint:js": "eslint .",
+    "lint:js:fix": "npm run lint:js -- --fix",
+    "lint:all": "npm run lint:ts && npm run lint:js",
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "@types/node": "^22.14.1",
+    "esbuild": "^0.25.2",
+    "eslint": "^9.24.0",
+    "jest": "^29.7.0",
+    "neostandard": "^0.12.1",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.1"
+  }
+}