watskeburt 2.0.5 → 3.0.0

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/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.5";
+export const VERSION = "3.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watskeburt",
-  "version": "2.0.5",
+  "version": "3.0.0",
   "description": "List files changed since a git revision",
   "keywords": [
     "git",

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