watskeburt 0.11.0 → 0.11.1

package/README.md

@@ -35,13 +35,14 @@ console.log(getSHASync());
 // files not staged for commit and files not under revision control)
 /** @type {import('watskeburt').IChange[]} */
 const lChangedFiles = await list("main");
-// or, with the sync interface:
+// or with the synchronous interface:
 // const lChangedFiles = listSync("main");
 
 // list all files that differ between 'v0.6.1' and 'v0.7.1' (by definition
 // won't include files staged for commit and/ or not under revision control)
 /** @type {import('watskeburt').IChange[]} */
 const lChangedFiles = await list("v0.6.1", "v0.7.1");
+// or with the synchronous interface:
 // const lChangedFiles = listSync("v0.6.1", "v0.7.1");
 
 // As a third parameter you can pass some options
@@ -52,8 +53,8 @@ const lChangedFiles = await list("main", null, {
   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)
 });
-// or with synchronous code:
-// const lChangedFiles = listSynd("main", null, {
+// or with the synchronous interface:
+// const lChangedFiles = listSync("main", null, {
 //   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)
 // });

package/bin/version.js

@@ -1,2 +1,2 @@
 // generated by tools/get-version.ts - edits will be overwritten
-export const VERSION = "0.11.0";
+export const VERSION = "0.11.1";

package/dist/esm/convert-to-change-object.js

@@ -1,7 +1,3 @@
-// the security (and unicorn) plugins don't seem to detect named caption
-// groups very well - false-flagging below regular expressions to be susceptible
-// to redos  attacks.
-/* eslint-disable unicorn/no-unsafe-regex, security/detect-unsafe-regex */
 import { EOL } from "node:os";
 const DIFF_NAME_STATUS_LINE_PATTERN = /^(?<changeType>[ACDMRTUXB])(?<similarity>[0-9]{3})?[ \t]+(?<name>[^ \t]+)[ \t]*(?<newName>[^ \t]+)?$/;
 const DIFF_SHORT_STATUS_LINE_PATTERN = /^(?<stagedChangeType>[ ACDMRTUXB?!])(?<unStagedChangeType>[ ACDMRTUXB?!])[ \t]+(?<name>[^ \t]+)(( -> )(?<newName>[^ \t]+))?$/;
@@ -17,10 +13,8 @@ const CHANGE_CHAR_2_CHANGE_TYPE = {
     " ": "unmodified",
     "?": "untracked",
     "!": "ignored",
-    // X: "unknown"
 };
 function changeChar2ChangeType(pChar) {
-    // eslint-disable-next-line security/detect-object-injection
     return CHANGE_CHAR_2_CHANGE_TYPE[pChar] ?? "unknown";
 }
 export function convertStatusLine(pString) {

package/dist/esm/formatters/regex.js

@@ -30,7 +30,6 @@ export default function formatToRegex(pChanges, pExtensions = DEFAULT_EXTENSIONS
         .filter((pChange) => pChangeTypes.has(pChange.changeType))
         .map(({ name }) => name)
         .filter((pName) => pExtensions.has(extname(pName)))
-        // .replace(/\./g, "\\\\.")
         .join("|");
     return `^(${lChanges})$`;
 }

package/dist/esm/git-primitives-sync.js

@@ -7,7 +7,6 @@ function stringifyOutStream(pError) {
         return pError;
     }
 }
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function throwSpawnError(pError) {
     if (pError.code === "ENOENT") {
         throw new Error("git executable not found");
@@ -16,13 +15,9 @@ function throwSpawnError(pError) {
         throw new Error(`internal spawn error: ${pError}`);
     }
 }
-/**
- * @throws {Error}
- */
 function getGitResultSync(pArguments, pErrorMap, pSpawnFunction) {
     const lGitResult = pSpawnFunction("git", pArguments, {
         cwd: process.cwd(),
-        // eslint-disable-next-line node/no-process-env
         env: process.env,
     });
     if (lGitResult.error) {
@@ -36,19 +31,12 @@ function getGitResultSync(pArguments, pErrorMap, pSpawnFunction) {
             `internal git error: ${lGitResult.status} (${stringifyOutStream(lGitResult.stderr)})`);
     }
 }
-/**
- * @throws {Error}
- */
 export function getStatusShortSync(pSpawnFunction = spawnSync) {
     const lErrorMap = {
         129: `'${process.cwd()}' does not seem to be a git repository`,
     };
     return getGitResultSync(["status", "--porcelain"], lErrorMap, pSpawnFunction);
 }
-/**
- *
- * @throws {Error}
- */
 export function getDiffLinesSync(pOldRevision, pNewRevision, pSpawnFunction = spawnSync) {
     const lErrorMap = {
         128: `revision '${pOldRevision}' ${pNewRevision ? `(or '${pNewRevision}') ` : ""}unknown`,

package/dist/esm/git-primitives.js

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import { spawn } from "node:child_process";
 function stringifyOutStream(pBufferOrString) {
     if (pBufferOrString instanceof Buffer) {
@@ -8,13 +7,9 @@ function stringifyOutStream(pBufferOrString) {
         return pBufferOrString;
     }
 }
-/**
- * @throws {Error}
- */
 function getGitResult(pArguments, pErrorMap, pSpawnFunction) {
     const lGit = pSpawnFunction("git", pArguments, {
         cwd: process.cwd(),
-        // eslint-disable-next-line node/no-process-env
         env: process.env,
     });
     let lStdOutData = "";
@@ -45,9 +40,6 @@ function getGitResult(pArguments, pErrorMap, pSpawnFunction) {
         });
     });
 }
-/**
- * @throws {Error}
- */
 export async function getStatusShort(pSpawnFunction = spawn) {
     const lErrorMap = {
         129: `'${process.cwd()}' does not seem to be a git repository`,
@@ -55,10 +47,6 @@ export async function getStatusShort(pSpawnFunction = spawn) {
     const lResult = await getGitResult(["status", "--porcelain"], lErrorMap, pSpawnFunction);
     return lResult;
 }
-/**
- *
- * @throws {Error}
- */
 export async function getDiffLines(pOldRevision, pNewRevision, pSpawnFunction = spawn) {
     const lErrorMap = {
         128: `revision '${pOldRevision}' ${pNewRevision ? `(or '${pNewRevision}') ` : ""}unknown`,

package/dist/esm/main.js

@@ -16,7 +16,7 @@ export async function list(pOldRevision, pNewRevision, pOptions) {
     const lOptions = pOptions || {};
     const [lDiffLines, lStatusLines] = await Promise.all([
         getDiffLines(lOldRevision, pNewRevision),
-        lOptions.trackedOnly ? "" : getStatusShort(),
+        !lOptions.trackedOnly ? getStatusShort() : "",
     ]);
     let lChanges = convertDiffLines(lDiffLines);
     if (!lOptions.trackedOnly) {

package/package.json

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