watskeburt 0.5.1 → 0.7.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2022 Sander Verweij
+Copyright (c) 2022-2022 Sander Verweij
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -24,20 +24,27 @@ but for just this simple usage they're a bit overkill.
 ### :scroll: API
 
 ```javascript
-// const { list } = require('watskeburt'); // will work in commonjs  contexts  as well
-import { list, getSHA } from "watskeburt";
+// const { listSync, getSHASync } = require("watskeburt"); // in commonjs contexts you can also require it
+import { listSync, getSHASync } from "watskeburt";
 
 // print the SHA1 of the current HEAD
-console.log(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 = list("main");
+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 = list("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 x=Object.getOwnPropertyDescriptor;var y=Object.getOwnPropertyNames;var A=Object.prototype.hasOwnProperty;var C=(e,t)=>{for(var n in t)a(e,n,{get:t[n],enumerable:!0})},_=(e,t,n,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let r of y(t))!A.call(e,r)&&r!==n&&a(e,r,{get:()=>t[r],enumerable:!(o=x(t,r))||o.enumerable});return e};var D=e=>_(a({},"__esModule",{value:!0}),e);var I={};C(I,{getSHA:()=>E,list:()=>F});module.exports=D(I);var u=require("os"),L=/^(?<changeType>[ACDMRTUXB])(?<similarity>[0-9]{3})?[ \t]+(?<name>[^ \t]+)[ \t]*(?<newName>[^ \t]+)?$/,R=/^(?<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 i(e){return U[e]||"unknown"}function O(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 v(e){let t=e.match(L),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(O).filter(({changeType:t})=>Boolean(t))}function g(e){return e.split(u.EOL).filter(Boolean).map(v).filter(({changeType:t})=>Boolean(t))}var s=require("child_process");function d(e){return e instanceof Buffer?e.toString("utf8"):e}function j(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&&j(o.error),o.status===0)return d(o.stdout);throw new Error(t[o.status]||`internal git error: ${o.status} (${d(o.stderr)})`)}function T(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 S(e=s.spawnSync){return c(["rev-parse","HEAD"],{},e).slice(0,40)}var N=require("path"),$=new Set([".cjs",".cjsx",".coffee",".csx",".js",".json",".jsx",".litcoffee",".ls",".mjs",".svelte",".ts",".tsx",".vue",".vuex"]),B=new Set(["modified","added","renamed","copied","untracked"]);function f(e,t=$,n=B){return`^(${e.filter(r=>n.has(r.changeType)).map(({name:r})=>r).filter(r=>t.has((0,N.extname)(r))).join("|")})$`}function p(e){return JSON.stringify(e,null,2)}var H={regex:f,json:p,object:e=>e},M="object";function l(e,t){return H[t||M](e)}function E(){return S()}function F(e,t){let n=e||E(),o=g(h(n)),r=t||{};return r.trackedOnly||(o=o.concat(m(T()).filter(({changeType:w})=>w==="untracked"))),l(o,r.outputType)}0&&(module.exports={getSHA,list});
+"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 a=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=a.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=a.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=a.spawnSync){return f(["rev-parse","HEAD"],{},e).slice(0,40)}var E=require("path"),B=new Set([".cjs",".cjsx",".coffee",".csx",".js",".json",".jsx",".litcoffee",".ls",".mjs",".svelte",".ts",".tsx",".vue",".vuex"]),H=new Set(["modified","added","renamed","copied","untracked"]);function p(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 m(e){return JSON.stringify(e,null,2)}var j=e=>e,I=new Map([["regex",p],["json",m]]);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||{},s=S(y(r,o));return d.trackedOnly||(s=s.concat(T(N()).filter(({changeType:w})=>w==="untracked"))),g(s,d.outputType)}0&&(module.exports={getSHASync,listSync});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watskeburt",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "description": "List files changed since a git revision",
   "keywords": [
     "git",
@@ -48,12 +48,12 @@
   },
   "devDependencies": {
     "@types/mocha": "^9.1.1",
-    "@types/node": "^18.0.6",
-    "@typescript-eslint/eslint-plugin": "^5.30.7",
+    "@types/node": "^18.6.3",
+    "@typescript-eslint/eslint-plugin": "^5.32.0",
     "c8": "^7.12.0",
-    "dependency-cruiser": "^11.12.0",
-    "esbuild": "^0.14.49",
-    "eslint": "^8.20.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",
@@ -78,15 +78,16 @@
     "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",
-    "depcruise": "depcruise src types --config",
-    "depcruise:graph": "depcruise src types --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 --include-only '^(src)' --config --output-type archi | dot -T svg | depcruise-wrap-stream-in-html > docs/high-level-dependency-graph.html",
-    "depcruise:graph:dev": "depcruise src --include-only '^(src)' --prefix vscode://file/$(pwd)/ --config --output-type dot | dot -T svg | depcruise-wrap-stream-in-html | browser",
-    "depcruise:graph:diff:dev": "depcruise src types --include-only '^(src|types)' --focus \"$(node src/cli.mjs main -T regex)\" --focus-depth 0 --prefix vscode://file/$(pwd)/ --config --output-type dot | dot -T svg | depcruise-wrap-stream-in-html | browser",
-    "depcruise:graph:diff:mermaid": "depcruise src types --include-only '^(src|types)' --config --output-type mermaid --output-to - --focus \"$(node src/cli.mjs $SHA -T regex)\" --focus-depth 0",
-    "depcruise:html": "depcruise src --progress --config --output-type err-html --output-to dependency-violation-report.html",
-    "depcruise:text": "depcruise src --progress --config --output-type text",
-    "depcruise:focus": "depcruise src --progress --config --output-type text --focus",
+    "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",
+    "depcruise:graph:dev": "depcruise src --cache --include-only '^(src)' --prefix vscode://file/$(pwd)/ --config --output-type dot | dot -T svg | depcruise-wrap-stream-in-html | browser",
+    "depcruise:graph:diff:dev": "depcruise src types --cache --include-only '^(src|types)' --focus \"$(node src/cli.mjs main -T regex)\" --focus-depth 0 --prefix vscode://file/$(pwd)/ --config --output-type dot | dot -T svg | depcruise-wrap-stream-in-html | browser",
+    "depcruise:graph:diff:mermaid": "depcruise src types --cache --include-only '^(src|types)' --config --output-type mermaid --output-to - --focus \"$(node src/cli.mjs $SHA -T regex)\" --focus-depth 0",
+    "depcruise:html": "depcruise src types --progress --cache --config --output-type err-html --output-to dependency-violation-report.html",
+    "depcruise:text": "depcruise src types --progress --cache --config --output-type text",
+    "depcruise:focus": "depcruise src types --progress --cache --config --output-type text --focus",
+    "depcruise:reaches": "depcruise src types --progress --cache --config --output-type text --reaches",
     "lint": "npm-run-all --parallel --aggregate-output lint:format lint:eslint lint:types",
     "lint:fix": "npm-run-all --parallel --aggregate-output lint:format:fix lint:eslint:fix",
     "lint:eslint": "eslint src types tools --cache --cache-location node_modules/.cache/eslint/",

package/src/cli.mjs

@@ -2,22 +2,24 @@
 /* eslint-disable no-console */
 
 import { program } from "commander";
-import { list } from "./main.mjs";
+import { listSync } from "./main.mjs";
 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(list(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/formatters/format.mjs

@@ -1,12 +1,11 @@
 import formatToRegex from "./regex.mjs";
 import formatToJSON from "./json.mjs";
 
-const OUTPUT_TYPE_TO_FUNCTION = {
-  regex: formatToRegex,
-  json: formatToJSON,
-  object: (pX) => pX,
-};
-const DEFAULT_OUTPUT_TYPE = "object";
+const identity = (pX) => pX;
+const OUTPUT_TYPE_TO_FUNCTION = new Map([
+  ["regex", formatToRegex],
+  ["json", formatToJSON],
+]);
 
 /**
  *
@@ -15,5 +14,5 @@ const DEFAULT_OUTPUT_TYPE = "object";
  * @returns {string|import("../../types/watskeburt.js").IChange[]}
  */
 export default function format(pChanges, pOutputType) {
-  return OUTPUT_TYPE_TO_FUNCTION[pOutputType || DEFAULT_OUTPUT_TYPE](pChanges);
+  return (OUTPUT_TYPE_TO_FUNCTION.get(pOutputType) || identity)(pChanges);
 }

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

@@ -5,17 +5,19 @@ import {
 import { getDiffLines, getSHA1, getStatusShort } from "./git-primitives.mjs";
 import format from "./formatters/format.mjs";
 
-/** @type {import("../types/watskeburt.js").getSHA} */
-export function getSHA() {
+/** @type {import("../types/watskeburt").getSHASync} */
+export function getSHASync() {
   return getSHA1();
 }
 
-/** @type {import("../types/watskeburt.js").list} */
-export function list(pOldRevision, pOptions) {
-  const lOldRevision = pOldRevision || getSHA();
-  let lChanges = convertDiffLines(getDiffLines(lOldRevision));
+/** @type {import("../types/watskeburt").listSync} */
+export function listSync(pOldRevision, pNewRevision, pOptions) {
+  const lOldRevision = pOldRevision || getSHA1();
+  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.5.1";
+export const VERSION = "0.7.0";

package/types/watskeburt.d.ts

@@ -32,14 +32,14 @@ export type outputTypeType = "regex" | "json" | "object";
 export interface IOptions {
   /**
    * The type of output to deliver. Defaults to "object" - in which case
-   * the list function returns an IChange[] object
+   * the listSync function returns an IChange[] object
    */
   outputType: outputTypeType;
   /**
    * When true _only_ takes already tracked files into account.
-   * When true also takes untracked files into account.
+   * When false also takes untracked files into account.
    *
-   * Defaults to true.
+   * Defaults to false.
    */
   trackedOnly: boolean;
 }
@@ -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 list(
+export function listSync(
   pOldRevision?: string,
+  pNewRevision?: string,
   pOptions?: IOptions
 ): IChange[] | string;
 
@@ -64,4 +67,4 @@ export function list(
  *
  * @throws {Error}
  */
-export function getSHA(): string;
+export function getSHASync(): string;