workspace-tools 0.19.0 → 0.19.3

package/lib/git.d.ts

@@ -1,8 +1,11 @@
+/// <reference types="node" />
+import { SpawnSyncOptions } from "child_process";
 declare type ProcessOutput = {
     stderr: string;
     stdout: string;
     success: boolean;
 };
+/** Observes the git operations called from `git()` or `gitFailFast()` */
 declare type GitObserver = (args: string[], output: ProcessOutput) => void;
 /**
  * Adds an observer for the git operations, e.g. for testing
@@ -10,19 +13,13 @@ declare type GitObserver = (args: string[], output: ProcessOutput) => void;
  */
 export declare function addGitObserver(observer: GitObserver): void;
 /**
- * Runs git command - use this for read only commands
+ * Runs git command - use this for read-only commands
  */
-export declare function git(args: string[], options?: {
-    cwd: string;
-    maxBuffer?: number;
-}): ProcessOutput;
+export declare function git(args: string[], options?: SpawnSyncOptions): ProcessOutput;
 /**
- * Runs git command - use this for commands that makes changes to the file system
+ * Runs git command - use this for commands that make changes to the filesystem
  */
-export declare function gitFailFast(args: string[], options?: {
-    cwd: string;
-    maxBuffer?: number;
-}): void;
+export declare function gitFailFast(args: string[], options?: SpawnSyncOptions): void;
 export declare function getUntrackedChanges(cwd: string): string[];
 export declare function fetchRemote(remote: string, cwd: string): void;
 export declare function fetchRemoteBranch(remote: string, remoteBranch: string, cwd: string): void;

package/lib/git.js

@@ -16,11 +16,11 @@ function gitError(message, e) {
     return new Error(message);
 }
 /**
- * A maxBuffer override globally for all git operations
- * Bumps up the default to 500MB as opposed to the 1MB
- * Override this value with "GIT_MAX_BUFFER" environment variable
+ * A global maxBuffer override for all git operations.
+ * Bumps up the default to 500MB instead of 1MB.
+ * Override this value with the `GIT_MAX_BUFFER` environment variable.
  */
-const MaxBufferOption = process.env.GIT_MAX_BUFFER ? parseInt(process.env.GIT_MAX_BUFFER) : 500 * 1024 * 1024;
+const defaultMaxBuffer = process.env.GIT_MAX_BUFFER ? parseInt(process.env.GIT_MAX_BUFFER) : 500 * 1024 * 1024;
 const observers = [];
 let observing;
 /**
@@ -32,25 +32,15 @@ function addGitObserver(observer) {
 }
 exports.addGitObserver = addGitObserver;
 /**
- * Runs git command - use this for read only commands
+ * Runs git command - use this for read-only commands
  */
 function git(args, options) {
-    const results = (0, child_process_1.spawnSync)("git", args, Object.assign({ maxBuffer: MaxBufferOption }, options));
-    let output;
-    if (results.status === 0) {
-        output = {
-            stderr: results.stderr.toString().trimRight(),
-            stdout: results.stdout.toString().trimRight(),
-            success: true,
-        };
-    }
-    else {
-        output = {
-            stderr: results.stderr.toString().trimRight(),
-            stdout: results.stdout.toString().trimRight(),
-            success: false,
-        };
-    }
+    const results = (0, child_process_1.spawnSync)("git", args, Object.assign({ maxBuffer: defaultMaxBuffer }, options));
+    const output = {
+        stderr: results.stderr.toString().trimRight(),
+        stdout: results.stdout.toString().trimRight(),
+        success: results.status === 0
+    };
     // notify observers, flipping the observing bit to prevent infinite loops
     if (!observing) {
         observing = true;
@@ -63,7 +53,7 @@ function git(args, options) {
 }
 exports.git = git;
 /**
- * Runs git command - use this for commands that makes changes to the file system
+ * Runs git command - use this for commands that make changes to the filesystem
  */
 function gitFailFast(args, options) {
     const gitResult = git(args, options);
@@ -85,7 +75,7 @@ function getUntrackedChanges(cwd) {
         if (changes.length == 0) {
             return [];
         }
-        const lines = changes.split(/\0/).filter((line) => line) || [];
+        const lines = changes.split(/[\r\n]+/).filter((line) => line) || [];
         const untracked = [];
         for (let i = 0; i < lines.length; i++) {
             const line = lines[i];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workspace-tools",
-  "version": "0.19.0",
+  "version": "0.19.3",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -10,6 +10,8 @@
   "types": "lib/index.d.ts",
   "scripts": {
     "build": "tsc",
+    "build:docs": "typedoc src/index.ts",
+    "release:docs": "typedoc src/index.ts && gh-pages -d docs",
     "change": "beachball change",
     "checkchange": "beachball check",
     "release": "beachball publish -y",
@@ -38,6 +40,8 @@
     "jest": "^25.0.0",
     "tmp": "^0.2.1",
     "ts-jest": "^25.5.1",
-    "typescript": "^4.5.4"
+    "typedoc": "^0.22.15",
+    "typescript": "^4.5.4",
+    "gh-pages": "^3.2.3"
   }
 }