watskeburt 0.10.2 → 0.11.0

package/README.md

@@ -25,29 +25,38 @@ but for just this simple usage they're a bit overkill.
 
 ```javascript
 // const { listSync, getSHASync } = require("watskeburt"); // in commonjs contexts you can also require it
-import { listSync, getSHASync } from "watskeburt";
+import { list, getSHA, listSync, getSHASync } from "watskeburt";
 
 // print the SHA1 of the current HEAD
+console.log(await getSHA());
 console.log(getSHASync());
 
 // list all files that differ between 'main' and the current revision (including
 // files not staged for commit and files not under revision control)
 /** @type {import('watskeburt').IChange[]} */
-const lChangedFiles = listSync("main");
+const lChangedFiles = await list("main");
+// or, with the sync interface:
+// const lChangedFiles = listSync("main");
 
 // list all files that differ between 'v0.6.1' and 'v0.7.1' (by definition
 // won't include files staged for commit and/ or not under revision control)
 /** @type {import('watskeburt').IChange[]} */
-const lChangedFiles = listSync("v0.6.1", "v0.7.1");
+const lChangedFiles = await list("v0.6.1", "v0.7.1");
+// const lChangedFiles = listSync("v0.6.1", "v0.7.1");
 
 // As a third parameter you can pass some options
 // (pass null as the second parameter if you only want to compare between
 // a revision and the working tree):
 /** @type {import('watskeburt').IChange[]|string} */
-const lChangedFiles = listSync("main", null, {
+const lChangedFiles = await list("main", null, {
   trackedOnly: false, // when set to true leaves out files not under revision control
   outputType: "object", // other options: "json" and "regex" (as used in the CLI)
 });
+// or with synchronous code:
+// const lChangedFiles = listSynd("main", null, {
+//   trackedOnly: false, // when set to true leaves out files not under revision control
+//   outputType: "object", // other options: "json" and "regex" (as used in the CLI)
+// });
 ```
 
 The array of changes this returns looks like this:

package/bin/cli.js

@@ -2,7 +2,7 @@
 /* eslint-disable no-console */
 import { EOL } from "node:os";
 import { Option, program } from "commander";
-import { listSync } from "../dist/esm/main.js";
+import { list } from "../dist/esm/main.js";
 import { VERSION } from "./version.js";
 
 program
@@ -23,7 +23,7 @@ program
   .parse(process.argv);
 
 try {
-  console.log(listSync(program.args[0], program.args[1], program.opts()));
+  console.log(await list(program.args[0], program.args[1], program.opts()));
 } catch (pError) {
   console.error(`ERROR: ${pError.message}`);
 }

package/bin/version.js

@@ -1,2 +1,2 @@
 // generated by tools/get-version.ts - edits will be overwritten
-export const VERSION = "0.10.2";
+export const VERSION = "0.11.0";

package/dist/cjs-bundle.cjs

@@ -1 +1 @@
-"use strict";var p=Object.defineProperty;var w=Object.getOwnPropertyDescriptor;var E=Object.getOwnPropertyNames;var N=Object.prototype.hasOwnProperty;var x=(t,e)=>{for(var n in e)p(t,n,{get:e[n],enumerable:!0})},A=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of E(e))!N.call(t,o)&&o!==n&&p(t,o,{get:()=>e[o],enumerable:!(r=w(e,o))||r.enumerable});return t};var _=t=>A(p({},"__esModule",{value:!0}),t);var R={};x(R,{getSHASync:()=>a,listSync:()=>P});module.exports=_(R);var u=require("os"),D=/^(?<changeType>[ACDMRTUXB])(?<similarity>[0-9]{3})?[ \t]+(?<name>[^ \t]+)[ \t]*(?<newName>[^ \t]+)?$/,L=/^(?<stagedChangeType>[ ACDMRTUXB?!])(?<unStagedChangeType>[ ACDMRTUXB?!])[ \t]+(?<name>[^ \t]+)(( -> )(?<newName>[^ \t]+))?$/,O={A:"added",C:"copied",D:"deleted",M:"modified",R:"renamed",T:"type changed",U:"unmerged",B:"pairing broken"," ":"unmodified","?":"untracked","!":"ignored"};function g(t){return O[t]??"unknown"}function j(t){let e=t.match(L),n={};if(e!=null&&e.groups){let r=g(e.groups.stagedChangeType),o=g(e.groups.unStagedChangeType);n.changeType=r==="unmodified"?o:r,e.groups.newName?(n.name=e.groups.newName,n.oldName=e.groups.name):n.name=e.groups.name}return n}function k(t){let e=t.match(D),n={};return e!=null&&e.groups&&(n.changeType=g(e.groups.changeType),e.groups.newName?(n.name=e.groups.newName,n.oldName=e.groups.name):n.name=e.groups.name),n}function T(t){return t.split(u.EOL).filter(Boolean).map(j).filter(({name:e,changeType:n})=>!!e&&!!n)}function l(t){return t.split(u.EOL).filter(Boolean).map(k).filter(({name:e,changeType:n})=>!!e&&!!n)}var s=require("child_process");function d(t){return t instanceof Buffer?t.toString("utf8"):t}function B(t){throw t.code==="ENOENT"?new Error("git executable not found"):new Error(`internal spawn error: ${t}`)}function c(t,e,n){let r=n("git",t,{cwd:process.cwd(),env:process.env});if(r.error&&B(r.error),r.status===0)return d(r.stdout);throw new Error(e[r.status??0]||`internal git error: ${r.status} (${d(r.stderr)})`)}function h(t=s.spawnSync){let e={129:`'${process.cwd()}' does not seem to be a git repository`};return c(["status","--porcelain"],e,t)}function S(t,e,n=s.spawnSync){let r={128:`revision '${t}' ${e?`(or '${e}') `:""}unknown`,129:`'${process.cwd()}' does not seem to be a git repository`};return c(e?["diff",t,e,"--name-status"]:["diff",t,"--name-status"],r,n)}function a(t=s.spawnSync){return c(["rev-parse","HEAD"],{},t).slice(0,40)}var C=require("path"),U=new Set([".cjs",".cjsx",".coffee",".csx",".cts",".js",".json",".jsx",".litcoffee",".ls",".mjs",".mts",".svelte",".ts",".tsx",".vue",".vuex"]),$=new Set(["modified","added","renamed","copied","untracked"]);function f(t,e=U,n=$){return`^(${t.filter(o=>n.has(o.changeType)).map(({name:o})=>o).filter(o=>e.has((0,C.extname)(o))).join("|")})$`}function m(t){return JSON.stringify(t,null,2)}var b=t=>t,M=new Map([["regex",f],["json",m]]);function y(t,e){return(M.get(e??"unknown")||b)(t)}function P(t,e,n){let r=t||a(),o=n||{},i=l(S(r,e));return o.trackedOnly||(i=i.concat(T(h()).filter(({changeType:I})=>I==="untracked"))),y(i,o.outputType)}0&&(module.exports={getSHASync,listSync});
+"use strict";var y=Object.defineProperty;var _=Object.getOwnPropertyDescriptor;var k=Object.getOwnPropertyNames;var M=Object.prototype.hasOwnProperty;var b=(t,e)=>{for(var n in e)y(t,n,{get:e[n],enumerable:!0})},B=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of k(e))!M.call(t,o)&&o!==n&&y(t,o,{get:()=>e[o],enumerable:!(r=_(e,o))||r.enumerable});return t};var H=t=>B(y({},"__esModule",{value:!0}),t);var K={};b(K,{getSHA:()=>m,getSHASync:()=>p,list:()=>z,listSync:()=>q});module.exports=H(K);var T=require("os"),U=/^(?<changeType>[ACDMRTUXB])(?<similarity>[0-9]{3})?[ \t]+(?<name>[^ \t]+)[ \t]*(?<newName>[^ \t]+)?$/,j=/^(?<stagedChangeType>[ ACDMRTUXB?!])(?<unStagedChangeType>[ ACDMRTUXB?!])[ \t]+(?<name>[^ \t]+)(( -> )(?<newName>[^ \t]+))?$/,R={A:"added",C:"copied",D:"deleted",M:"modified",R:"renamed",T:"type changed",U:"unmerged",B:"pairing broken"," ":"unmodified","?":"untracked","!":"ignored"};function d(t){return R[t]??"unknown"}function v(t){let e=t.match(j),n={};if(e!=null&&e.groups){let r=d(e.groups.stagedChangeType),o=d(e.groups.unStagedChangeType);n.changeType=r==="unmodified"?o:r,e.groups.newName?(n.name=e.groups.newName,n.oldName=e.groups.name):n.name=e.groups.name}return n}function F(t){let e=t.match(U),n={};return e!=null&&e.groups&&(n.changeType=d(e.groups.changeType),e.groups.newName?(n.name=e.groups.newName,n.oldName=e.groups.name):n.name=e.groups.name),n}function h(t){return t.split(T.EOL).filter(Boolean).map(v).filter(({name:e,changeType:n})=>!!e&&!!n)}function S(t){return t.split(T.EOL).filter(Boolean).map(F).filter(({name:e,changeType:n})=>!!e&&!!n)}var u=require("child_process");function N(t){return t instanceof Buffer?t.toString("utf8"):t}function G(t){throw t.code==="ENOENT"?new Error("git executable not found"):new Error(`internal spawn error: ${t}`)}function w(t,e,n){let r=n("git",t,{cwd:process.cwd(),env:process.env});if(r.error&&G(r.error),r.status===0)return N(r.stdout);throw new Error(e[r.status??0]||`internal git error: ${r.status} (${N(r.stderr)})`)}function A(t=u.spawnSync){let e={129:`'${process.cwd()}' does not seem to be a git repository`};return w(["status","--porcelain"],e,t)}function D(t,e,n=u.spawnSync){let r={128:`revision '${t}' ${e?`(or '${e}') `:""}unknown`,129:`'${process.cwd()}' does not seem to be a git repository`};return w(e?["diff",t,e,"--name-status"]:["diff",t,"--name-status"],r,n)}function p(t=u.spawnSync){return w(["rev-parse","HEAD"],{},t).slice(0,40)}var L=require("path"),X=new Set([".cjs",".cjsx",".coffee",".csx",".cts",".js",".json",".jsx",".litcoffee",".ls",".mjs",".mts",".svelte",".ts",".tsx",".vue",".vuex"]),J=new Set(["modified","added","renamed","copied","untracked"]);function C(t,e=X,n=J){return`^(${t.filter(o=>n.has(o.changeType)).map(({name:o})=>o).filter(o=>e.has((0,L.extname)(o))).join("|")})$`}function I(t){return JSON.stringify(t,null,2)}var Y=t=>t,V=new Map([["regex",C],["json",I]]);function f(t,e){return(V.get(e??"unknown")||Y)(t)}var l=require("child_process");function O(t){return t instanceof Buffer?t.toString("utf8"):t}function E(t,e,n){let r=n("git",t,{cwd:process.cwd(),env:process.env}),o="",a="";return new Promise((c,i)=>{var g,x;(g=r.stdout)==null||g.on("data",s=>{o=o.concat(s)}),(x=r.stderr)==null||x.on("data",s=>{a=a.concat(s)}),r.on("close",s=>{s===0?c(O(o)):i(new Error(e[s??0]||`internal git error: ${s} (${O(a)})`))}),r.on("error",s=>{(s==null?void 0:s.code)==="ENOENT"?i(new Error("git executable not found")):i(new Error(`internal spawn error: ${s}`))})})}async function $(t=l.spawn){let e={129:`'${process.cwd()}' does not seem to be a git repository`};return await E(["status","--porcelain"],e,t)}async function P(t,e,n=l.spawn){let r={128:`revision '${t}' ${e?`(or '${e}') `:""}unknown`,129:`'${process.cwd()}' does not seem to be a git repository`};return await E(e?["diff",t,e,"--name-status"]:["diff",t,"--name-status"],r,n)}async function m(t=l.spawn){return(await E(["rev-parse","HEAD"],{},t)).slice(0,40)}function q(t,e,n){let r=t||p(),o=n||{},a=S(D(r,e));return o.trackedOnly||(a=a.concat(h(A()).filter(({changeType:c})=>c==="untracked"))),f(a,o.outputType)}async function z(t,e,n){let r=t||await m(),o=n||{},[a,c]=await Promise.all([P(r,e),o.trackedOnly?"":$()]),i=S(a);return o.trackedOnly||(i=i.concat(h(c).filter(({changeType:g})=>g==="untracked"))),f(i,o.outputType)}0&&(module.exports={getSHA,getSHASync,list,listSync});

package/dist/esm/git-primitives-sync.js

@@ -0,0 +1,64 @@
+import { spawnSync } from "node:child_process";
+function stringifyOutStream(pError) {
+    if (pError instanceof Buffer) {
+        return pError.toString("utf8");
+    }
+    else {
+        return pError;
+    }
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function throwSpawnError(pError) {
+    if (pError.code === "ENOENT") {
+        throw new Error("git executable not found");
+    }
+    else {
+        throw new Error(`internal spawn error: ${pError}`);
+    }
+}
+/**
+ * @throws {Error}
+ */
+function getGitResultSync(pArguments, pErrorMap, pSpawnFunction) {
+    const lGitResult = pSpawnFunction("git", pArguments, {
+        cwd: process.cwd(),
+        // eslint-disable-next-line node/no-process-env
+        env: process.env,
+    });
+    if (lGitResult.error) {
+        throwSpawnError(lGitResult.error);
+    }
+    if (lGitResult.status === 0) {
+        return stringifyOutStream(lGitResult.stdout);
+    }
+    else {
+        throw new Error(pErrorMap[lGitResult.status ?? 0] ||
+            `internal git error: ${lGitResult.status} (${stringifyOutStream(lGitResult.stderr)})`);
+    }
+}
+/**
+ * @throws {Error}
+ */
+export function getStatusShortSync(pSpawnFunction = spawnSync) {
+    const lErrorMap = {
+        129: `'${process.cwd()}' does not seem to be a git repository`,
+    };
+    return getGitResultSync(["status", "--porcelain"], lErrorMap, pSpawnFunction);
+}
+/**
+ *
+ * @throws {Error}
+ */
+export function getDiffLinesSync(pOldRevision, pNewRevision, pSpawnFunction = spawnSync) {
+    const lErrorMap = {
+        128: `revision '${pOldRevision}' ${pNewRevision ? `(or '${pNewRevision}') ` : ""}unknown`,
+        129: `'${process.cwd()}' does not seem to be a git repository`,
+    };
+    return getGitResultSync(pNewRevision
+        ? ["diff", pOldRevision, pNewRevision, "--name-status"]
+        : ["diff", pOldRevision, "--name-status"], lErrorMap, pSpawnFunction);
+}
+export function getSHASync(pSpawnFunction = spawnSync) {
+    const lSha1Length = 40;
+    return getGitResultSync(["rev-parse", "HEAD"], {}, pSpawnFunction).slice(0, lSha1Length);
+}

package/dist/esm/git-primitives.js

@@ -1,64 +1,76 @@
-import { spawnSync } from "node:child_process";
-function stringifyOutStream(pError) {
-    if (pError instanceof Buffer) {
-        return pError.toString("utf8");
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { spawn } from "node:child_process";
+function stringifyOutStream(pBufferOrString) {
+    if (pBufferOrString instanceof Buffer) {
+        return pBufferOrString.toString("utf8");
     }
     else {
-        return pError;
-    }
-}
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function throwSpawnError(pError) {
-    if (pError.code === "ENOENT") {
-        throw new Error("git executable not found");
-    }
-    else {
-        throw new Error(`internal spawn error: ${pError}`);
+        return pBufferOrString;
     }
 }
 /**
  * @throws {Error}
  */
-function getGitResultSync(pArguments, pErrorMap, pSpawnFunction) {
-    const lGitResult = pSpawnFunction("git", pArguments, {
+function getGitResult(pArguments, pErrorMap, pSpawnFunction) {
+    const lGit = pSpawnFunction("git", pArguments, {
         cwd: process.cwd(),
         // eslint-disable-next-line node/no-process-env
         env: process.env,
     });
-    if (lGitResult.error) {
-        throwSpawnError(lGitResult.error);
-    }
-    if (lGitResult.status === 0) {
-        return stringifyOutStream(lGitResult.stdout);
-    }
-    else {
-        throw new Error(pErrorMap[lGitResult.status ?? 0] ||
-            `internal git error: ${lGitResult.status} (${stringifyOutStream(lGitResult.stderr)})`);
-    }
+    let lStdOutData = "";
+    let lStdErrorData = "";
+    return new Promise((pResolve, pReject) => {
+        lGit.stdout?.on("data", (pData) => {
+            lStdOutData = lStdOutData.concat(pData);
+        });
+        lGit.stderr?.on("data", (pData) => {
+            lStdErrorData = lStdErrorData.concat(pData);
+        });
+        lGit.on("close", (pCode) => {
+            if (pCode === 0) {
+                pResolve(stringifyOutStream(lStdOutData));
+            }
+            else {
+                pReject(new Error(pErrorMap[pCode ?? 0] ||
+                    `internal git error: ${pCode} (${stringifyOutStream(lStdErrorData)})`));
+            }
+        });
+        lGit.on("error", (pError) => {
+            if (pError?.code === "ENOENT") {
+                pReject(new Error("git executable not found"));
+            }
+            else {
+                pReject(new Error(`internal spawn error: ${pError}`));
+            }
+        });
+    });
 }
 /**
  * @throws {Error}
  */
-export function getStatusShortSync(pSpawnFunction = spawnSync) {
+export async function getStatusShort(pSpawnFunction = spawn) {
     const lErrorMap = {
         129: `'${process.cwd()}' does not seem to be a git repository`,
     };
-    return getGitResultSync(["status", "--porcelain"], lErrorMap, pSpawnFunction);
+    const lResult = await getGitResult(["status", "--porcelain"], lErrorMap, pSpawnFunction);
+    return lResult;
 }
 /**
  *
  * @throws {Error}
  */
-export function getDiffLinesSync(pOldRevision, pNewRevision, pSpawnFunction = spawnSync) {
+export async function getDiffLines(pOldRevision, pNewRevision, pSpawnFunction = spawn) {
     const lErrorMap = {
         128: `revision '${pOldRevision}' ${pNewRevision ? `(or '${pNewRevision}') ` : ""}unknown`,
         129: `'${process.cwd()}' does not seem to be a git repository`,
     };
-    return getGitResultSync(pNewRevision
+    const lResult = await getGitResult(pNewRevision
         ? ["diff", pOldRevision, pNewRevision, "--name-status"]
         : ["diff", pOldRevision, "--name-status"], lErrorMap, pSpawnFunction);
+    return lResult;
 }
-export function getSHASync(pSpawnFunction = spawnSync) {
+export async function getSHA(pSpawnFunction = spawn) {
     const lSha1Length = 40;
-    return getGitResultSync(["rev-parse", "HEAD"], {}, pSpawnFunction).slice(0, lSha1Length);
+    const lResult = await getGitResult(["rev-parse", "HEAD"], {}, pSpawnFunction);
+    return lResult.slice(0, lSha1Length);
 }

package/dist/esm/main.js

@@ -1,6 +1,7 @@
 import { convertDiffLines, convertStatusLines, } from "./convert-to-change-object.js";
-import { getDiffLinesSync, getSHASync, getStatusShortSync, } from "./git-primitives.js";
+import { getDiffLinesSync, getSHASync, getStatusShortSync, } from "./git-primitives-sync.js";
 import format from "./formatters/format.js";
+import { getDiffLines, getStatusShort, getSHA } from "./git-primitives.js";
 export function listSync(pOldRevision, pNewRevision, pOptions) {
     const lOldRevision = pOldRevision || getSHASync();
     const lOptions = pOptions || {};
@@ -10,4 +11,18 @@ export function listSync(pOldRevision, pNewRevision, pOptions) {
     }
     return format(lChanges, lOptions.outputType);
 }
-export { getSHASync } from "./git-primitives.js";
+export async function list(pOldRevision, pNewRevision, pOptions) {
+    const lOldRevision = pOldRevision || (await getSHA());
+    const lOptions = pOptions || {};
+    const [lDiffLines, lStatusLines] = await Promise.all([
+        getDiffLines(lOldRevision, pNewRevision),
+        lOptions.trackedOnly ? "" : getStatusShort(),
+    ]);
+    let lChanges = convertDiffLines(lDiffLines);
+    if (!lOptions.trackedOnly) {
+        lChanges = lChanges.concat(convertStatusLines(lStatusLines).filter(({ changeType }) => changeType === "untracked"));
+    }
+    return format(lChanges, lOptions.outputType);
+}
+export { getSHASync } from "./git-primitives-sync.js";
+export { getSHA } from "./git-primitives.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watskeburt",
-  "version": "0.10.2",
+  "version": "0.11.0",
   "description": "List files changed since a git revision",
   "keywords": [
     "git",
@@ -44,16 +44,16 @@
     "README.md"
   ],
   "dependencies": {
-    "commander": "10.0.0"
+    "commander": "10.0.1"
   },
   "devDependencies": {
     "@types/mocha": "10.0.1",
-    "@types/node": "18.15.11",
-    "@typescript-eslint/eslint-plugin": "5.58.0",
+    "@types/node": "18.16.2",
+    "@typescript-eslint/eslint-plugin": "5.59.1",
     "c8": "7.13.0",
-    "dependency-cruiser": "13.0.0-beta-1",
-    "esbuild": "0.17.16",
-    "eslint": "8.38.0",
+    "dependency-cruiser": "13.0.0-beta-5",
+    "esbuild": "0.17.18",
+    "eslint": "8.39.0",
     "eslint-config-moving-meadow": "4.0.2",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-budapestian": "5.0.1",
@@ -65,7 +65,7 @@
     "eslint-plugin-unicorn": "46.0.0",
     "mocha": "10.2.0",
     "npm-run-all": "4.1.5",
-    "prettier": "2.8.7",
+    "prettier": "2.8.8",
     "ts-node": "10.9.1",
     "typescript": "5.0.4",
     "upem": "7.3.2"

package/types/watskeburt.d.ts

@@ -62,9 +62,34 @@ export function listSync(
   pOptions?: IOptions
 ): IChange[] | string;
 
+/**
+ * returns a list of files changed since pOldRevision.
+ *
+ * @param pOldRevision The revision against which to compare. E.g. a commit-hash,
+ *                 a branch or a tag. When not passed defaults to the _current_
+ *                 commit hash (if there's any)
+ * @param pNewRevision Newer revision against which to compare. Leave out or pass
+ *                 null when you want to compare against the working tree
+ * @param pOptions Options that influence how the changes are returned and that
+ *                 filter what is returned and
+ * @throws {Error}
+ */
+export function list(
+  pOldRevision?: string,
+  pNewRevision?: string,
+  pOptions?: IOptions
+): Promise<IChange[] | string>;
+
 /**
  * Returns the SHA1 of the current HEAD
  *
  * @throws {Error}
  */
 export function getSHASync(): string;
+
+/**
+ * Returns the SHA1 of the current HEAD
+ *
+ * @throws {Error}
+ */
+export function getSHA(): Promise<string>;