@pnpm/network.git-utils 1100.0.0 → 1100.0.2

package/README.md

@@ -1,15 +1,15 @@
-# @pnpm/git-utils
+# @pnpm/network.git-utils
 
 > Utilities for git
 
 <!--@shields('npm')-->
-[![npm version](https://img.shields.io/npm/v/@pnpm/git-utils.svg)](https://www.npmjs.com/package/@pnpm/git-utils)
+[![npm version](https://img.shields.io/npm/v/@pnpm/network.git-utils.svg)](https://npmx.dev/package/@pnpm/network.git-utils)
 <!--/@-->
 
 ## Installation
 
 ```
-pnpm add @pnpm/git-utils
+pnpm add @pnpm/network.git-utils
 ```
 
 ## Usage

package/lib/index.d.ts

@@ -1,4 +1,7 @@
-export declare function isGitRepo(): Promise<boolean>;
-export declare function getCurrentBranch(): Promise<string | null>;
-export declare function isWorkingTreeClean(): Promise<boolean>;
-export declare function isRemoteHistoryClean(): Promise<boolean>;
+export interface GitCwdOptions {
+    cwd?: string;
+}
+export declare function isGitRepo(opts?: GitCwdOptions): Promise<boolean>;
+export declare function getCurrentBranch(opts?: GitCwdOptions): Promise<string | null>;
+export declare function isWorkingTreeClean(opts?: GitCwdOptions): Promise<boolean>;
+export declare function isRemoteHistoryClean(opts?: GitCwdOptions): Promise<boolean>;

package/lib/index.js

@@ -1,17 +1,21 @@
+import fs from 'node:fs';
+import path from 'node:path';
 import { safeExeca as execa } from 'execa';
-// git checks logic is from https://github.com/sindresorhus/np/blob/master/source/git-tasks.js
-export async function isGitRepo() {
+export async function isGitRepo(opts = {}) {
     try {
-        await execa('git', ['rev-parse', '--git-dir']);
+        await execa('git', ['rev-parse', '--git-dir'], { cwd: opts.cwd });
     }
     catch {
         return false;
     }
     return true;
 }
-export async function getCurrentBranch() {
+export async function getCurrentBranch(opts = {}) {
+    const branch = readBranchFromHeadFile(opts.cwd);
+    if (branch !== undefined)
+        return branch;
     try {
-        const { stdout } = await execa('git', ['symbolic-ref', '--short', 'HEAD']);
+        const { stdout } = await execa('git', ['symbolic-ref', '--short', 'HEAD'], { cwd: opts.cwd });
         return stdout;
     }
     catch {
@@ -19,9 +23,9 @@ export async function getCurrentBranch() {
         return null;
     }
 }
-export async function isWorkingTreeClean() {
+export async function isWorkingTreeClean(opts = {}) {
     try {
-        const { stdout: status } = await execa('git', ['status', '--porcelain']);
+        const { stdout: status } = await execa('git', ['status', '--porcelain'], { cwd: opts.cwd });
         if (status !== '') {
             return false;
         }
@@ -31,10 +35,10 @@ export async function isWorkingTreeClean() {
         return false;
     }
 }
-export async function isRemoteHistoryClean() {
+export async function isRemoteHistoryClean(opts = {}) {
     let history;
     try { // Gracefully handle no remote set up.
-        const { stdout } = await execa('git', ['rev-list', '--count', '--left-only', '@{u}...HEAD']);
+        const { stdout } = await execa('git', ['rev-list', '--count', '--left-only', '@{u}...HEAD'], { cwd: opts.cwd });
         history = stdout;
     }
     catch {
@@ -45,4 +49,51 @@ export async function isRemoteHistoryClean() {
     }
     return true;
 }
+/**
+ * Reads the current branch name from `.git/HEAD` without spawning a git subprocess.
+ *
+ * Returns:
+ * - `string` — the branch name extracted from `ref: refs/heads/<name>`
+ * - `null` — HEAD is detached (a raw commit SHA, not a symbolic ref)
+ * - `undefined` — `.git/HEAD` could not be read (not a git repo, worktree
+ *   layout not recognized, permissions error, etc.); caller should fall
+ *   back to `git symbolic-ref`.
+ */
+function readBranchFromHeadFile(cwd) {
+    const baseDir = cwd ?? process.cwd();
+    const dotGitPath = path.join(baseDir, '.git');
+    let gitDir;
+    try {
+        const stat = fs.statSync(dotGitPath);
+        if (stat.isDirectory()) {
+            gitDir = dotGitPath;
+        }
+        else if (stat.isFile()) {
+            // `.git` is a file — worktree or submodule. It contains `gitdir: <path>`.
+            const content = fs.readFileSync(dotGitPath, 'utf8').trim();
+            const match = content.match(/^gitdir:\s*(.+)/);
+            if (!match)
+                return undefined;
+            gitDir = path.isAbsolute(match[1]) ? match[1] : path.resolve(baseDir, match[1]);
+        }
+        else {
+            // `.git` is neither a directory nor a regular file (e.g. a FIFO or
+            // device); don't read it. Fall back to `git symbolic-ref`.
+            return undefined;
+        }
+    }
+    catch {
+        return undefined;
+    }
+    try {
+        const head = fs.readFileSync(path.join(gitDir, 'HEAD'), 'utf8').trim();
+        const match = head.match(/^ref:\s*refs\/heads\/(.+)/);
+        if (match)
+            return match[1];
+        return null;
+    }
+    catch {
+        return undefined;
+    }
+}
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/network.git-utils",
-  "version": "1100.0.0",
+  "version": "1100.0.2",
   "description": "Utilities for git",
   "keywords": [
     "pnpm",
@@ -10,7 +10,10 @@
   ],
   "license": "MIT",
   "funding": "https://opencollective.com/pnpm",
-  "repository": "https://github.com/pnpm/pnpm/tree/main/network/git-utils",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pnpm/pnpm/tree/main/network/git-utils"
+  },
   "homepage": "https://github.com/pnpm/pnpm/tree/main/network/git-utils#readme",
   "bugs": {
     "url": "https://github.com/pnpm/pnpm/issues"
@@ -29,8 +32,9 @@
     "execa": "npm:safe-execa@0.3.0"
   },
   "devDependencies": {
+    "@jest/globals": "30.4.1",
     "tempy": "3.0.0",
-    "@pnpm/network.git-utils": "1100.0.0"
+    "@pnpm/network.git-utils": "1100.0.2"
   },
   "engines": {
     "node": ">=22.13"