new-branch 0.1.1 → 0.2.0

package/README.md

@@ -119,13 +119,11 @@ Example AST representation:
 
 ## 6. Built-in Variables
 
-Variable Description
-
----
-
-type Branch type (feat, fix, etc.)
-title Human-readable task title
-id Task identifier (e.g., STK-123)
+| Variable | Description                     |
+| -------- | ------------------------------- |
+| type     | Branch type (feat, fix, etc.)   |
+| title    | Human-readable task title       |
+| id       | Task identifier (e.g., STK-123) |
 
 ---
 
@@ -135,28 +133,29 @@ All transforms must be pure functions.
 
 ### 7.1 String Transforms
 
-| Transform \| Description \|
-
-\|------------\|-------------\| slugify \| Converts to URL-safe slug \|
-\| lowercase \| Converts to lowercase \| \| uppercase \| Converts to
-uppercase \| \| trim \| Trims whitespace \| \| titlecase \| Capitalizes
-words \|
+| Transform | Description               |
+| --------- | ------------------------- |
+| slugify   | Converts to URL-safe slug |
+| lowercase | Converts to lowercase     |
+| uppercase | Converts to uppercase     |
+| trim      | Trims whitespace          |
+| titlecase | Capitalizes words         |
 
 ### 7.2 Argument-based Transforms
 
-| Transform \| Description \| Example \|
-
-\|------------\|-------------\|---------\| max \| Truncates string to
-max length \| max:25 \| \| pad \| Pads string to length \| pad:10 \|
+| Transform | Description                    | Example |
+| --------- | ------------------------------ | ------- |
+| max       | Truncates string to max length | max:25  |
+| pad       | Pads string to length          | pad:10  |
 
 ### 7.3 Validation Transforms
 
-Validation transforms do not modify value but throw errors if invalid.
+Validation transforms do not modify a value but throw errors if invalid.
 
-| Transform \| Description \|
-
-\|------------\|-------------\| required \| Ensures value is not empty
-\| \| match \| Validates via regex \|
+| Transform | Description                |
+| --------- | -------------------------- |
+| required  | Ensures value is not empty |
+| match     | Validates value via regex  |
 
 ---
 
@@ -237,12 +236,10 @@ Validation must occur immediately after input.
 
 ## 12. Optional Flags
 
-Flag Description
-
----
-
---create Creates branch using `git switch -c`
---print Prints branch name only (default behavior)
+| Flag       | Description                                |
+| ---------- | ------------------------------------------ |
+| `--create` | Creates branch using `git switch -c`       |
+| `--print`  | Prints branch name only (default behavior) |
 
 ---
 

package/dist/cli.js

@@ -4,6 +4,7 @@ import { parsePattern } from "./pattern/parsePattern.js";
 import { defaultTransforms } from "./pattern/transforms/index.js";
 import { renderPattern } from "./pattern/transforms/renderPattern.js";
 import { resolveMissingValues } from "./runtime/resolveMissingValues.js";
+import { loadProjectConfig } from "./config/loadProjectConfig.js";
 import { sanitizeGitRef } from "./git/sanitizeGitRef.js";
 import { validateBranchName } from "./git/validateBranchName.js";
 import { createBranch } from "./git/createBranch.js";
@@ -47,15 +48,22 @@ function toInitialValues(args) {
 }
 async function run() {
     // Step 0: args/options
+    // Note: CAC prints help, but depending on our parseArgs wrapper we might not
+    // expose `help` in `args.options`. We still want to exit early and never
+    // require a pattern when the user just asked for help.
+    const argv = process.argv.slice(2);
+    const wantsHelp = argv.includes("--help") || argv.includes("-h");
     const args = parseArgs(process.argv);
-    if (args.options.help) {
+    if (wantsHelp) {
         return;
     }
     const quiet = args.options.quiet === true;
     const create = args.options.create === true;
     const prompt = args.options.prompt !== false;
     // Pipeline: pattern -> AST -> resolve values -> render -> sanitize -> validate -> (optional) git -> output
-    const patternRes = requirePattern(args.options.pattern);
+    const projectConfig = await loadProjectConfig();
+    const resolvedPattern = args.options.pattern ?? projectConfig.pattern;
+    const patternRes = requirePattern(resolvedPattern);
     if (!isOk(patternRes))
         fail("Invalid CLI arguments.", patternRes.error);
     const astRes = safe(() => parsePattern(patternRes.value));

package/dist/config/loadProjectConfig.js

@@ -0,0 +1,19 @@
+import { readFile } from "node:fs/promises";
+import { join } from "node:path";
+export async function loadProjectConfig() {
+    try {
+        const path = join(process.cwd(), "package.json");
+        const raw = await readFile(path, "utf8");
+        const pkg = JSON.parse(raw);
+        const config = pkg["new-branch"];
+        if (!config || typeof config !== "object")
+            return {};
+        const cfg = config;
+        return {
+            pattern: typeof cfg.pattern === "string" ? cfg.pattern : undefined,
+        };
+    }
+    catch {
+        return {};
+    }
+}

package/dist/config/loadProjectConfig.test.js

@@ -0,0 +1,34 @@
+import { vi, describe, it, expect, beforeEach } from "vitest";
+vi.mock("node:fs/promises", () => ({
+    readFile: vi.fn(),
+}));
+import { readFile } from "node:fs/promises";
+describe("loadProjectConfig", () => {
+    beforeEach(() => {
+        vi.resetAllMocks();
+    });
+    it("returns pattern when package.json contains new-branch.pattern as string", async () => {
+        readFile.mockResolvedValueOnce(JSON.stringify({ "new-branch": { pattern: "{type}/{title}-{id}" } }));
+        const { loadProjectConfig } = await import("./loadProjectConfig.js");
+        const cfg = await loadProjectConfig();
+        expect(cfg).toEqual({ pattern: "{type}/{title}-{id}" });
+    });
+    it("returns empty object when package.json has no new-branch key", async () => {
+        readFile.mockResolvedValueOnce(JSON.stringify({ name: "pkg" }));
+        const { loadProjectConfig } = await import("./loadProjectConfig.js");
+        const cfg = await loadProjectConfig();
+        expect(cfg).toEqual({});
+    });
+    it("ignores non-string pattern values", async () => {
+        readFile.mockResolvedValueOnce(JSON.stringify({ "new-branch": { pattern: 123 } }));
+        const { loadProjectConfig } = await import("./loadProjectConfig.js");
+        const cfg = await loadProjectConfig();
+        expect(cfg).toEqual({});
+    });
+    it("returns empty object if reading package.json throws", async () => {
+        readFile.mockRejectedValueOnce(new Error("enoent"));
+        const { loadProjectConfig } = await import("./loadProjectConfig.js");
+        const cfg = await loadProjectConfig();
+        expect(cfg).toEqual({});
+    });
+});

package/dist/runtime/enums.js

@@ -0,0 +1,11 @@
+export const TYPE_CHOICES = [
+    { name: "Feature", value: "feat" },
+    { name: "Fix", value: "fix" },
+    { name: "Documentation", value: "docs" },
+    { name: "Chore", value: "chore" },
+    { name: "Refactor", value: "refactor" },
+    { name: "Test", value: "test" },
+    { name: "Performance", value: "perf" },
+    { name: "Build", value: "build" },
+    { name: "CI", value: "ci" },
+];

package/dist/runtime/resolveMissingValues.js

@@ -1,19 +1,30 @@
-import { input } from "@inquirer/prompts";
+import { input, select } from "@inquirer/prompts";
+import { TYPE_CHOICES } from "../runtime/enums.js";
 /**
  * Resolves missing variable values required by the pattern.
  *
  * Rule (v1):
  * - Any variable used in the pattern is considered required.
+ * - The "type" variable is resolved using a select menu with predefined choices.
  */
 export async function resolveMissingValues(parsed, initialValues, opts) {
     const requiredVars = parsed.variablesUsed;
     const values = { ...initialValues };
     for (const name of requiredVars) {
-        if (values[name])
+        const current = values[name];
+        if (current && current.trim() !== "")
             continue;
         if (!opts.prompt) {
             throw new Error(`Missing required value: "${name}"`);
         }
+        if (name === "type") {
+            const selected = await select({
+                message: "Select branch type:",
+                choices: TYPE_CHOICES,
+            });
+            values[name] = selected;
+            continue;
+        }
         const answer = await input({
             message: `Enter ${name}:`,
             validate: (v) => (v.trim() ? true : `${name} cannot be empty`),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "new-branch",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Generate and create standardized git branch names from a pattern.",
   "keywords": [
     "git",
@@ -18,8 +18,8 @@
     "start": "node dist/cli.js",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "prepack": "pnpm build && pnpm test:run",
-    "test": "vitest",
-    "test:run": "vitest run",
+    "test": "vitest --dir src --exclude **/dist/**",
+    "test:run": "vitest run --dir src --exclude **/dist/**",
     "format": "prettier . --write",
     "format:check": "prettier . --check",
     "lint": "eslint src --ext .ts"
@@ -40,6 +40,9 @@
   "bugs": {
     "url": "https://github.com/teles/new-branch/issues"
   },
+  "new-branch": {
+    "pattern": "{type}/{title}-{id}"
+  },
   "homepage": "https://github.com/teles/new-branch#readme",
   "packageManager": "pnpm@10.22.0",
   "devDependencies": {