watskeburt 0.4.0 → 0.6.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

@@ -1,29 +1,67 @@
 # watskeburt
 
-get git changed files & their statuses since _any revision_
+Get changed files & their statuses since any git _revision_
 
 ## what's this do?
 
-A micro-lib to retrieve an array of file names that were changed (added,
-modified, renamed, deleted, ...) since the revision it got passed. Also
-sports a cli for use outside of JavaScript c.s.
+A micro-lib to retrieve an array of file names that were changed since a
+revision. Also sports a cli for use outside of JavaScript c.s.
 
-- :warning: in the process of getting 'production ready'. It's automatically
-  tested + it's using itself - but a bunch of static analysis and a bit of
-  automation still needs be added.
-- :warning: Interface is stable-ish, but can can change until 1.0.0 is published
-- :warning: expect some rough edges for e.g. error scenarios
+- :warning: Interface is stable, but can can change until 1.0.0 is published :warning:
 
 ## why?
 
-Useful primitives to support e.g. auto-documenting pull requests, or to save
-processing power by only doing static analysis only over stuff that is changed.
+I needed something simple and robust to support some upcoming features in
+[dependency-cruiser](https://github.com/sverweij/dependency-cruiser) and to
+run standalone to use _in combination_ with dependency-cruiser.
 
-There are a few packages like these like this on npm, but it seems they've
-fallen out of maintenance. More generic packages don't get plagued by this
+There are a few specialized packages like this on npm, but it seems they've
+fallen out of maintenance. More generic packages are still maintained,
 but for just this simple usage they're a bit overkill.
 
-## usage
+## :construction_worker: usage
+
+### :scroll: API
+
+```javascript
+// 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(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 = listSync("main");
+
+// As a second parameter you can pass some options:
+/** @type {import('watskeburt').IChange[]|string} */
+const lChangedFiles = listSync("main", {
+  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:
+
+```javascript
+[
+  {
+    name: "doc/cli.md",
+    changeType: "modified",
+  },
+  {
+    name: "test/thing.spec.mjs",
+    changeType: "renamed",
+    oldName: "test/old-thing.spec.mjs",
+  },
+  {
+    name: "src/not-tracked-yet.mjs",
+    changeType: "untracked",
+  },
+];
+```
 
 ### :shell: cli
 
@@ -37,7 +75,10 @@ $ npx watskeburt main
 
 By default this returns a regex that contains all changed files that could be
 source files in the JavaScript ecosystem (.js, .mjs, .ts, .tsx ...) that can
-be used in e.g. the `--focus` filter of dependency-cruiser:
+be used in e.g. the `--focus` and `--reaches` filters of dependency-cruiser.
+
+The JSON output (which looks a lot like the array above) is unfiltered and
+also contains other extensions.
 
 ```
 Usage: cli [options] [revision]
@@ -53,36 +94,9 @@ Options:
   -h, --help                display help for command
 ```
 
-### :scroll: API
-
-```javascript
-// const { list } = require('watskeburt'); // will work in commonjs  contexts  as well
-import { list, getSHA } from "watskeburt";
-
-// print the SHA1 of the current HEAD
-console.log(getSHA());
-
-// list all files that differ between 'main' and
-/** @type {import('watskeburt').IChange[]} */
-const lChangedFiles = list("main");
-```
-
-An array of changes looks something like this:
-
-```javascript
-[
-  { name: "doc/cli.md", changeType: "modified" },
-  {
-    name: "test/thing.spec.mjs",
-    changeType: "renamed",
-    oldName: "test/old-thing.spec.mjs",
-  },
-  { name: "src/not-tracked-yet.mjs", changeType: "untracked" },
-];
-```
-
-## 🇳🇱 'watskeburt'??
+## 🇳🇱 what does 'watskeburt' mean?
 
-_watskeburt_ is a fast pronunciation of the Dutch sentence "Wat is er gebeurd?"
-(What has happened?), as well as the title of a song by the Dutch hip hop group
-"De Jeugd van Tegenwoordig".
+_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..._).

package/dist/cjs-bundle.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watskeburt",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "List files changed since a git revision",
   "keywords": [
     "git",
@@ -47,19 +47,21 @@
     "commander": "^9.3.0"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.30.5",
-    "c8": "^7.11.3",
-    "dependency-cruiser": "^11.11.0",
-    "esbuild": "^0.14.48",
-    "eslint": "^8.19.0",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.0.6",
+    "@typescript-eslint/eslint-plugin": "^5.30.7",
+    "c8": "^7.12.0",
+    "dependency-cruiser": "^11.12.0",
+    "esbuild": "^0.14.49",
+    "eslint": "^8.20.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.0.5",
+    "eslint-plugin-mocha": "^10.1.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-security": "^1.5.0",
-    "eslint-plugin-unicorn": "^43.0.1",
+    "eslint-plugin-unicorn": "^43.0.2",
     "mocha": "^10.0.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.7.1",
@@ -76,21 +78,22 @@
     "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 --config",
-    "depcruise:graph": "depcruise src --include-only '^(src)' --config --output-type dot | dot -T svg | tee docs/dependency-graph.svg | depcruise-wrap-stream-in-html > docs/dependency-graph.html",
+    "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 --include-only '^(src)' --focus \"$(node src/cli.mjs main -T regex)\" --prefix vscode://file/$(pwd)/ --config --output-type dot | dot -T svg | depcruise-wrap-stream-in-html | browser",
-    "depcruise:graph:diff:mermaid": "depcruise src --include-only '^(src)' --config --output-type mermaid --output-to - --focus \"$(node src/cli.mjs $SHA -T regex)\"",
+    "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",
-    "lint": "npm-run-all --parallel --aggregate-output lint:format lint:eslint",
+    "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 --cache --cache-location node_modules/.cache/eslint/",
-    "lint:eslint:fix": "eslint src 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:format": "prettier --check \"{src,tools}/**/*.mjs\" \"types/**/*.ts\" \"*.{json,yml,md,js}\"",
     "lint:format:fix": "prettier --loglevel warn --write \"{src,tools}/**/*.mjs\" \"types/**/*.ts\" \"*.{json,yml,md,js}\"",
+    "lint:types": "tsc",
     "scm:stage": "git add .",
     "version": "npm-run-all --sequential clean build lint depcruise:graph scm:stage"
   },

package/src/cli.mjs

@@ -2,7 +2,7 @@
 /* eslint-disable no-console */
 
 import { program } from "commander";
-import { list } from "./main.mjs";
+import { listSync } from "./main.mjs";
 import { VERSION } from "./version.mjs";
 
 program
@@ -17,7 +17,7 @@ program
   .parse(process.argv);
 
 try {
-  console.log(list(program.args[0], program.opts()));
+  console.log(listSync(program.args[0], program.opts()));
 } catch (pError) {
   console.error(`ERROR: ${pError.message}`);
 }

package/src/formatters/regex.mjs

@@ -1,34 +1,47 @@
 import { extname } from "node:path";
 
+const DEFAULT_EXTENSIONS = new Set([
+  ".cjs",
+  ".cjsx",
+  ".coffee",
+  ".csx",
+  ".js",
+  ".json",
+  ".jsx",
+  ".litcoffee",
+  ".ls",
+  ".mjs",
+  ".svelte",
+  ".ts",
+  ".tsx",
+  ".vue",
+  ".vuex",
+]);
+
+const DEFAULT_CHANGE_TYPES = new Set([
+  "modified",
+  "added",
+  "renamed",
+  "copied",
+  "untracked",
+]);
 /**
  *
  * @param {import('../types/watskeburt').IChange[]} pChanges
- * @param {string[]} pExtensions
- * @param {import('../types/watskeburt').changeTypeType[]} pChangeTypes
+ * @param {Set<string>} pExtensions
+ * @param {Set<import('../types/watskeburt').changeTypeType>} pChangeTypes
  * @return {string}
  */
 export default function formatToRegex(
   pChanges,
-  pExtensions = [
-    ".js",
-    ".jsx",
-    ".mjs",
-    ".cjs",
-    ".ts",
-    ".tsx",
-    ".vue",
-    ".vuex",
-    ".json",
-  ],
-  pChangeTypes = ["modified", "added", "renamed", "copied", "untracked"]
+  pExtensions = DEFAULT_EXTENSIONS,
+  pChangeTypes = DEFAULT_CHANGE_TYPES
 ) {
   const lChanges = pChanges
-    .filter((pChange) => pChangeTypes.includes(pChange.changeType))
-    .map(
-      // .replace(/\./g, "\\\\.")
-      ({ name }) => name
-    )
-    .filter((pName) => pExtensions.includes(extname(pName)))
+    .filter((pChange) => pChangeTypes.has(pChange.changeType))
+    .map(({ name }) => name)
+    .filter((pName) => pExtensions.has(extname(pName)))
+    // .replace(/\./g, "\\\\.")
     .join("|");
   return `^(${lChanges})$`;
 }

package/src/main.mjs

@@ -5,14 +5,14 @@ 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();
+/** @type {import("../types/watskeburt").listSync} */
+export function listSync(pOldRevision, pOptions) {
+  const lOldRevision = pOldRevision || getSHA1();
   let lChanges = convertDiffLines(getDiffLines(lOldRevision));
   const lOptions = pOptions || {};
 

package/src/version.mjs

@@ -1 +1 @@
-export const VERSION = "0.4.0";
+export const VERSION = "0.6.0";

package/types/watskeburt.d.ts

@@ -32,7 +32,7 @@ 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;
   /**
@@ -47,21 +47,21 @@ export interface IOptions {
 /**
  * returns a list of files changed since pOldRevision.
  *
- * @param pOldRevision the revision against which to compare. E.g. a commit-hash,
+ * @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 pOptions Options that influence how the changes are returned and that
  *                 filter what is returned and
  * @throws {Error}
  */
-export function list(
+export type listSync = (
   pOldRevision?: string,
   pOptions?: IOptions
-): IChange[] | string;
+) => IChange[] | string;
 
 /**
  * Returns the SHA1 of the current HEAD
  *
  * @throws {Error}
  */
-export function getSHA(): string;
+export type getSHASync = () => string;

package/src/.eslintrc.json

@@ -1,47 +0,0 @@
-{
-  "root": true,
-  "extends": ["moving-meadow"],
-  "overrides": [
-    {
-      "files": ["**/*.mjs"],
-      "rules": {
-        "unicorn/no-null": "off",
-        "unicorn/prefer-spread": "off",
-        "node/no-unsupported-features/es-syntax": "off",
-        "import/no-relative-parent-imports": "off",
-        "sort-imports": "off",
-        "unicorn/prefer-node-protocol": "error",
-        "unicorn/prefer-module": "error"
-      },
-      "parserOptions": {
-        "ecmaVersion": "latest"
-      }
-    },
-    {
-      "files": ["**/*.spec.mjs"],
-      "env": {
-        "mocha": true
-      },
-      "rules": {
-        "no-magic-numbers": "off",
-        "security/detect-non-literal-require": "off",
-        "security/detect-non-literal-fs-filename": "off",
-        "max-lines-per-function": "off",
-        "max-lines": "off",
-        "no-null": "off"
-      }
-    },
-    {
-      "files": ["types/*.ts"],
-      "plugins": ["@typescript-eslint"],
-      "extends": ["plugin:@typescript-eslint/recommended"],
-      "parser": "@typescript-eslint/parser",
-      "parserOptions": {
-        "ecmaVersion": "latest"
-      },
-      "rules": {
-        "node/no-unsupported-features/es-syntax": "off"
-      }
-    }
-  ]
-}