watskeburt 0.11.3 → 0.11.4

package/dist/esm/version.js

@@ -1 +1 @@
-export const VERSION = "0.11.3";
+export const VERSION = "0.11.4";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watskeburt",
-  "version": "0.11.3",
+  "version": "0.11.4",
   "description": "List files changed since a git revision",
   "keywords": [
     "git",
@@ -45,12 +45,12 @@
   ],
   "devDependencies": {
     "@types/mocha": "10.0.1",
-    "@types/node": "20.2.5",
-    "@typescript-eslint/eslint-plugin": "5.59.7",
-    "c8": "7.14.0",
-    "dependency-cruiser": "13.0.2",
-    "esbuild": "0.17.19",
-    "eslint": "8.41.0",
+    "@types/node": "20.3.1",
+    "@typescript-eslint/eslint-plugin": "5.59.11",
+    "c8": "8.0.0",
+    "dependency-cruiser": "13.0.3",
+    "esbuild": "0.18.4",
+    "eslint": "8.43.0",
     "eslint-config-moving-meadow": "4.0.2",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-budapestian": "5.0.1",
@@ -64,8 +64,8 @@
     "npm-run-all": "4.1.5",
     "prettier": "2.8.8",
     "ts-node": "10.9.1",
-    "typescript": "5.0.4",
-    "upem": "7.3.2"
+    "typescript": "5.1.3",
+    "upem": "8.0.0"
   },
   "engines": {
     "node": "^16.19||^18.11||>=20"

package/types/watskeburt.d.ts

@@ -29,12 +29,12 @@ export interface IChange {
 
 export type outputTypeType = "regex" | "json" | "object";
 
-export interface IOptions {
+export interface IFormatOptions {
   /**
    * The type of output to deliver. Defaults to "object" - in which case
    * the listSync function returns an IChange[] object
    */
-  outputType?: outputTypeType;
+  outputType: "regex" | "json";
   /**
    * When true _only_ takes already tracked files into account.
    * When false also takes untracked files into account.
@@ -44,6 +44,23 @@ export interface IOptions {
   trackedOnly?: boolean;
 }
 
+export interface IInternalOptions {
+  /**
+   * The type of output to deliver. Defaults to "object" - in which case
+   * the listSync function returns an IChange[] object
+   */
+  outputType?: "object";
+  /**
+   * When true _only_ takes already tracked files into account.
+   * When false also takes untracked files into account.
+   *
+   * Defaults to false.
+   */
+  trackedOnly?: boolean;
+}
+
+export type IOptions = IFormatOptions | IInternalOptions;
+
 /**
  * returns a list of files changed since pOldRevision.
  *
@@ -59,11 +76,49 @@ export interface IOptions {
 export function listSync(
   pOldRevision?: string,
   pNewRevision?: string,
-  pOptions?: IOptions
-): IChange[] | string;
+  pOptions?: IInternalOptions
+): IChange[];
 
 /**
- * returns a list of files changed since pOldRevision.
+ * returns a list of files changed since pOldRevision formatted into a string
+ * as 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 listSync(
+  pOldRevision?: string,
+  pNewRevision?: string,
+  pOptions?: IFormatOptions
+): string;
+
+/**
+ * returns 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[]>;
+
+/**
+ * returns promise 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_
@@ -77,8 +132,8 @@ export function listSync(
 export function list(
   pOldRevision?: string,
   pNewRevision?: string,
-  pOptions?: IOptions
-): Promise<IChange[] | string>;
+  pOptions?: IFormatOptions
+): Promise<string>;
 
 /**
  * Returns the SHA1 of the current HEAD