watskeburt 0.3.0 → 0.4.0

package/README.md

@@ -40,16 +40,17 @@ source files in the JavaScript ecosystem (.js, .mjs, .ts, .tsx ...) that can
 be used in e.g. the `--focus` filter of dependency-cruiser:
 
 ```
-Usage: cli [options] <revision>
+Usage: cli [options] [revision]
 
-lists files & their statuses since <revision>
+lists files & their statuses since [revision].
 
-Options:
--V, --version output the version number
--T, --output-type <type> json,regex (default: "regex")
---tracked-only only take tracked files into account (default: false)
--h, --help display help for command
+-> When you don't pass a revision the revision defaults to the current one.
 
+Options:
+  -V, --version             output the version number
+  -T, --output-type <type>  json,regex (default: "regex")
+  --tracked-only            only take tracked files into account (default: false)
+  -h, --help                display help for command
 ```
 
 ### :scroll: API
@@ -75,7 +76,6 @@ An array of changes looks something like this:
     name: "test/thing.spec.mjs",
     changeType: "renamed",
     oldName: "test/old-thing.spec.mjs",
-    similarity: 66,
   },
   { name: "src/not-tracked-yet.mjs", changeType: "untracked" },
 ];

package/dist/cjs-bundle.js

@@ -1 +1 @@
-var i=Object.defineProperty;var y=Object.getOwnPropertyDescriptor;var w=Object.getOwnPropertyNames;var x=Object.prototype.hasOwnProperty;var E=(e,t)=>{for(var n in t)i(e,n,{get:t[n],enumerable:!0})},C=(e,t,n,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of w(t))!x.call(e,o)&&o!==n&&i(e,o,{get:()=>t[o],enumerable:!(r=y(t,o))||r.enumerable});return e};var A=e=>C(i({},"__esModule",{value:!0}),e);var M={};E(M,{getSHA:()=>B,list:()=>j});module.exports=A(M);var u=require("os"),_=/^(?<changeType>[ACDMRTUXB])(?<similarity>[0-9]{3})?[ \t]+(?<name>[^ \t]+)[ \t]*(?<newName>[^ \t]+)?$/,D=/^(?<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 s(e){return R[e]||"unknown"}function L(e){let t=e.match(D),n={};if(t){let r=s(t.groups.stagedChangeType),o=s(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 U(e){let t=e.match(_),n={};return t&&(n.changeType=s(t.groups.changeType),t.groups.similarity&&(n.similarity=Number.parseInt(t.groups.similarity,10)),t.groups.newName?(n.name=t.groups.newName,n.oldName=t.groups.name):n.name=t.groups.name),n}function l(e){return e.split(u.EOL).filter(Boolean).map(L).filter(({changeType:t})=>Boolean(t))}function g(e){return e.split(u.EOL).filter(Boolean).map(U).filter(({changeType:t})=>Boolean(t))}var a=require("child_process");function d(e){return e instanceof Buffer?e.toString("utf8"):e}function O(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&&O(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 v={regex:f,json:p,object:e=>e},$="object";function m(e,t){return v[t||$](e)}function j(e,t){let n=g(h(e)),r=t||{};return r.trackedOnly||(n=n.concat(l(T()).filter(({changeType:o})=>o==="untracked"))),m(n,r.outputType)}function B(){return S()}0&&(module.exports={getSHA,list});
+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});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watskeburt",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "List files changed since a git revision",
   "keywords": [
     "git",
@@ -62,7 +62,8 @@
     "eslint-plugin-unicorn": "^43.0.1",
     "mocha": "^10.0.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.7.1"
+    "prettier": "^2.7.1",
+    "typescript": "^4.7.4"
   },
   "engines": {
     "node": "^12.20||^14||>=16"
@@ -71,6 +72,7 @@
     "build": "npm-run-all --sequential build:version build:dist",
     "build:version": "node tools/get-version.mjs > src/version.mjs",
     "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",

package/src/cli.mjs

@@ -6,19 +6,18 @@ import { list } from "./main.mjs";
 import { VERSION } from "./version.mjs";
 
 program
-  .description("lists files & their statuses since <revision>")
+  .description(
+    "lists files & their statuses since [revision].\n\n" +
+      "-> When you don't pass a revision the 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("[revision]")
   .parse(process.argv);
 
-if (program.args[0]) {
-  try {
-    console.log(list(program.args[0], program.opts()));
-  } catch (pError) {
-    console.error(`ERROR: ${pError.message}`);
-  }
-} else {
-  program.help();
+try {
+  console.log(list(program.args[0], program.opts()));
+} catch (pError) {
+  console.error(`ERROR: ${pError.message}`);
 }

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

@@ -76,12 +76,6 @@ export function convertDiffLine(pString) {
     lReturnValue.changeType = changeChar2ChangeType(
       lMatchResult.groups.changeType
     );
-    if (lMatchResult.groups.similarity) {
-      lReturnValue.similarity = Number.parseInt(
-        lMatchResult.groups.similarity,
-        10
-      );
-    }
     if (lMatchResult.groups.newName) {
       lReturnValue.name = lMatchResult.groups.newName;
       lReturnValue.oldName = lMatchResult.groups.name;

package/src/main.mjs

@@ -5,9 +5,15 @@ import {
 import { getDiffLines, getSHA1, getStatusShort } from "./git-primitives.mjs";
 import format from "./formatters/format.mjs";
 
+/** @type {import("../types/watskeburt.js").getSHA} */
+export function getSHA() {
+  return getSHA1();
+}
+
 /** @type {import("../types/watskeburt.js").list} */
 export function list(pOldRevision, pOptions) {
-  let lChanges = convertDiffLines(getDiffLines(pOldRevision));
+  const lOldRevision = pOldRevision || getSHA();
+  let lChanges = convertDiffLines(getDiffLines(lOldRevision));
   const lOptions = pOptions || {};
 
   if (!lOptions.trackedOnly) {
@@ -19,8 +25,3 @@ export function list(pOldRevision, pOptions) {
   }
   return format(lChanges, lOptions.outputType);
 }
-
-/** @type {import("../types/watskeburt.js").getSHA} */
-export function getSHA() {
-  return getSHA1();
-}

package/src/version.mjs

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

package/types/watskeburt.d.ts

@@ -21,10 +21,6 @@ export interface IChange {
    * how the file was changed
    */
   changeType: changeTypeType;
-  /**
-   * if the file was renamed: the % of similarity (range: 0 - 100)
-   */
-  similarity?: Number;
   /**
    * if the file was renamed: what the old file's name was
    */
@@ -52,14 +48,15 @@ export interface IOptions {
  * 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.
+ *                 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(
-  pOldRevision: string,
-  pOptions: IOptions
+  pOldRevision?: string,
+  pOptions?: IOptions
 ): IChange[] | string;
 
 /**