new-branch 0.4.0 → 0.5.0

package/README.md

@@ -102,6 +102,35 @@ Example:
 - `date` → YYYY-MM-DD
 - `dateCompact` → YYYYMMDD
 
+### Git Built-ins (derived from current Git repository)
+
+- `currentBranch` → Current Git branch name (e.g. `main`, `feature/PROJ-123`)
+- `shortSha` → Short SHA of `HEAD` (e.g. `a1b2c3d`)
+- `repoName` → Repository directory name
+- `userName` → Git user name (`git config user.name`)
+- `lastTag` → Most recent Git tag (`git describe --tags --abbrev=0`)
+
+> Note:
+>
+> - Git built-ins are resolved lazily and only when referenced in the pattern.
+> - They are never prompted interactively.
+> - When unavailable (e.g. outside a Git repository), they resolve to an empty string.
+
+#### Example with Git built-ins
+
+```bash
+new-branch \
+  --pattern "{currentBranch}-{shortSha}-{type}-{title:slugify}" \
+  --type feat \
+  --title "Improve logging"
+```
+
+Example output:
+
+```
+main-a1b2c3d-feat-improve-logging
+```
+
 ---
 
 ## Built-in Transforms

package/dist/cli.js

@@ -7,6 +7,7 @@ import { resolveMissingValues } from "./runtime/resolveMissingValues.js";
 import { getBuiltinValues } from "./runtime/builtins.js";
 import { loadProjectConfig } from "./config/loadProjectConfig.js";
 import { getGitConfig } from "./git/gitConfig.js";
+import { extractGitBuiltinKeysFromPattern, getGitBuiltins, patternNeedsGitBuiltins, } from "./git/gitBuiltins.js";
 import { sanitizeGitRef } from "./git/sanitizeGitRef.js";
 import { validateBranchName } from "./git/validateBranchName.js";
 import { createBranch } from "./git/createBranch.js";
@@ -76,9 +77,21 @@ export async function run() {
     const astRes = safe(() => parsePattern(patternRes.value));
     if (!isOk(astRes))
         fail("Invalid pattern.", astRes.error);
+    // Runtime built-ins (date, etc.)
     const builtinValues = getBuiltinValues();
+    // Git built-ins (only if the pattern references them)
+    let gitValues = {};
+    if (patternNeedsGitBuiltins(patternRes.value)) {
+        const gitKeys = extractGitBuiltinKeysFromPattern(patternRes.value);
+        const gitRes = await safeAsync(() => getGitBuiltins(gitKeys));
+        if (!isOk(gitRes))
+            fail("Failed to resolve git builtins.", gitRes.error);
+        // GitBuiltins is compatible with RenderValues (string | undefined)
+        gitValues = gitRes.value;
+    }
     const initialValues = {
         ...builtinValues,
+        ...gitValues,
         ...toInitialValues(args),
     };
     const valuesRes = await safeAsync(() => resolveMissingValues(astRes.value, initialValues, {

package/dist/git/gitBuiltins.js

@@ -0,0 +1,79 @@
+import { execa } from "execa";
+import { getGitConfig } from "../git/gitConfig.js";
+export const GIT_BUILTIN_KEYS = [
+    "shortSha",
+    "currentBranch",
+    "userName",
+    "repoName",
+    "lastTag",
+];
+function uniqueKeys(keys) {
+    return Array.from(new Set(keys));
+}
+function pickAllKeysIfUndefined(keys) {
+    return keys?.length ? uniqueKeys(keys) : GIT_BUILTIN_KEYS;
+}
+async function safeExec(args) {
+    try {
+        const { stdout } = await execa("git", args);
+        const value = stdout.trim();
+        return value.length ? value : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+function deriveRepoName(repoRoot) {
+    const parts = repoRoot.split(/[\\/]/).filter(Boolean);
+    return parts.length ? parts[parts.length - 1] : undefined;
+}
+const RESOLVERS = {
+    shortSha: () => safeExec(["rev-parse", "--short", "HEAD"]),
+    currentBranch: async () => {
+        const value = await safeExec(["rev-parse", "--abbrev-ref", "HEAD"]);
+        return value === "HEAD" ? undefined : value;
+    },
+    repoName: async () => {
+        const repoRoot = await safeExec(["rev-parse", "--show-toplevel"]);
+        return repoRoot ? deriveRepoName(repoRoot) : undefined;
+    },
+    lastTag: () => safeExec(["describe", "--tags", "--abbrev=0"]),
+    userName: async () => {
+        const value = await getGitConfig("user.name");
+        return value ?? process.env.USER ?? process.env.USERNAME ?? undefined;
+    },
+};
+async function resolveGitBuiltins(keys) {
+    const wanted = pickAllKeysIfUndefined(keys);
+    const entries = await Promise.all(wanted.map(async (key) => {
+        const value = await RESOLVERS[key]();
+        return [key, value];
+    }));
+    return entries.reduce((acc, [key, value]) => {
+        acc[key] = value;
+        return acc;
+    }, {});
+}
+/**
+ * Resolves git-based built-in variables.
+ *
+ * - If `keys` is omitted, resolves all supported git builtins.
+ * - If `keys` is provided, resolves only those keys.
+ */
+export async function getGitBuiltins(keys) {
+    return resolveGitBuiltins(keys);
+}
+/**
+ * Returns true if the pattern contains at least one git builtin key.
+ * (Call this before `getGitBuiltins()` if you want to avoid running git at all.)
+ */
+export function patternNeedsGitBuiltins(pattern) {
+    return GIT_BUILTIN_KEYS.some((key) => pattern.includes(key));
+}
+/**
+ * Extracts which git builtin keys are present in the pattern.
+ * (Use the returned keys to resolve only what you need.)
+ */
+export function extractGitBuiltinKeysFromPattern(pattern) {
+    return GIT_BUILTIN_KEYS.filter((key) => pattern.includes(key));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "new-branch",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Generate and create standardized git branch names from a pattern.",
   "keywords": [
     "git",
@@ -26,8 +26,9 @@
     "lint": "eslint src --ext .ts"
   },
   "bin": {
-    "new-branch": "./dist/cli.js",
-    "git-nb": "./dist/cli.js"
+    "new-branch": "dist/cli.js",
+    "git-new-branch": "dist/cli.js",
+    "git-nb": "dist/cli.js"
   },
   "author": "Teles <github.com/teles>",
   "license": "MIT",