watskeburt 2.0.4 → 3.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022-2023 Sander Verweij
+Copyright (c) 2022-2024 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

@@ -37,11 +37,11 @@ const lChangedFiles = await list("main");
 /** @type {import('watskeburt').IChange[]} */
 const lChangedFiles = await list("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 = await list("main", null, {
+const lChangedFiles = await list({
+  oldRevision: "main",
+  // this compares the working tree with the oldRevision. If you want to compare
+  // to another branch or revision you can pass that in a `newRevision` field
   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)
 });
@@ -69,8 +69,7 @@ The array of changes this returns looks like this:
 
 ### :shell: cli
 
-For now there's also a simple command line interface (which works from node ^16.19 and
-node >=18.11).
+There's also a simple command line interface (which works from node >=18.11).
 
 ```shell
 # list all JavaScript-ish files changed since main in a regular expression

package/dist/cli.js

@@ -36,11 +36,11 @@ export async function cli(
       process.exitCode = pErrorExitCode;
       return;
     }
-    const lResult = await list(
-      lArguments.positionals[0],
-      lArguments.positionals[1],
-      lArguments.values,
-    );
+    const lResult = await list({
+      ...lArguments.values,
+      oldRevision: lArguments.positionals[0],
+      newRevision: lArguments.positionals[1],
+    });
     pOutStream.write(`${lResult}${EOL}`);
   } catch (pError) {
     pErrorStream.write(`${EOL}ERROR: ${pError.message}${EOL}${EOL}`);

package/dist/git-primitives.js

@@ -18,9 +18,7 @@ export async function getDiffLines(
   const lErrorMap = new Map([
     [
       128,
-      `revision '${pOldRevision}' ${
-        pNewRevision ? `(or '${pNewRevision}') ` : ""
-      }unknown`,
+      `revision '${pOldRevision}' ${pNewRevision ? `(or '${pNewRevision}') ` : ""}unknown`,
     ],
     [129, `'${process.cwd()}' does not seem to be a git repository`],
   ]);
@@ -63,9 +61,7 @@ function getGitResult(pArguments, pErrorMap, pSpawnFunction) {
         pReject(
           new Error(
             pErrorMap.get(pCode ?? 0) ||
-              `internal git error: ${pCode} (${stringifyOutStream(
-                lStdErrorData,
-              )})`,
+              `internal git error: ${pCode} (${stringifyOutStream(lStdErrorData)})`,
           ),
         );
       }

package/dist/main.js

@@ -2,11 +2,11 @@ import { parseDiffLines } from "./parse-diff-lines.js";
 import { parseStatusLines } from "./parse-status-lines.js";
 import * as primitives from "./git-primitives.js";
 import format from "./formatters/format.js";
-export async function list(pOldRevision, pNewRevision, pOptions) {
-  const lOldRevision = pOldRevision || (await primitives.getSHA());
+export async function list(pOptions) {
+  const lOldRevision = pOptions?.oldRevision || (await primitives.getSHA());
   const lOptions = pOptions || {};
   const [lDiffLines, lStatusLines] = await Promise.all([
-    primitives.getDiffLines(lOldRevision, pNewRevision),
+    primitives.getDiffLines(lOldRevision, pOptions?.newRevision),
     !lOptions.trackedOnly ? primitives.getStatusShort() : "",
   ]);
   let lChanges = parseDiffLines(lDiffLines);

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "2.0.4";
+export const VERSION = "3.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watskeburt",
-  "version": "2.0.4",
+  "version": "3.0.0",
   "description": "List files changed since a git revision",
   "keywords": [
     "git",
@@ -44,62 +44,10 @@
     "package.json",
     "README.md"
   ],
-  "devDependencies": {
-    "@types/node": "20.10.5",
-    "@typescript-eslint/eslint-plugin": "6.16.0",
-    "c8": "8.0.1",
-    "dependency-cruiser": "15.5.0",
-    "eslint": "8.56.0",
-    "eslint-config-moving-meadow": "4.0.2",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-budapestian": "6.0.0",
-    "eslint-plugin-eslint-comments": "3.2.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-mocha": "10.2.0",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-security": "2.1.0",
-    "eslint-plugin-unicorn": "50.0.1",
-    "npm-run-all": "4.1.5",
-    "prettier": "3.1.1",
-    "tsx": "4.7.0",
-    "typescript": "5.3.3",
-    "upem": "9.0.2"
-  },
   "engines": {
     "node": "^18||>=20"
   },
   "scripts": {
-    "build": "npm-run-all --sequential build:clean build:version build:dist build:format",
-    "build:version": "tsx tools/get-version.ts > src/version.ts",
-    "build:clean": "rm -rf dist/*",
-    "build:dist": "tsc",
-    "build:format": "prettier --log-level warn --write dist/",
-    "check": "npm-run-all --parallel --aggregate-output lint depcruise test:cover",
-    "clean": "rm -rf dist",
-    "test": "tsx --test-reporter ./tools/dot-with-summary.reporter.js --test src/*.spec.ts src/**/*.spec.ts",
-    "test:cover": "c8 npm test",
-    "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/run-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/run-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 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",
-    "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"
+    "test": "echo for test, build and static analysis scripts: see the github repository"
   }
 }

package/types/watskeburt.d.ts

@@ -29,12 +29,18 @@ export interface IChange {
 
 export type outputTypeType = "regex" | "json" | "object";
 
-export interface IFormatOptions {
+export interface IBaseOptions {
   /**
-   * The type of output to deliver. Defaults to "object" - in which case
-   * the listSync function returns an IChange[] object
+   * 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)
    */
-  outputType: "regex" | "json";
+  oldRevision?: string;
+  /**
+   * Newer revision against which to compare. Leave out or pass
+   * null when you want to compare against the working tree
+   */
+  newRevision?: string;
   /**
    * When true _only_ takes already tracked files into account.
    * When false also takes untracked files into account.
@@ -44,59 +50,38 @@ export interface IFormatOptions {
   trackedOnly?: boolean;
 }
 
-export interface IInternalOptions {
+export interface IFormatOptions extends IBaseOptions {
   /**
    * The type of output to deliver. Defaults to "object" - in which case
    * the listSync function returns an IChange[] object
    */
-  outputType?: "object";
+  outputType: "regex" | "json";
+}
+
+export interface IInternalOptions extends IBaseOptions {
   /**
-   * When true _only_ takes already tracked files into account.
-   * When false also takes untracked files into account.
-   *
-   * Defaults to false.
+   * The type of output to deliver. Defaults to "object" - in which case
+   * the listSync function returns an IChange[] object
    */
-  trackedOnly?: boolean;
+  outputType?: "object";
 }
 
 export type IOptions = IFormatOptions | IInternalOptions;
 
 /**
- * returns promise of a list of files changed since pOldRevision.
+ * returns a promise of 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 list(
-  pOldRevision?: string,
-  pNewRevision?: string,
-  pOptions?: IInternalOptions,
-): Promise<IChange[]>;
+export function list(pOptions?: IInternalOptions): Promise<IChange[]>;
 
 /**
- * returns promise a list of files changed since pOldRevision, formatted into a
- * string as a pOptions.outputType
+ * returns a promise of a list of files changed since pOldRevision, formatted
+ * into a string as a 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 list(
-  pOldRevision?: string,
-  pNewRevision?: string,
-  pOptions?: IFormatOptions,
-): Promise<string>;
+export function list(pOptions?: IFormatOptions): Promise<string>;
 
 /**
  * Returns the SHA1 of the current HEAD