watskeburt 0.11.2 → 0.11.4

package/README.md

@@ -98,17 +98,17 @@ The JSON output (which looks a lot like the array above) is unfiltered and
 also contains other extensions.
 
 ```
-Usage: cli [options] [revision]
+Usage: watskeburt [options] [old-revision] [new-revision]
 
-lists files & their statuses since [revision].
+lists files & their statuses since [old-revision] or between [old-revision] and [new-revision].
 
--> When you don't pass a revision the revision defaults to the current one.
+-> When you don't pass a revision at all old-revision defaults to the current one.
 
 Options:
-  -V, --version             output the version number
-  -T, --output-type <type>  json,regex (default: "regex")
-  --tracked-only            only take tracked files into account (default: false)
-  -h, --help                display help for command
+  -T, --outputType <type>  what format to emit (choices: "json", "regex", default: "regex")
+  --trackedOnly            only take tracked files into account (default: false)
+  -V, --version            output the version number
+  -h, --help               display help for command
 ```
 
 ## 🇳🇱 what does 'watskeburt' mean?

package/bin/cli.js

@@ -1,29 +1,5 @@
 #!/usr/bin/env node
-/* eslint-disable no-console */
-import { EOL } from "node:os";
-import { Option, program } from "commander";
-import { list } from "../dist/esm/main.js";
-import { VERSION } from "./version.js";
 
-program
-  .description(
-    "lists files & their statuses since [old-revision] " +
-      "or between [old-revision] and [new-revision]." +
-      `${EOL}${EOL}` +
-      "-> When you don't pass a revision at all old-revision defaults to the current one."
-  )
-  .addOption(
-    new Option("-T, --output-type <type>", "what format to emit")
-      .choices(["json", "regex"])
-      .default("regex")
-  )
-  .option("--tracked-only", "only take tracked files into account", false)
-  .arguments("[old-revision] [new-revision]")
-  .version(VERSION)
-  .parse(process.argv);
+import { cli } from "../dist/esm/cli.js";
 
-try {
-  console.log(await list(program.args[0], program.args[1], program.opts()));
-} catch (pError) {
-  console.error(`ERROR: ${pError.message}`);
-}
+await cli();

package/dist/cjs-bundle.cjs

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

package/dist/esm/cli.js

@@ -0,0 +1,63 @@
+import { EOL } from "node:os";
+import { parseArgs } from "node:util";
+import { list } from "./main.js";
+import { VERSION } from "./version.js";
+const HELP_MESSAGE = `Usage: watskeburt [options] [old-revision] [new-revision]
+
+lists files & their statuses since [old-revision] or between [old-revision] and [new-revision].
+
+-> When you don't pass a revision at all old-revision defaults to the current one.
+
+Options:
+  -T, --outputType <type>  what format to emit (choices: "json", "regex", default: "regex")
+  --trackedOnly            only take tracked files into account (default: false)
+  -V, --version            output the version number
+  -h, --help               display help for command${EOL}`;
+export async function cli(pArguments = process.argv.slice(2), pOutStream = process.stdout, pErrorStream = process.stderr) {
+    try {
+        const lArguments = getArguments(pArguments);
+        if (lArguments.values.help) {
+            pOutStream.write(HELP_MESSAGE);
+            return;
+        }
+        if (lArguments.values.version) {
+            pOutStream.write(`${VERSION}${EOL}`);
+            return;
+        }
+        if (!outputTypeIsValid(lArguments.values.outputType)) {
+            pErrorStream.write(`error: option '-T, --outputType <type>' argument '${lArguments.values.outputType}' is invalid. Allowed choices are json, regex.${EOL}`);
+            process.exitCode = 1;
+            return;
+        }
+        const lResult = await list(lArguments.positionals[0], lArguments.positionals[1], lArguments.values);
+        pOutStream.write(`${lResult}${EOL}`);
+    }
+    catch (pError) {
+        pErrorStream.write(`${EOL}ERROR: ${pError.message}${EOL}${EOL}`);
+        process.exitCode = 1;
+    }
+}
+function getArguments(pArguments) {
+    return parseArgs({
+        args: pArguments,
+        options: {
+            outputType: {
+                type: "string",
+                short: "T",
+                default: "regex",
+            },
+            trackedOnly: {
+                type: "boolean",
+                default: false,
+            },
+            help: { type: "boolean", short: "h", default: false },
+            version: { type: "boolean", short: "V", default: false },
+        },
+        strict: true,
+        allowPositionals: true,
+        tokens: false,
+    });
+}
+function outputTypeIsValid(pOutputType) {
+    return ["json", "regex"].includes(pOutputType);
+}

package/dist/esm/convert-to-change-object.js

@@ -14,8 +14,12 @@ const CHANGE_CHAR_2_CHANGE_TYPE = {
     "?": "untracked",
     "!": "ignored",
 };
-function changeChar2ChangeType(pChar) {
-    return CHANGE_CHAR_2_CHANGE_TYPE[pChar] ?? "unknown";
+export function convertStatusLines(pString) {
+    return pString
+        .split(EOL)
+        .filter(Boolean)
+        .map(convertStatusLine)
+        .filter(({ name, changeType }) => Boolean(name) && Boolean(changeType));
 }
 export function convertStatusLine(pString) {
     const lMatchResult = pString.match(DIFF_SHORT_STATUS_LINE_PATTERN);
@@ -37,6 +41,13 @@ export function convertStatusLine(pString) {
     }
     return lReturnValue;
 }
+export function convertDiffLines(pString) {
+    return pString
+        .split(EOL)
+        .filter(Boolean)
+        .map(convertDiffLine)
+        .filter(({ name, changeType }) => Boolean(name) && Boolean(changeType));
+}
 export function convertDiffLine(pString) {
     const lMatchResult = pString.match(DIFF_NAME_STATUS_LINE_PATTERN);
     const lReturnValue = {};
@@ -52,17 +63,6 @@ export function convertDiffLine(pString) {
     }
     return lReturnValue;
 }
-export function convertStatusLines(pString) {
-    return pString
-        .split(EOL)
-        .filter(Boolean)
-        .map(convertStatusLine)
-        .filter(({ name, changeType }) => Boolean(name) && Boolean(changeType));
-}
-export function convertDiffLines(pString) {
-    return pString
-        .split(EOL)
-        .filter(Boolean)
-        .map(convertDiffLine)
-        .filter(({ name, changeType }) => Boolean(name) && Boolean(changeType));
+function changeChar2ChangeType(pChar) {
+    return CHANGE_CHAR_2_CHANGE_TYPE[pChar] ?? "unknown";
 }

package/dist/esm/formatters/regex.js

@@ -30,7 +30,7 @@ export default function formatToRegex(pChanges, pExtensions = DEFAULT_EXTENSIONS
         .filter((pChange) => pChangeTypes.has(pChange.changeType))
         .map(({ name }) => name)
         .filter((pName) => pExtensions.has(extname(pName)))
-        .map((pName) => pName.replace(/\./g, "\\."))
+        .map((pName) => pName.replace(/\\/g, "\\\\").replace(/\./g, "\\."))
         .join("|");
     return `^(${lChanges})$`;
 }

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

@@ -1,19 +1,22 @@
 import { spawnSync } from "node:child_process";
-function stringifyOutStream(pError) {
-    if (pError instanceof Buffer) {
-        return pError.toString("utf8");
-    }
-    else {
-        return pError;
-    }
+export function getStatusShortSync(pSpawnFunction = spawnSync) {
+    const lErrorMap = {
+        129: `'${process.cwd()}' does not seem to be a git repository`,
+    };
+    return getGitResultSync(["status", "--porcelain"], lErrorMap, pSpawnFunction);
 }
-function throwSpawnError(pError) {
-    if (pError.code === "ENOENT") {
-        throw new Error("git executable not found");
-    }
-    else {
-        throw new Error(`internal spawn error: ${pError}`);
-    }
+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);
 }
 function getGitResultSync(pArguments, pErrorMap, pSpawnFunction) {
     const lGitResult = pSpawnFunction("git", pArguments, {
@@ -31,22 +34,19 @@ function getGitResultSync(pArguments, pErrorMap, pSpawnFunction) {
             `internal git error: ${lGitResult.status} (${stringifyOutStream(lGitResult.stderr)})`);
     }
 }
-export function getStatusShortSync(pSpawnFunction = spawnSync) {
-    const lErrorMap = {
-        129: `'${process.cwd()}' does not seem to be a git repository`,
-    };
-    return getGitResultSync(["status", "--porcelain"], lErrorMap, pSpawnFunction);
-}
-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);
+function stringifyOutStream(pError) {
+    if (pError instanceof Buffer) {
+        return pError.toString("utf8");
+    }
+    else {
+        return pError;
+    }
 }
-export function getSHASync(pSpawnFunction = spawnSync) {
-    const lSha1Length = 40;
-    return getGitResultSync(["rev-parse", "HEAD"], {}, pSpawnFunction).slice(0, lSha1Length);
+function throwSpawnError(pError) {
+    if (pError.code === "ENOENT") {
+        throw new Error("git executable not found");
+    }
+    else {
+        throw new Error(`internal spawn error: ${pError}`);
+    }
 }

package/dist/esm/git-primitives.js

@@ -1,11 +1,25 @@
 import { spawn } from "node:child_process";
-function stringifyOutStream(pBufferOrString) {
-    if (pBufferOrString instanceof Buffer) {
-        return pBufferOrString.toString("utf8");
-    }
-    else {
-        return pBufferOrString;
-    }
+export async function getStatusShort(pSpawnFunction = spawn) {
+    const lErrorMap = {
+        129: `'${process.cwd()}' does not seem to be a git repository`,
+    };
+    const lResult = await getGitResult(["status", "--porcelain"], lErrorMap, pSpawnFunction);
+    return lResult;
+}
+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`,
+    };
+    const lResult = await getGitResult(pNewRevision
+        ? ["diff", pOldRevision, pNewRevision, "--name-status"]
+        : ["diff", pOldRevision, "--name-status"], lErrorMap, pSpawnFunction);
+    return lResult;
+}
+export async function getSHA(pSpawnFunction = spawn) {
+    const lSha1Length = 40;
+    const lResult = await getGitResult(["rev-parse", "HEAD"], {}, pSpawnFunction);
+    return lResult.slice(0, lSha1Length);
 }
 function getGitResult(pArguments, pErrorMap, pSpawnFunction) {
     const lGit = pSpawnFunction("git", pArguments, {
@@ -40,25 +54,11 @@ function getGitResult(pArguments, pErrorMap, pSpawnFunction) {
         });
     });
 }
-export async function getStatusShort(pSpawnFunction = spawn) {
-    const lErrorMap = {
-        129: `'${process.cwd()}' does not seem to be a git repository`,
-    };
-    const lResult = await getGitResult(["status", "--porcelain"], lErrorMap, pSpawnFunction);
-    return lResult;
-}
-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`,
-    };
-    const lResult = await getGitResult(pNewRevision
-        ? ["diff", pOldRevision, pNewRevision, "--name-status"]
-        : ["diff", pOldRevision, "--name-status"], lErrorMap, pSpawnFunction);
-    return lResult;
-}
-export async function getSHA(pSpawnFunction = spawn) {
-    const lSha1Length = 40;
-    const lResult = await getGitResult(["rev-parse", "HEAD"], {}, pSpawnFunction);
-    return lResult.slice(0, lSha1Length);
+function stringifyOutStream(pBufferOrString) {
+    if (pBufferOrString instanceof Buffer) {
+        return pBufferOrString.toString("utf8");
+    }
+    else {
+        return pBufferOrString;
+    }
 }

package/dist/esm/version.js

@@ -0,0 +1 @@
+export const VERSION = "0.11.4";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watskeburt",
-  "version": "0.11.2",
+  "version": "0.11.4",
   "description": "List files changed since a git revision",
   "keywords": [
     "git",
@@ -43,17 +43,14 @@
     "package.json",
     "README.md"
   ],
-  "dependencies": {
-    "commander": "10.0.1"
-  },
   "devDependencies": {
     "@types/mocha": "10.0.1",
-    "@types/node": "20.1.4",
-    "@typescript-eslint/eslint-plugin": "5.59.5",
-    "c8": "7.13.0",
-    "dependency-cruiser": "13.0.0",
-    "esbuild": "0.17.19",
-    "eslint": "8.40.0",
+    "@types/node": "20.3.1",
+    "@typescript-eslint/eslint-plugin": "5.59.11",
+    "c8": "8.0.0",
+    "dependency-cruiser": "13.0.3",
+    "esbuild": "0.18.4",
+    "eslint": "8.43.0",
     "eslint-config-moving-meadow": "4.0.2",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-budapestian": "5.0.1",
@@ -67,15 +64,15 @@
     "npm-run-all": "4.1.5",
     "prettier": "2.8.8",
     "ts-node": "10.9.1",
-    "typescript": "5.0.4",
-    "upem": "7.3.2"
+    "typescript": "5.1.3",
+    "upem": "8.0.0"
   },
   "engines": {
-    "node": "^14||^16||>=18"
+    "node": "^16.19||^18.11||>=20"
   },
   "scripts": {
     "build": "npm-run-all --sequential build:clean build:version build:dist",
-    "build:version": "node --no-warnings --loader ts-node/esm tools/get-version.ts > bin/version.js",
+    "build:version": "node --no-warnings --loader ts-node/esm tools/get-version.ts > src/version.ts",
     "build:clean": "rm -rf dist/*",
     "build:dist": "npm-run-all build:dist:*",
     "build:dist:cjs": "esbuild src/main.ts --format=cjs --target=node14 --platform=node --bundle --global-name=wkbtcjs --minify --outfile=dist/cjs-bundle.cjs",

package/types/watskeburt.d.ts

@@ -29,12 +29,12 @@ export interface IChange {
 
 export type outputTypeType = "regex" | "json" | "object";
 
-export interface IOptions {
+export interface IFormatOptions {
   /**
    * The type of output to deliver. Defaults to "object" - in which case
    * the listSync function returns an IChange[] object
    */
-  outputType?: outputTypeType;
+  outputType: "regex" | "json";
   /**
    * When true _only_ takes already tracked files into account.
    * When false also takes untracked files into account.
@@ -44,6 +44,23 @@ export interface IOptions {
   trackedOnly?: boolean;
 }
 
+export interface IInternalOptions {
+  /**
+   * The type of output to deliver. Defaults to "object" - in which case
+   * the listSync function returns an IChange[] object
+   */
+  outputType?: "object";
+  /**
+   * When true _only_ takes already tracked files into account.
+   * When false also takes untracked files into account.
+   *
+   * Defaults to false.
+   */
+  trackedOnly?: boolean;
+}
+
+export type IOptions = IFormatOptions | IInternalOptions;
+
 /**
  * returns a list of files changed since pOldRevision.
  *
@@ -59,11 +76,49 @@ export interface IOptions {
 export function listSync(
   pOldRevision?: string,
   pNewRevision?: string,
-  pOptions?: IOptions
-): IChange[] | string;
+  pOptions?: IInternalOptions
+): IChange[];
 
 /**
- * returns a list of files changed since pOldRevision.
+ * returns a list of files changed since pOldRevision formatted into a string
+ * as pOptions.outputType
+ *
+ * @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 listSync(
+  pOldRevision?: string,
+  pNewRevision?: string,
+  pOptions?: IFormatOptions
+): string;
+
+/**
+ * returns promise of 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?: IInternalOptions
+): Promise<IChange[]>;
+
+/**
+ * returns promise a list of files changed since pOldRevision, formatted into a
+ * string as a pOptions.outputType
  *
  * @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_
@@ -77,8 +132,8 @@ export function listSync(
 export function list(
   pOldRevision?: string,
   pNewRevision?: string,
-  pOptions?: IOptions
-): Promise<IChange[] | string>;
+  pOptions?: IFormatOptions
+): Promise<string>;
 
 /**
  * Returns the SHA1 of the current HEAD

package/bin/version.js

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