watskeburt 0.6.1 → 0.8.0

package/README.md

@@ -35,9 +35,16 @@ console.log(getSHASync());
 /** @type {import('watskeburt').IChange[]} */
 const lChangedFiles = listSync("main");
 
-// As a second parameter you can pass some options:
+// 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");
+
+// 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", {
+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)
 });

package/dist/cjs-bundle.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watskeburt",
-  "version": "0.6.1",
+  "version": "0.8.0",
   "description": "List files changed since a git revision",
   "keywords": [
     "git",
@@ -44,28 +44,30 @@
     "README.md"
   ],
   "dependencies": {
-    "commander": "^9.3.0"
+    "commander": "9.4.1"
   },
   "devDependencies": {
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^18.6.3",
-    "@typescript-eslint/eslint-plugin": "^5.32.0",
-    "c8": "^7.12.0",
-    "dependency-cruiser": "^11.14.1",
-    "esbuild": "^0.14.51",
-    "eslint": "^8.21.0",
-    "eslint-config-moving-meadow": "^3.0.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-budapestian": "^4.0.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-mocha": "^10.1.0",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-security": "^1.5.0",
-    "eslint-plugin-unicorn": "^43.0.2",
-    "mocha": "^10.0.0",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^2.7.1",
-    "typescript": "^4.7.4"
+    "@types/mocha": "10.0.0",
+    "@types/node": "18.11.3",
+    "@typescript-eslint/eslint-plugin": "5.40.1",
+    "c8": "7.12.0",
+    "dependency-cruiser": "11.17.0",
+    "esbuild": "0.15.12",
+    "eslint": "8.26.0",
+    "eslint-config-moving-meadow": "4.0.2",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-budapestian": "5.0.1",
+    "eslint-plugin-eslint-comments": "3.2.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-mocha": "10.1.0",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-security": "1.5.0",
+    "eslint-plugin-unicorn": "44.0.2",
+    "mocha": "10.1.0",
+    "npm-run-all": "4.1.5",
+    "prettier": "2.7.1",
+    "typescript": "4.8.4",
+    "upem": "7.3.0"
   },
   "engines": {
     "node": "^12.20||^14||>=16"
@@ -76,8 +78,8 @@
     "build:dist": "esbuild src/main.mjs --format=cjs --target=node12 --platform=node --bundle --global-name=wkbtcjs --minify --outfile=dist/cjs-bundle.js",
     "check": "npm-run-all --parallel --aggregate-output lint depcruise test:cover",
     "clean": "rm -rf dist",
-    "test": "mocha \"src/**/*.spec.mjs\"",
-    "test:cover": "c8 --check-coverage --statements 100 --branches 100 --functions 100 --lines 100 --exclude \"**/*.spec.mjs\" --reporter text-summary --reporter html --reporter json-summary npm test",
+    "test": "mocha",
+    "test:cover": "c8 --check-coverage --statements 100 --branches 100 --functions 100 --lines 100 --exclude \"**/*.spec.mjs\" --reporter text-summary --reporter html --reporter json-summary mocha",
     "depcruise": "depcruise src types --config --cache",
     "depcruise:graph": "depcruise src types --cache --include-only '^(src|types)' --config --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 --cache --include-only '^(src)' --config --output-type archi | dot -T svg | depcruise-wrap-stream-in-html > docs/high-level-dependency-graph.html",
@@ -96,6 +98,10 @@
     "lint:format:fix": "prettier --loglevel warn --write \"{src,tools}/**/*.mjs\" \"types/**/*.ts\" \"*.{json,yml,md,js}\"",
     "lint:types": "tsc",
     "scm:stage": "git add .",
+    "update-dependencies": "run-s upem:update upem:install lint:fix check",
+    "upem-outdated": "npm outdated --json --long | upem --dry-run",
+    "upem:install": "npm install",
+    "upem:update": "npm outdated --json --long | upem | pbcopy && pbpaste",
     "version": "npm-run-all --sequential clean build lint depcruise:graph scm:stage"
   },
   "eslintIgnore": [

package/src/cli.mjs

@@ -7,17 +7,19 @@ import { VERSION } from "./version.mjs";
 
 program
   .description(
-    "lists files & their statuses since [revision].\n\n" +
-      "-> When you don't pass a revision the revision defaults to the current one."
+    "lists files & their statuses since [old-revision] " +
+      "or between [old-revision] and [new-revision]." +
+      "\n\n" +
+      "-> When you don't pass a revision at all old-revision defaults to the current one."
   )
   .version(VERSION)
   .option("-T, --output-type <type>", "json,regex", "regex")
   .option("--tracked-only", "only take tracked files into account", false)
-  .arguments("[revision]")
+  .arguments("[old-revision] [new-revision]")
   .parse(process.argv);
 
 try {
-  console.log(listSync(program.args[0], program.opts()));
+  console.log(listSync(program.args[0], program.args[1], program.opts()));
 } catch (pError) {
   console.error(`ERROR: ${pError.message}`);
 }

package/src/convert-to-change-object.mjs

@@ -1,6 +1,6 @@
 // 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.
+// to redos  attacks.
 /* eslint-disable unicorn/no-unsafe-regex, security/detect-unsafe-regex */
 import { EOL } from "node:os";
 

package/src/formatters/regex.mjs

@@ -5,12 +5,14 @@ const DEFAULT_EXTENSIONS = new Set([
   ".cjsx",
   ".coffee",
   ".csx",
+  ".cts",
   ".js",
   ".json",
   ".jsx",
   ".litcoffee",
   ".ls",
   ".mjs",
+  ".mts",
   ".svelte",
   ".ts",
   ".tsx",

package/src/git-primitives.mjs

@@ -60,16 +60,27 @@ export function getStatusShort(pSpawnFunction = spawnSync) {
 /**
  *
  * @param {string} pOldRevision the target to compare against (e.g. branch name, commit, tag etc)
+ * @param {string} pNewRevision Newer revision against which to compare. Leave out or pass
+ *                 null when you want to compare against the working tree
  * @return {string}
  * @throws {Error}
  */
-export function getDiffLines(pOldRevision, pSpawnFunction = spawnSync) {
+export function getDiffLines(
+  pOldRevision,
+  pNewRevision,
+  pSpawnFunction = spawnSync
+) {
   const lErrorMap = {
-    128: `revision '${pOldRevision}' unknown `,
+    128: `revision '${pOldRevision}' ${
+      pNewRevision ? `(or '${pNewRevision}') ` : ""
+    }unknown`,
     129: `'${process.cwd()}' does not seem to be a git repository`,
   };
+
   return getGitResult(
-    ["diff", pOldRevision, "--name-status"],
+    pNewRevision
+      ? ["diff", pOldRevision, pNewRevision, "--name-status"]
+      : ["diff", pOldRevision, "--name-status"],
     lErrorMap,
     pSpawnFunction
   );

package/src/main.mjs

@@ -11,11 +11,13 @@ export function getSHASync() {
 }
 
 /** @type {import("../types/watskeburt").listSync} */
-export function listSync(pOldRevision, pOptions) {
+export function listSync(pOldRevision, pNewRevision, pOptions) {
   const lOldRevision = pOldRevision || getSHA1();
-  let lChanges = convertDiffLines(getDiffLines(lOldRevision));
+  const lNewRevision = pNewRevision || null;
   const lOptions = pOptions || {};
 
+  let lChanges = convertDiffLines(getDiffLines(lOldRevision, lNewRevision));
+
   if (!lOptions.trackedOnly) {
     lChanges = lChanges.concat(
       convertStatusLines(getStatusShort()).filter(

package/src/version.mjs

@@ -1 +1 @@
-export const VERSION = "0.6.1";
+export const VERSION = "0.8.0";

package/types/watskeburt.d.ts

@@ -50,12 +50,15 @@ export interface IOptions {
  * @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?: IOptions
 ): IChange[] | string;