watskeburt 0.11.6 → 0.12.1

package/README.md

@@ -24,26 +24,20 @@ but for just this simple usage they're a bit overkill.
 ### :scroll: API
 
 ```javascript
-// const { listSync, getSHASync } = require("watskeburt"); // in commonjs contexts you can also require it
-import { list, getSHA, listSync, getSHASync } from "watskeburt";
+import { list, getSHA } 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 = await list("main");
-// 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
 // (pass null as the second parameter if you only want to compare between
@@ -53,11 +47,6 @@ 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 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)
-// });
 ```
 
 The array of changes this returns looks like this:

package/dist/cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import { cli } from "./execute-cli.js";
+await cli();

package/dist/{esm/cli.js → execute-cli.js}

@@ -13,7 +13,7 @@ Options:
   --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) {
+export async function cli(pArguments = process.argv.slice(2), pOutStream = process.stdout, pErrorStream = process.stderr, pErrorExitCode = 1) {
     try {
         const lArguments = getArguments(pArguments);
         if (lArguments.values.help) {
@@ -26,7 +26,7 @@ export async function cli(pArguments = process.argv.slice(2), pOutStream = proce
         }
         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;
+            process.exitCode = pErrorExitCode;
             return;
         }
         const lResult = await list(lArguments.positionals[0], lArguments.positionals[1], lArguments.values);
@@ -34,7 +34,7 @@ export async function cli(pArguments = process.argv.slice(2), pOutStream = proce
     }
     catch (pError) {
         pErrorStream.write(`${EOL}ERROR: ${pError.message}${EOL}${EOL}`);
-        process.exitCode = 1;
+        process.exitCode = pErrorExitCode;
     }
 }
 function getArguments(pArguments) {

package/dist/{esm/main.js → main.js}

@@ -1,5 +1,4 @@
 import { convertDiffLines, convertStatusLines, } from "./convert-to-change-object.js";
-import * as primitivesSync from "./git-primitives-sync.js";
 import * as primitives from "./git-primitives.js";
 import format from "./formatters/format.js";
 export async function list(pOldRevision, pNewRevision, pOptions) {
@@ -15,18 +14,6 @@ export async function list(pOldRevision, pNewRevision, pOptions) {
     }
     return format(lChanges, lOptions.outputType);
 }
-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/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watskeburt",
-  "version": "0.11.6",
+  "version": "0.12.1",
   "description": "List files changed since a git revision",
   "keywords": [
     "git",
@@ -19,23 +19,21 @@
     "url": "https://sverweij.github.io"
   },
   "license": "MIT",
-  "bin": "bin/cli.js",
-  "main": "dist/cjs-bundle.cjs",
-  "module": "dist/esm/main.js",
+  "bin": "dist/cli.js",
+  "main": "dist/main.js",
+  "module": "dist/main.js",
   "type": "module",
   "sideEffects": false,
   "exports": {
     ".": [
       {
-        "import": "./dist/esm/main.js",
-        "require": "./dist/cjs-bundle.cjs"
+        "import": "./dist/main.js"
       },
-      "./dist/cjs-bundle.cjs"
+      "./dist/main.js"
     ]
   },
   "types": "types/watskeburt.d.ts",
   "files": [
-    "bin",
     "dist",
     "!**/*.DS_Store",
     "types",
@@ -44,23 +42,20 @@
     "README.md"
   ],
   "devDependencies": {
-    "@types/mocha": "10.0.1",
-    "@types/node": "20.4.1",
-    "@typescript-eslint/eslint-plugin": "6.0.0",
-    "c8": "8.0.0",
-    "dependency-cruiser": "13.1.0",
-    "esbuild": "0.18.11",
-    "eslint": "8.44.0",
+    "@types/node": "20.4.5",
+    "@typescript-eslint/eslint-plugin": "6.2.1",
+    "c8": "8.0.1",
+    "dependency-cruiser": "13.1.1",
+    "eslint": "8.46.0",
     "eslint-config-moving-meadow": "4.0.2",
-    "eslint-config-prettier": "8.8.0",
+    "eslint-config-prettier": "8.9.0",
     "eslint-plugin-budapestian": "5.0.1",
     "eslint-plugin-eslint-comments": "3.2.0",
-    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-import": "2.28.0",
     "eslint-plugin-mocha": "10.1.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-security": "1.7.1",
-    "eslint-plugin-unicorn": "47.0.0",
-    "mocha": "10.2.0",
+    "eslint-plugin-unicorn": "48.0.1",
     "npm-run-all": "4.1.5",
     "prettier": "3.0.0",
     "ts-node": "10.9.1",
@@ -74,29 +69,28 @@
     "build": "npm-run-all --sequential build:clean build:version build:dist",
     "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",
-    "build:dist:esm": "tsc",
+    "build:dist": "tsc",
     "check": "npm-run-all --parallel --aggregate-output lint depcruise test:cover",
     "clean": "rm -rf dist",
-    "test": "NODE_OPTIONS=--no-warnings mocha",
-    "test:cover": "NODE_OPTIONS=--no-warnings c8 mocha",
-    "depcruise": "depcruise bin dist src types",
-    "depcruise:graph": "depcruise bin src types --include-only '^(bin|dist|src|types)' --output-type dot | dot -T svg | tee docs/dependency-graph.svg | depcruise-wrap-stream-in-html > docs/dependency-graph.html",
-    "depcruise:graph:archi": "depcruise bin src --include-only '^(bin|dist|src|types)' --output-type archi | dot -T svg | depcruise-wrap-stream-in-html > docs/high-level-dependency-graph.html",
-    "depcruise:graph:dev": "depcruise bin dist src types --include-only '^(bin|dist|src|types)' --prefix vscode://file/$(pwd)/ --output-type dot | dot -T svg | depcruise-wrap-stream-in-html | browser",
-    "depcruise:graph:diff:dev": "depcruise bin dist src types --include-only '^(bin|dist|src|types)' --highlight \"$(node bin/cli.js main -T regex)\" --prefix vscode://file/$(pwd)/ --output-type dot | dot -T svg | depcruise-wrap-stream-in-html | browser",
-    "depcruise:graph:diff:mermaid": "depcruise bin dist src types --include-only '^(bin|dist|src|types)' --output-type mermaid --output-to - --highlight \"$(node bin/cli.js $SHA -T regex)\"",
-    "depcruise:html": "depcruise bin src types --progress --output-type err-html --output-to dependency-violation-report.html",
-    "depcruise:text": "depcruise bin src types --progress --output-type text",
-    "depcruise:focus": "depcruise bin src types --progress --output-type text --focus",
-    "depcruise:reaches": "depcruise bin src types --progress --output-type text --reaches",
-    "format": "prettier --write \"{bin,src,tools}/**/*.{js,ts}\" \"types/**/*.ts\" \"*.{json,yml,md,js}\"",
-    "format:check": "prettier --loglevel warn --check \"{bin,src,tools}/**/*.ts\" \"types/**/*.ts\" \"*.{json,yml,md,js}\"",
+    "test": "node --no-warnings --loader 'ts-node/esm' --test-reporter dot --test src/*.spec.ts src/**/*.spec.ts",
+    "test:cover": "c8 npm test",
+    "test:only-for-node-16-without-the-test-reporter": "node --no-warnings --loader 'ts-node/esm' --test src/*.spec.ts src/**/*.spec.ts",
+    "depcruise": "depcruise dist src types",
+    "depcruise:graph": "depcruise src types --include-only '^(dist|src|types)' --output-type dot | dot -T svg | tee docs/dependency-graph.svg | depcruise-wrap-stream-in-html > docs/dependency-graph.html",
+    "depcruise:graph:archi": "depcruise src --include-only '^(dist|src|types)' --output-type archi | dot -T svg | depcruise-wrap-stream-in-html > docs/high-level-dependency-graph.html",
+    "depcruise:graph:dev": "depcruise dist src types --include-only '^(dist|src|types)' --prefix vscode://file/$(pwd)/ --output-type dot | dot -T svg | depcruise-wrap-stream-in-html | browser",
+    "depcruise:graph:diff:dev": "depcruise dist src types --include-only '^(dist|src|types)' --highlight \"$(node dist/cli.js main -T regex)\" --prefix vscode://file/$(pwd)/ --output-type dot | dot -T svg | depcruise-wrap-stream-in-html | browser",
+    "depcruise:graph:diff:mermaid": "depcruise dist src types --include-only '^(dist|src|types)' --output-type mermaid --output-to - --highlight \"$(node dist/cli.js $SHA -T regex)\"",
+    "depcruise:html": "depcruise src types --progress --output-type err-html --output-to dependency-violation-report.html",
+    "depcruise:text": "depcruise src types --progress --output-type text",
+    "depcruise:focus": "depcruise src types --progress --output-type text --focus",
+    "depcruise:reaches": "depcruise src types --progress --output-type text --reaches",
+    "format": "prettier --write \"{src,tools}/**/*.{js,ts}\" \"types/**/*.ts\" \"*.{json,yml,md,js}\"",
+    "format:check": "prettier --log-level warn --check \"{src,tools}/**/*.ts\" \"types/**/*.ts\" \"*.{json,yml,md,js}\"",
     "lint": "npm-run-all --parallel --aggregate-output format:check lint:eslint lint:types",
     "lint:fix": "npm-run-all --parallel --aggregate-output format lint:eslint:fix",
-    "lint:eslint": "eslint bin src types tools --cache --cache-location node_modules/.cache/eslint/",
-    "lint:eslint:fix": "eslint bin src types tools --fix --cache --cache-location node_modules/.cache/eslint/",
+    "lint:eslint": "eslint src types tools --cache --cache-location node_modules/.cache/eslint/",
+    "lint:eslint:fix": "eslint src types tools --fix --cache --cache-location node_modules/.cache/eslint/",
     "lint:types": "tsc --noEmit",
     "scm:stage": "git add .",
     "update-dependencies": "run-s upem:update upem:install lint:fix check",

package/types/watskeburt.d.ts

@@ -61,43 +61,6 @@ export interface IInternalOptions {
 
 export type IOptions = IFormatOptions | IInternalOptions;
 
-/**
- * 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 listSync(
-  pOldRevision?: string,
-  pNewRevision?: string,
-  pOptions?: IInternalOptions,
-): IChange[];
-
-/**
- * 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.
  *
@@ -135,13 +98,6 @@ export function list(
   pOptions?: IFormatOptions,
 ): Promise<string>;
 
-/**
- * Returns the SHA1 of the current HEAD
- *
- * @throws {Error}
- */
-export function getSHASync(): string;
-
 /**
  * Returns the SHA1 of the current HEAD
  *

package/bin/cli.js

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-
-import { cli } from "../dist/esm/cli.js";
-
-await cli();

package/dist/cjs-bundle.cjs

@@ -1 +0,0 @@
-"use strict";var l=Object.defineProperty;var $=Object.getOwnPropertyDescriptor;var v=Object.getOwnPropertyNames;var _=Object.prototype.hasOwnProperty;var k=(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 v(t))!_.call(e,s)&&s!==n&&l(e,s,{get:()=>t[s],enumerable:!(r=$(t,s))||r.enumerable});return e};var b=e=>H(l({},"__esModule",{value:!0}),e);var ee={};k(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=new Map([["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.get(e)??"unknown"}var c=require("child_process");function A(e=c.spawnSync){let t=new Map([[129,`'${process.cwd()}' does not seem to be a git repository`]]);return h(["status","--porcelain"],t,e)}function N(e,t,n=c.spawnSync){let r=new Map([[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=c.spawnSync){return h(["rev-parse","HEAD"],new Map,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 M(r.stdout);throw new Error(t.get(r.status??0)||`internal git error: ${r.status} (${M(r.stderr)})`)}function M(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 L(e=u.spawn){let t=new Map([[129,`'${process.cwd()}' does not seem to be a git repository`]]);return await C(["status","--porcelain"],t,e)}async function O(e,t,n=u.spawn){let r=new Map([[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"],new Map,e)).slice(0,40)}function C(e,t,n){let r=n("git",e,{cwd:process.cwd(),env:process.env}),s="",a="";return new Promise((p,i)=>{var g,x;(g=r.stdout)==null||g.on("data",o=>{s=s.concat(o)}),(x=r.stderr)==null||x.on("data",o=>{a=a.concat(o)}),r.on("close",o=>{o===0?p(D(s)):i(new Error(t.get(o??0)||`internal git error: ${o} (${D(a)})`))}),r.on("error",o=>{(o==null?void 0:o.code)==="ENOENT"?i(new Error("git executable not found")):i(new Error(`internal spawn error: ${o}`))})})}function D(e){return e instanceof Buffer?e.toString("utf8"):e}var P=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,P.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||{},[a,p]=await Promise.all([O(r,t),s.trackedOnly?"":L()]),i=T(a);return s.trackedOnly||(i=i.concat(d(p).filter(({changeType:g})=>g==="untracked"))),f(i,s.outputType)}function Q(e,t,n){let r=e||S(),s=n||{},a=T(N(r,t));return s.trackedOnly||(a=a.concat(d(A()).filter(({changeType:p})=>p==="untracked"))),f(a,s.outputType)}function W(){return w()}function Z(){return S()}0&&(module.exports={getSHA,getSHASync,list,listSync});

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

@@ -1,55 +0,0 @@
-import { spawnSync } from "node:child_process";
-export function getStatusShortSync(pSpawnFunction = spawnSync) {
-    const lErrorMap = new Map([
-        [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 = new Map([
-        [
-            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"], new Map(), pSpawnFunction).slice(0, lSha1Length);
-}
-function getGitResultSync(pArguments, pErrorMap, pSpawnFunction) {
-    const lGitResult = pSpawnFunction("git", pArguments, {
-        cwd: process.cwd(),
-        env: process.env,
-    });
-    if (lGitResult.error) {
-        throwSpawnError(lGitResult.error);
-    }
-    if (lGitResult.status === 0) {
-        return stringifyOutStream(lGitResult.stdout);
-    }
-    else {
-        throw new Error(pErrorMap.get(lGitResult.status ?? 0) ||
-            `internal git error: ${lGitResult.status} (${stringifyOutStream(lGitResult.stderr)})`);
-    }
-}
-function stringifyOutStream(pError) {
-    if (pError instanceof Buffer) {
-        return pError.toString("utf8");
-    }
-    else {
-        return pError;
-    }
-}
-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/version.js

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