workspace-tools 0.38.3 → 0.38.5

package/lib/getPackageInfos.d.ts

@@ -1,3 +1,17 @@
 import { PackageInfos } from "./types/PackageInfo";
+/**
+ * Read all the package.json files in a monorepo. Only works for monorepos which
+ * use a supported workspace manager.
+ * @param cwd Start looking for the workspace manager config from here
+ */
 export declare function getPackageInfos(cwd: string): PackageInfos;
+/**
+ * Read all the package.json files in a monorepo. Only works for monorepos which
+ * use a supported workspace manager.
+ *
+ * NOTE: As of writing, this will start promises to read all package.json files in parallel,
+ * without direct concurrency control.
+ *
+ * @param cwd Start looking for the workspace manager config from here
+ */
 export declare function getPackageInfosAsync(cwd: string): Promise<PackageInfos>;

package/lib/getPackageInfos.js

@@ -1,13 +1,13 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPackageInfosAsync = exports.getPackageInfos = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const infoFromPackageJson_1 = require("./infoFromPackageJson");
 const getWorkspaces_1 = require("./workspaces/getWorkspaces");
+const readPackageInfo_1 = require("./workspaces/readPackageInfo");
+/**
+ * Read all the package.json files in a monorepo. Only works for monorepos which
+ * use a supported workspace manager.
+ * @param cwd Start looking for the workspace manager config from here
+ */
 function getPackageInfos(cwd) {
     const packageInfos = {};
     const workspacePackages = (0, getWorkspaces_1.getWorkspaces)(cwd);
@@ -17,7 +17,7 @@ function getPackageInfos(cwd) {
         }
     }
     else {
-        const rootInfo = tryReadRootPackageJson(cwd);
+        const rootInfo = (0, readPackageInfo_1.readPackageInfo)(cwd);
         if (rootInfo) {
             packageInfos[rootInfo.name] = rootInfo;
         }
@@ -25,6 +25,15 @@ function getPackageInfos(cwd) {
     return packageInfos;
 }
 exports.getPackageInfos = getPackageInfos;
+/**
+ * Read all the package.json files in a monorepo. Only works for monorepos which
+ * use a supported workspace manager.
+ *
+ * NOTE: As of writing, this will start promises to read all package.json files in parallel,
+ * without direct concurrency control.
+ *
+ * @param cwd Start looking for the workspace manager config from here
+ */
 async function getPackageInfosAsync(cwd) {
     const packageInfos = {};
     const workspacePackages = await (0, getWorkspaces_1.getWorkspacesAsync)(cwd);
@@ -34,7 +43,7 @@ async function getPackageInfosAsync(cwd) {
         }
     }
     else {
-        const rootInfo = tryReadRootPackageJson(cwd);
+        const rootInfo = (0, readPackageInfo_1.readPackageInfo)(cwd);
         if (rootInfo) {
             packageInfos[rootInfo.name] = rootInfo;
         }
@@ -42,16 +51,4 @@ async function getPackageInfosAsync(cwd) {
     return packageInfos;
 }
 exports.getPackageInfosAsync = getPackageInfosAsync;
-function tryReadRootPackageJson(cwd) {
-    const packageJsonPath = path_1.default.join(cwd, "package.json");
-    if (fs_1.default.existsSync(packageJsonPath)) {
-        try {
-            const packageJson = JSON.parse(fs_1.default.readFileSync(packageJsonPath, "utf-8"));
-            return (0, infoFromPackageJson_1.infoFromPackageJson)(packageJson, packageJsonPath);
-        }
-        catch (e) {
-            throw new Error(`Invalid package.json file detected ${packageJsonPath}: ${e?.message || e}`);
-        }
-    }
-}
 //# sourceMappingURL=getPackageInfos.js.map

package/lib/getPackageInfos.js.map

@@ -1 +1 @@
-{"version":3,"file":"getPackageInfos.js","sourceRoot":"","sources":["../src/getPackageInfos.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAExB,+DAA4D;AAC5D,8DAA+E;AAE/E,SAAgB,eAAe,CAAC,GAAW;IACzC,MAAM,YAAY,GAAiB,EAAE,CAAC;IACtC,MAAM,iBAAiB,GAAG,IAAA,6BAAa,EAAC,GAAG,CAAC,CAAC;IAE7C,IAAI,iBAAiB,CAAC,MAAM,EAAE;QAC5B,KAAK,MAAM,GAAG,IAAI,iBAAiB,EAAE;YACnC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC;SAC1C;KACF;SAAM;QACL,MAAM,QAAQ,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,QAAQ,EAAE;YACZ,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;SACxC;KACF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAhBD,0CAgBC;AAEM,KAAK,UAAU,oBAAoB,CAAC,GAAW;IACpD,MAAM,YAAY,GAAiB,EAAE,CAAC;IACtC,MAAM,iBAAiB,GAAG,MAAM,IAAA,kCAAkB,EAAC,GAAG,CAAC,CAAC;IAExD,IAAI,iBAAiB,CAAC,MAAM,EAAE;QAC5B,KAAK,MAAM,GAAG,IAAI,iBAAiB,EAAE;YACnC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC;SAC1C;KACF;SAAM;QACL,MAAM,QAAQ,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,QAAQ,EAAE;YACZ,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;SACxC;KACF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAhBD,oDAgBC;AAED,SAAS,sBAAsB,CAAC,GAAW;IACzC,MAAM,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IACvD,IAAI,YAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE;QAClC,IAAI;YACF,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;YAC1E,OAAO,IAAA,yCAAmB,EAAC,WAAW,EAAE,eAAe,CAAC,CAAC;SAC1D;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,sCAAsC,eAAe,KAAM,CAAW,EAAE,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC;SACzG;KACF;AACH,CAAC"}
+{"version":3,"file":"getPackageInfos.js","sourceRoot":"","sources":["../src/getPackageInfos.ts"],"names":[],"mappings":";;;AACA,8DAA+E;AAC/E,kEAA+D;AAE/D;;;;GAIG;AACH,SAAgB,eAAe,CAAC,GAAW;IACzC,MAAM,YAAY,GAAiB,EAAE,CAAC;IACtC,MAAM,iBAAiB,GAAG,IAAA,6BAAa,EAAC,GAAG,CAAC,CAAC;IAE7C,IAAI,iBAAiB,CAAC,MAAM,EAAE;QAC5B,KAAK,MAAM,GAAG,IAAI,iBAAiB,EAAE;YACnC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC;SAC1C;KACF;SAAM;QACL,MAAM,QAAQ,GAAG,IAAA,iCAAe,EAAC,GAAG,CAAC,CAAC;QACtC,IAAI,QAAQ,EAAE;YACZ,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;SACxC;KACF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAhBD,0CAgBC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,oBAAoB,CAAC,GAAW;IACpD,MAAM,YAAY,GAAiB,EAAE,CAAC;IACtC,MAAM,iBAAiB,GAAG,MAAM,IAAA,kCAAkB,EAAC,GAAG,CAAC,CAAC;IAExD,IAAI,iBAAiB,CAAC,MAAM,EAAE;QAC5B,KAAK,MAAM,GAAG,IAAI,iBAAiB,EAAE;YACnC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC;SAC1C;KACF;SAAM;QACL,MAAM,QAAQ,GAAG,IAAA,iCAAe,EAAC,GAAG,CAAC,CAAC;QACtC,IAAI,QAAQ,EAAE;YACZ,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;SACxC;KACF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAhBD,oDAgBC"}

package/lib/getPackagePaths.d.ts

@@ -1,10 +1,10 @@
 /**
  * Given package folder globs (such as those from package.json `workspaces`) and a workspace root
- * directory, get paths to actual package folders.
+ * directory, get absolute paths to actual package folders.
  */
 export declare function getPackagePaths(root: string, packageGlobs: string[]): string[];
 /**
  * Given package folder globs (such as those from package.json `workspaces`) and a workspace root
- * directory, get paths to actual package folders.
+ * directory, get absolute paths to actual package folders.
  */
 export declare function getPackagePathsAsync(root: string, packageGlobs: string[]): Promise<string[]>;

package/lib/getPackagePaths.js

@@ -15,7 +15,7 @@ const globOptions = {
 };
 /**
  * Given package folder globs (such as those from package.json `workspaces`) and a workspace root
- * directory, get paths to actual package folders.
+ * directory, get absolute paths to actual package folders.
  */
 function getPackagePaths(root, packageGlobs) {
     if ((0, isCachingEnabled_1.isCachingEnabled)() && packagePathsCache[root]) {
@@ -29,7 +29,7 @@ function getPackagePaths(root, packageGlobs) {
 exports.getPackagePaths = getPackagePaths;
 /**
  * Given package folder globs (such as those from package.json `workspaces`) and a workspace root
- * directory, get paths to actual package folders.
+ * directory, get absolute paths to actual package folders.
  */
 async function getPackagePathsAsync(root, packageGlobs) {
     if ((0, isCachingEnabled_1.isCachingEnabled)() && packagePathsCache[root]) {

package/lib/git/getRepositoryName.js

@@ -26,11 +26,11 @@ function getRepositoryName(url) {
         // https://dev.azure.com/foo/bar/_git/_optimized/some-repo
         // https://user@dev.azure.com/foo/bar/_git/some-repo
         // git@ssh.dev.azure.com:v3/foo/bar/some-repo
-        let fixedUrl = url.replace("/_optimized/", "/").replace("/DefaultCollection/", "/");
-        const parsedUrl = (0, git_url_parse_1.default)(fixedUrl);
-        const isVSO = fixedUrl.includes(".visualstudio.com");
-        const isADO = fixedUrl.includes("dev.azure.com");
-        if (!isVSO && !isADO) {
+        const parsedUrl = (0, git_url_parse_1.default)(url.replace("/_optimized/", "/").replace("/DefaultCollection/", "/"));
+        // `host` is set in `parse-url` but not documented... https://github.com/IonicaBizau/parse-url/blob/c830d48647f33c054745a916cf7c4c58722f4b25/src/index.js#L28
+        const host = parsedUrl.host || "";
+        const isVSO = host.endsWith(".visualstudio.com");
+        if (!isVSO && host !== "dev.azure.com" && host !== "ssh.dev.azure.com") {
             return parsedUrl.full_name;
         }
         // As of writing, ADO and VSO SSH URLs are parsed completely wrong
@@ -43,7 +43,7 @@ function getRepositoryName(url) {
         let organization = parsedUrl.organization;
         if (!organization && isVSO) {
             // organization is missing or wrong for VSO
-            organization = parsedUrl.resource.match(/([^.@]+)\.visualstudio\.com/)?.[1];
+            organization = host.match(/([^.@]+)\.visualstudio\.com$/)?.[1];
         }
         return `${organization}/${parsedUrl.owner}/${parsedUrl.name}`;
     }

package/lib/git/getRepositoryName.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRepositoryName.js","sourceRoot":"","sources":["../../src/git/getRepositoryName.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAwC;AAExC;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAAC,GAAW;IAC3C,IAAI;QACF,4FAA4F;QAC5F,sFAAsF;QACtF,kDAAkD;QAClD,oEAAoE;QACpE,+EAA+E;QAC/E,+EAA+E;QAC/E,mDAAmD;QACnD,+CAA+C;QAC/C,0DAA0D;QAC1D,oDAAoD;QACpD,6CAA6C;QAC7C,IAAI,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;QACpF,MAAM,SAAS,GAAG,IAAA,uBAAW,EAAC,QAAQ,CAAC,CAAC;QAExC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QACrD,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE;YACpB,OAAO,SAAS,CAAC,SAAS,CAAC;SAC5B;QAED,kEAAkE;QAClE,MAAM,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CACxC,yEAAyE,CAC1E,CAAC;QACF,IAAI,QAAQ,EAAE;YACZ,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;SAC1D;QAED,oFAAoF;QACpF,8CAA8C;QAC9C,IAAI,YAAY,GAAuB,SAAS,CAAC,YAAY,CAAC;QAC9D,IAAI,CAAC,YAAY,IAAI,KAAK,EAAE;YAC1B,2CAA2C;YAC3C,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,6BAA6B,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;SAC7E;QACD,OAAO,GAAG,YAAY,IAAI,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;KAC/D;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,EAAE,CAAC;KACX;AACH,CAAC;AAzCD,8CAyCC"}
+{"version":3,"file":"getRepositoryName.js","sourceRoot":"","sources":["../../src/git/getRepositoryName.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAwC;AAExC;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAAC,GAAW;IAC3C,IAAI;QACF,4FAA4F;QAC5F,sFAAsF;QACtF,kDAAkD;QAClD,oEAAoE;QACpE,+EAA+E;QAC/E,+EAA+E;QAC/E,mDAAmD;QACnD,+CAA+C;QAC/C,0DAA0D;QAC1D,oDAAoD;QACpD,6CAA6C;QAC7C,MAAM,SAAS,GAAG,IAAA,uBAAW,EAAC,GAAG,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC,CAAC;QAEpG,6JAA6J;QAC7J,MAAM,IAAI,GAAY,SAAiB,CAAC,IAAI,IAAI,EAAE,CAAC;QACnD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,IAAI,IAAI,KAAK,eAAe,IAAI,IAAI,KAAK,mBAAmB,EAAE;YACtE,OAAO,SAAS,CAAC,SAAS,CAAC;SAC5B;QAED,kEAAkE;QAClE,MAAM,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CACxC,yEAAyE,CAC1E,CAAC;QACF,IAAI,QAAQ,EAAE;YACZ,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;SAC1D;QAED,oFAAoF;QACpF,8CAA8C;QAC9C,IAAI,YAAY,GAAuB,SAAS,CAAC,YAAY,CAAC;QAC9D,IAAI,CAAC,YAAY,IAAI,KAAK,EAAE;YAC1B,2CAA2C;YAC3C,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;SAChE;QACD,OAAO,GAAG,YAAY,IAAI,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;KAC/D;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,EAAE,CAAC;KACX;AACH,CAAC;AAzCD,8CAyCC"}

package/lib/git/git.d.ts

@@ -22,11 +22,19 @@ export declare function addGitObserver(observer: GitObserver): () => void;
 /** Clear all git observers */
 export declare function clearGitObservers(): void;
 /**
- * Runs git command - use this for read-only commands
+ * Runs git command - use this for read-only commands.
+ * `gitFailFast` is recommended for commands that make changes to the filesystem.
+ *
+ * The caller is responsible for validating the input.
+ * `shell` will always be set to false.
  */
 export declare function git(args: string[], options?: SpawnSyncOptions): GitProcessOutput;
 /**
- * Runs git command - use this for commands that make changes to the filesystem
+ * Runs git command and throws an error if it fails.
+ * Use this for commands that make changes to the filesystem.
+ *
+ * The caller is responsible for validating the input.
+ * `shell` will always be set to false.
  */
 export declare function gitFailFast(args: string[], options?: SpawnSyncOptions & {
     noExitCode?: boolean;

package/lib/git/git.js

@@ -48,11 +48,19 @@ function removeGitObserver(observer) {
     }
 }
 /**
- * Runs git command - use this for read-only commands
+ * Runs git command - use this for read-only commands.
+ * `gitFailFast` is recommended for commands that make changes to the filesystem.
+ *
+ * The caller is responsible for validating the input.
+ * `shell` will always be set to false.
  */
 function git(args, options) {
     isDebug && console.log(`git ${args.join(" ")}`);
-    const results = (0, child_process_1.spawnSync)("git", args, { maxBuffer: defaultMaxBuffer, ...options });
+    if (args.some((arg) => arg.startsWith("--upload-pack"))) {
+        // This is a security issue and not needed for any expected usage of this library.
+        throw new GitError("git command contains --upload-pack, which is not allowed: " + args.join(" "));
+    }
+    const results = (0, child_process_1.spawnSync)("git", args, { maxBuffer: defaultMaxBuffer, ...options, shell: false });
     const output = {
         ...results,
         // these may be undefined if stdio: inherit is set
@@ -77,7 +85,11 @@ function git(args, options) {
 }
 exports.git = git;
 /**
- * Runs git command - use this for commands that make changes to the filesystem
+ * Runs git command and throws an error if it fails.
+ * Use this for commands that make changes to the filesystem.
+ *
+ * The caller is responsible for validating the input.
+ * `shell` will always be set to false.
  */
 function gitFailFast(args, options) {
     const gitResult = git(args, options);

package/lib/git/git.js.map

@@ -1 +1 @@
-{"version":3,"file":"git.js","sourceRoot":"","sources":["../../src/git/git.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,qBAAqB;AACrB,EAAE;;;AAGF,iDAA4D;AAE5D,MAAa,QAAS,SAAQ,KAAK;IAEjC,YAAY,OAAe,EAAE,aAAuB;QAClD,IAAI,aAAa,YAAY,KAAK,EAAE;YAClC,KAAK,CAAC,GAAG,OAAO,KAAK,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC;SAC/C;aAAM;YACL,KAAK,CAAC,OAAO,CAAC,CAAC;SAChB;QACD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;CACF;AAVD,4BAUC;AAED;;;;GAIG;AACH,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;AAE/G,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;AAUxC,MAAM,SAAS,GAAkB,EAAE,CAAC;AACpC,IAAI,SAAkB,CAAC;AAEvB;;;GAGG;AACH,SAAgB,cAAc,CAAC,QAAqB;IAClD,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,OAAO,GAAG,EAAE,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAC3C,CAAC;AAHD,wCAGC;AAED,8BAA8B;AAC9B,SAAgB,iBAAiB;IAC/B,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC;AAFD,8CAEC;AAED,4BAA4B;AAC5B,SAAS,iBAAiB,CAAC,QAAqB;IAC9C,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1C,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE;QACd,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;KAC5B;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,GAAG,CAAC,IAAc,EAAE,OAA0B;IAC5D,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,gBAAgB,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAEpF,MAAM,MAAM,GAAqB;QAC/B,GAAG,OAAO;QACV,kDAAkD;QAClD,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE;QACnD,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE;QACnD,OAAO,EAAE,OAAO,CAAC,MAAM,KAAK,CAAC;KAC9B,CAAC;IAEF,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,GAAG,CAAC,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;KAC/D;IAED,yEAAyE;IACzE,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,IAAI,CAAC;QACjB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;YAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;SACxB;QACD,SAAS,GAAG,KAAK,CAAC;KACnB;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AA5BD,kBA4BC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,IAAc,EAAE,OAAqD;IAC/F,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACrC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;QACtB,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE;YACxB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;SACtB;QAED,MAAM,IAAI,QAAQ,CAAC,4CAA4C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;MAC3E,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE;MACtC,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;KAC7C;AACH,CAAC;AAXD,kCAWC"}
+{"version":3,"file":"git.js","sourceRoot":"","sources":["../../src/git/git.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,qBAAqB;AACrB,EAAE;;;AAGF,iDAA4D;AAE5D,MAAa,QAAS,SAAQ,KAAK;IAEjC,YAAY,OAAe,EAAE,aAAuB;QAClD,IAAI,aAAa,YAAY,KAAK,EAAE;YAClC,KAAK,CAAC,GAAG,OAAO,KAAK,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC;SAC/C;aAAM;YACL,KAAK,CAAC,OAAO,CAAC,CAAC;SAChB;QACD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;CACF;AAVD,4BAUC;AAED;;;;GAIG;AACH,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;AAE/G,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;AAUxC,MAAM,SAAS,GAAkB,EAAE,CAAC;AACpC,IAAI,SAAkB,CAAC;AAEvB;;;GAGG;AACH,SAAgB,cAAc,CAAC,QAAqB;IAClD,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,OAAO,GAAG,EAAE,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAC3C,CAAC;AAHD,wCAGC;AAED,8BAA8B;AAC9B,SAAgB,iBAAiB;IAC/B,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC;AAFD,8CAEC;AAED,4BAA4B;AAC5B,SAAS,iBAAiB,CAAC,QAAqB;IAC9C,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1C,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE;QACd,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;KAC5B;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,GAAG,CAAC,IAAc,EAAE,OAA0B;IAC5D,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChD,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,EAAE;QACvD,kFAAkF;QAClF,MAAM,IAAI,QAAQ,CAAC,4DAA4D,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;KACnG;IAED,MAAM,OAAO,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,gBAAgB,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAElG,MAAM,MAAM,GAAqB;QAC/B,GAAG,OAAO;QACV,kDAAkD;QAClD,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE;QACnD,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE;QACnD,OAAO,EAAE,OAAO,CAAC,MAAM,KAAK,CAAC;KAC9B,CAAC;IAEF,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,GAAG,CAAC,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;KAC/D;IAED,yEAAyE;IACzE,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,IAAI,CAAC;QACjB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;YAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;SACxB;QACD,SAAS,GAAG,KAAK,CAAC;KACnB;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAjCD,kBAiCC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,IAAc,EAAE,OAAqD;IAC/F,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACrC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;QACtB,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE;YACxB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;SACtB;QAED,MAAM,IAAI,QAAQ,CAAC,4CAA4C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;MAC3E,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE;MACtC,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;KAC7C;AACH,CAAC;AAXD,kCAWC"}

package/lib/git/gitUtilities.d.ts

@@ -1,41 +1,170 @@
+/**
+ * Get a list of files with untracked changes.
+ * Throws an error on failure.
+ *
+ * @returns An array of file paths with untracked changes
+ */
 export declare function getUntrackedChanges(cwd: string): string[];
+/**
+ * Fetch from the given remote.
+ * Throws an error on failure.
+ */
 export declare function fetchRemote(remote: string, cwd: string): void;
+/**
+ * Fetch from the given remote and branch.
+ * Throws an error on failure.
+ */
 export declare function fetchRemoteBranch(remote: string, remoteBranch: string, cwd: string): void;
 /**
- * Gets all the changes that have not been staged yet
- * @param cwd
+ * Gets file paths with changes that have not been staged yet.
+ * Throws an error on failure.
+ *
+ * @returns An array of relative file paths with unstaged changes
  */
 export declare function getUnstagedChanges(cwd: string): string[];
+/**
+ * Gets file paths with changes between the current branch and the given branch.
+ * Throws an error on failure.
+ *
+ * @returns An array of relative file paths that have changed
+ */
 export declare function getChanges(branch: string, cwd: string): string[];
 /**
- * Gets all the changes between the branch and the merge-base
+ * Gets file paths with changes between the branch and the merge-base.
+ *
+ * @returns An array of relative file paths that have changed
  */
 export declare function getBranchChanges(branch: string, cwd: string): string[];
+/**
+ * Gets file paths with changes between two git references (commits, branches, tags).
+ * Throws an error on failure.
+ *
+ * @param fromRef - The starting reference
+ * @param toRef - The ending reference
+ * @param options - Additional git diff options
+ * @param pattern - Optional file pattern to filter results
+ * @param cwd - The working directory
+ * @returns An array of file paths that have changed
+ */
 export declare function getChangesBetweenRefs(fromRef: string, toRef: string, options: string[], pattern: string, cwd: string): string[];
+/**
+ * Gets all files with staged changes (files added to the index).
+ * Throws an error on failure.
+ *
+ * @returns An array of relative file paths that have been staged
+ */
 export declare function getStagedChanges(cwd: string): string[];
+/**
+ * Gets recent commit messages between the specified branch and HEAD.
+ * Returns an empty array if the operation fails.
+ *
+ * @returns An array of commit message strings
+ */
 export declare function getRecentCommitMessages(branch: string, cwd: string): string[];
+/**
+ * Gets the user email from the git config.
+ * @returns The email string if found, null otherwise
+ */
 export declare function getUserEmail(cwd: string): string | null;
+/**
+ * Gets the current branch name.
+ * @returns The branch name if successful, null otherwise
+ */
 export declare function getBranchName(cwd: string): string | null;
+/**
+ * Gets the full reference path for a given branch.
+ * @param branch - The short branch name (e.g., `branch-name`)
+ * @returns The full branch reference (e.g., `refs/heads/branch-name`) if found, null otherwise
+ */
 export declare function getFullBranchRef(branch: string, cwd: string): string | null;
+/**
+ * Gets the short branch name from a full branch reference.
+ * Note this may not work properly for the current branch.
+ * @param fullBranchRef - The full branch reference (e.g., `refs/heads/branch-name`)
+ * @returns The short branch name if successful, null otherwise
+ */
 export declare function getShortBranchName(fullBranchRef: string, cwd: string): string | null;
+/**
+ * Gets the current commit hash (SHA).
+ * @returns The hash if successful, null otherwise
+ */
 export declare function getCurrentHash(cwd: string): string | null;
 /**
  * Get the commit hash in which the file was first added.
+ * @returns The commit hash if found, undefined otherwise
  */
 export declare function getFileAddedHash(filename: string, cwd: string): string | undefined;
+/**
+ * Initializes a git repository in the specified directory.
+ * Optionally sets user email and username if not already configured.
+ * Throws an error if required email or username is not provided and not already configured.
+ *
+ * @param cwd - The directory to initialize the git repository in
+ * @param email - Optional email to set in git config
+ * @param username - Optional username to set in git config
+ */
 export declare function init(cwd: string, email?: string, username?: string): void;
+/**
+ * Stages files matching the given patterns.
+ */
 export declare function stage(patterns: string[], cwd: string): void;
+/**
+ * Creates a commit with the given message and optional git commit options.
+ * Throws an error on failure.
+ *
+ * @param message - The commit message
+ * @param cwd - The working directory
+ * @param options - Additional git commit options
+ */
 export declare function commit(message: string, cwd: string, options?: string[]): void;
+/**
+ * Stages files matching the given patterns and creates a commit with the specified message.
+ * Convenience function that combines `stage()` and `commit()`.
+ * Throws an error on commit failure.
+ *
+ * @param patterns - File patterns to stage
+ * @param message - The commit message
+ * @param cwd - The working directory
+ * @param commitOptions - Additional git commit options
+ */
 export declare function stageAndCommit(patterns: string[], message: string, cwd: string, commitOptions?: string[]): void;
+/**
+ * Reverts all local changes (both staged and unstaged) by stashing them and then dropping the stash.
+ * @returns True if the revert was successful, false otherwise
+ */
 export declare function revertLocalChanges(cwd: string): boolean;
+/**
+ * Attempts to determine the parent branch of the current branch using `git show-branch`.
+ *
+ * @returns The parent branch name if found, null otherwise
+ */
 export declare function getParentBranch(cwd: string): string | null;
+/**
+ * Gets the remote tracking branch for the specified branch.
+ *
+ * @returns The remote branch name (e.g., `origin/main`) if found, null otherwise
+ */
 export declare function getRemoteBranch(branch: string, cwd: string): string | null;
+/**
+ * Parses a remote branch string (e.g., `origin/main`) into its components.
+ *
+ * @param branch - The remote branch string to parse (e.g., `origin/main`)
+ */
 export declare function parseRemoteBranch(branch: string): {
+    /** Remote name, e.g. `origin` */
     remote: string;
+    /** Remote branch name, e.g. `main` */
     remoteBranch: string;
 };
 /**
  * Gets the default branch based on `git config init.defaultBranch`, falling back to `master`.
  */
 export declare function getDefaultBranch(cwd: string): string;
+/**
+ * Lists all tracked files matching the given patterns.
+ *
+ * @param patterns - File patterns to match (passed to git ls-files)
+ * @param cwd - The working directory
+ * @returns An array of file paths, or an empty array if no files are found
+ */
 export declare function listAllTrackedFiles(patterns: string[], cwd: string): string[];