watskeburt 0.11.0 → 0.11.2

package/README.md

@@ -35,13 +35,14 @@ console.log(getSHASync());
 // files not staged for commit and files not under revision control)
 /** @type {import('watskeburt').IChange[]} */
 const lChangedFiles = await list("main");
-// or, with the sync interface:
+// or with the synchronous 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 = await list("v0.6.1", "v0.7.1");
+// or with the synchronous interface:
 // const lChangedFiles = listSync("v0.6.1", "v0.7.1");
 
 // As a third parameter you can pass some options
@@ -52,8 +53,8 @@ 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, {
+// or with the synchronous interface:
+// const lChangedFiles = listSync("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)
 // });
@@ -86,7 +87,7 @@ For now there's also a simple command line interface
 ```shell
 # list all JavaScript-ish files changed since main in a regular expression
 $ npx watskeburt main
-^(src/cli.mjs|src/formatters/regex.mjs|src/version.mjs)$
+^(src/cli\.mjs|src/formatters/regex\.mjs|src/version\.mjs)$
 ```
 
 By default this returns a regex that contains all changed files that could be
@@ -115,4 +116,4 @@ Options:
 _watskeburt_ is a fast pronunciation of the Dutch "wat is er gebeurd?"
 (_what has happened?_) or "wat er is gebeurd" (_what has happened_). It's
 also the title of a song by the Dutch band "De Jeugd van Tegenwoordig"
-(_Youth these days..._).
+(_Youth these days_).

package/bin/version.js

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

package/dist/cjs-bundle.cjs

@@ -1 +1 @@
-"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});
+"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});

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

@@ -1,7 +1,3 @@
-// the security (and unicorn) plugins don't seem to detect named caption
-// groups very well - false-flagging below regular expressions to be susceptible
-// to redos  attacks.
-/* eslint-disable unicorn/no-unsafe-regex, security/detect-unsafe-regex */
 import { EOL } from "node:os";
 const DIFF_NAME_STATUS_LINE_PATTERN = /^(?<changeType>[ACDMRTUXB])(?<similarity>[0-9]{3})?[ \t]+(?<name>[^ \t]+)[ \t]*(?<newName>[^ \t]+)?$/;
 const DIFF_SHORT_STATUS_LINE_PATTERN = /^(?<stagedChangeType>[ ACDMRTUXB?!])(?<unStagedChangeType>[ ACDMRTUXB?!])[ \t]+(?<name>[^ \t]+)(( -> )(?<newName>[^ \t]+))?$/;
@@ -17,10 +13,8 @@ const CHANGE_CHAR_2_CHANGE_TYPE = {
     " ": "unmodified",
     "?": "untracked",
     "!": "ignored",
-    // X: "unknown"
 };
 function changeChar2ChangeType(pChar) {
-    // eslint-disable-next-line security/detect-object-injection
     return CHANGE_CHAR_2_CHANGE_TYPE[pChar] ?? "unknown";
 }
 export function convertStatusLine(pString) {

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)))
-        // .replace(/\./g, "\\\\.")
+        .map((pName) => pName.replace(/\./g, "\\."))
         .join("|");
     return `^(${lChanges})$`;
 }

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

@@ -7,7 +7,6 @@ function stringifyOutStream(pError) {
         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");
@@ -16,13 +15,9 @@ function throwSpawnError(pError) {
         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) {
@@ -36,19 +31,12 @@ function getGitResultSync(pArguments, pErrorMap, pSpawnFunction) {
             `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`,

package/dist/esm/git-primitives.js

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import { spawn } from "node:child_process";
 function stringifyOutStream(pBufferOrString) {
     if (pBufferOrString instanceof Buffer) {
@@ -8,13 +7,9 @@ function stringifyOutStream(pBufferOrString) {
         return pBufferOrString;
     }
 }
-/**
- * @throws {Error}
- */
 function getGitResult(pArguments, pErrorMap, pSpawnFunction) {
     const lGit = pSpawnFunction("git", pArguments, {
         cwd: process.cwd(),
-        // eslint-disable-next-line node/no-process-env
         env: process.env,
     });
     let lStdOutData = "";
@@ -45,9 +40,6 @@ function getGitResult(pArguments, pErrorMap, pSpawnFunction) {
         });
     });
 }
-/**
- * @throws {Error}
- */
 export async function getStatusShort(pSpawnFunction = spawn) {
     const lErrorMap = {
         129: `'${process.cwd()}' does not seem to be a git repository`,
@@ -55,10 +47,6 @@ export async function getStatusShort(pSpawnFunction = spawn) {
     const lResult = await getGitResult(["status", "--porcelain"], lErrorMap, pSpawnFunction);
     return lResult;
 }
-/**
- *
- * @throws {Error}
- */
 export async function getDiffLines(pOldRevision, pNewRevision, pSpawnFunction = spawn) {
     const lErrorMap = {
         128: `revision '${pOldRevision}' ${pNewRevision ? `(or '${pNewRevision}') ` : ""}unknown`,

package/dist/esm/main.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watskeburt",
-  "version": "0.11.0",
+  "version": "0.11.2",
   "description": "List files changed since a git revision",
   "keywords": [
     "git",
@@ -48,12 +48,12 @@
   },
   "devDependencies": {
     "@types/mocha": "10.0.1",
-    "@types/node": "18.16.2",
-    "@typescript-eslint/eslint-plugin": "5.59.1",
+    "@types/node": "20.1.4",
+    "@typescript-eslint/eslint-plugin": "5.59.5",
     "c8": "7.13.0",
-    "dependency-cruiser": "13.0.0-beta-5",
-    "esbuild": "0.17.18",
-    "eslint": "8.39.0",
+    "dependency-cruiser": "13.0.0",
+    "esbuild": "0.17.19",
+    "eslint": "8.40.0",
     "eslint-config-moving-meadow": "4.0.2",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-budapestian": "5.0.1",
@@ -62,7 +62,7 @@
     "eslint-plugin-mocha": "10.1.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-security": "1.7.1",
-    "eslint-plugin-unicorn": "46.0.0",
+    "eslint-plugin-unicorn": "47.0.0",
     "mocha": "10.2.0",
     "npm-run-all": "4.1.5",
     "prettier": "2.8.8",
@@ -70,21 +70,12 @@
     "typescript": "5.0.4",
     "upem": "7.3.2"
   },
-  "upem": {
-    "policies": [
-      {
-        "package": "dependency-cruiser",
-        "policy": "wanted",
-        "because": "we're beta testing v13 & policy 'latest' would downgraded it back to v12 again"
-      }
-    ]
-  },
   "engines": {
     "node": "^14||^16||>=18"
   },
   "scripts": {
     "build": "npm-run-all --sequential build:clean build:version build:dist",
-    "build:version": "ts-node --esm tools/get-version.ts > bin/version.js",
+    "build:version": "node --no-warnings --loader ts-node/esm tools/get-version.ts > bin/version.js",
     "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",