ts-repo-utils 6.2.0 → 7.0.1

package/README.md

@@ -86,9 +86,9 @@ npm exec -- format-uncommitted --silent
 
 **Options:**
 
-- `--exclude-untracked` - Exclude untracked files in addition to diff files (default: false)
-- `--exclude-modified` - Exclude modified files in addition to diff files (default: false)
-- `--exclude-staged` - Exclude staged files in addition to diff files (default: false)
+- `--exclude-untracked` - Exclude untracked files (default: false)
+- `--exclude-modified` - Exclude modified files (default: false)
+- `--exclude-staged` - Exclude staged files (default: false)
 - `--silent` - Suppress output messages (default: false)
 
 ### `format-diff-from`
@@ -115,9 +115,9 @@ npm exec -- format-diff-from main --silent
 **Options:**
 
 - `<base>` - Base branch name or commit hash to compare against (required)
-- `--exclude-untracked` - Exclude untracked files in addition to diff files (default: false)
-- `--exclude-modified` - Exclude modified files in addition to diff files (default: false)
-- `--exclude-staged` - Exclude staged files in addition to diff files (default: false)
+- `--exclude-untracked` - Exclude untracked files (default: false)
+- `--exclude-modified` - Exclude modified files (default: false)
+- `--exclude-staged` - Exclude staged files (default: false)
 - `--silent` - Suppress output messages (default: false)
 
 ### `check-should-run-type-checks`
@@ -283,9 +283,49 @@ import { assertRepoIsClean } from 'ts-repo-utils';
 await assertRepoIsClean();
 ```
 
+**Options:**
+
+- `silent?` - Suppress output messages (default: false)
+
+#### Getting Git diff files
+
+##### `getUntrackedFiles(options?)`
+
+Get untracked files from the working tree (files not added to git).  
+Runs `git ls-files --others --exclude-standard [--deleted]`
+
+##### `getModifiedFiles(options?)`
+
+Get modified files from the working tree (files that have been changed but not staged).  
+Runs `git diff --name-only [--diff-filter=d]`
+
+##### `getStagedFiles(options?)`
+
+Get files that are staged for commit (files added with git add).  
+Runs `git diff --staged --name-only [--diff-filter=d]`
+
+##### `getDiffFrom(base: string, options?)`
+
+Get files that differ from the specified base branch or commit.  
+Runs `git diff --name-only <base> [--diff-filter=d]`
+
+**Common options:**
+
+- `excludeDeleted?: boolean` - Exclude deleted files (for formatters etc.) (default: true)
+- `silent?: boolean` - Don't log command/output (default: false)
+
+**Common Return Type:**
+
+```typescript
+type Ret = Result<
+    readonly string[],
+    ExecException | Readonly<{ message: string }>
+>;
+```
+
 ### Command Execution
 
-#### `$(command: string, options?: { silent?: boolean; timeout?: number }): Promise<ExecResult>`
+#### `$(command: string, options?: ExecOptions): Promise<ExecResult>`
 
 Executes a shell command asynchronously with timeout support and type-safe results.
 
@@ -304,45 +344,69 @@ if (result.type === 'ok') {
 **Options:**
 
 - `silent?: boolean` - Don't log command/output (default: false)
-- `timeout?: number` - Timeout in milliseconds (default: 30000)
+- `'node:child_process'` `exec` function options
 
 **Return Type:**
 
 ```typescript
-type ExecResult = Readonly<
-    | { type: 'ok'; stdout: string; stderr: string }
-    | { type: 'error'; exception: ExecException }
+type Ret = Promise<
+    Result<
+        Readonly<{ stdout: string | Buffer; stderr: string | Buffer }>,
+        import('node:child_process').ExecException
+    >
 >;
 ```
 
 ### Code Formatting Utilities
 
-#### `formatFiles(pathGlob: string): Promise<'ok' | 'err'>`
+#### `formatFilesGlob(pathGlob: string): Promise<Result<undefined, unknown>>`
 
 Format files matching a glob pattern using Prettier.
 
 ```typescript
-import { formatFiles } from 'ts-repo-utils';
+import { formatFilesGlob } from 'ts-repo-utils';
 
 // Format all TypeScript files in src
-await formatFiles('src/**/*.ts');
+await formatFilesGlob('src/**/*.ts');
 
 // Format specific files
-await formatFiles('src/{index,utils}.ts');
+await formatFilesGlob('src/{index,utils}.ts');
 ```
 
-#### `formatUntracked(): Promise<'ok' | 'err'>`
+**Options:**
+
+- `silent?` - Suppress output messages (default: false)
+
+#### `formatUncommittedFiles(): Promise<Result>`
 
 Format only files that have been changed according to git status.
 
 ```typescript
-import { formatUntracked } from 'ts-repo-utils';
+import { formatUncommittedFiles } from 'ts-repo-utils';
 
 // Format only modified files
-await formatUntracked();
+await formatUncommittedFiles();
 ```
 
-#### `formatDiffFrom(base: string): Promise<'ok' | 'err'>`
+**Options:**
+
+- `untracked?` - Format untracked files (default: true)
+- `modified?` - Format modified files (default: true)
+- `staged?` - Format staged files (default: true)
+- `silent?` - Suppress output messages (default: false)
+
+**Return Type:**
+
+```typescript
+type Ret = Promise<
+    Result<
+        undefined,
+        ExecException | Readonly<{ message: string }> | readonly unknown[]
+    >
+>;
+```
+
+#### `formatDiffFrom(base: string): Promise<Result>`
 
 Format only files that differ from the specified base branch or commit.
 
@@ -356,9 +420,27 @@ await formatDiffFrom('main');
 await formatDiffFrom('abc123');
 ```
 
+**Options:**
+
+- `includeUntracked?` - Include untracked files in addition to diff files (default: true)
+- `includeModified?` - Include modified files in addition to diff files (default: true)
+- `includeStaged?` - Include staged files in addition to diff files (default: true)
+- `silent?` - Suppress output messages (default: false)
+
+**Return Type:**
+
+```typescript
+type Ret = Promise<
+    Result<
+        undefined,
+        ExecException | Readonly<{ message: string }> | readonly unknown[]
+    >
+>;
+```
+
 ### Index File Generation
 
-#### `genIndex(config: GenIndexConfig): Promise<void>`
+#### `genIndex(config: GenIndexConfig): Promise<Result<undefined, unknown>>`
 
 Generates index files recursively in target directories with automatic barrel exports.
 
@@ -367,9 +449,7 @@ import { genIndex } from 'ts-repo-utils';
 
 await genIndex({
     targetDirectory: './src',
-    sourceExtension: '.ts',
-    exportExtension: '.js',
-    excludePatterns: ['*.test.ts', '*.spec.ts'],
+    exclude: ['*.test.ts', '*.spec.ts'],
 });
 ```
 
@@ -377,10 +457,41 @@ await genIndex({
 
 ```typescript
 type GenIndexConfig = DeepReadonly<{
-    targetDirectory: string | string[]; // Target directories to generate index files for
-    sourceExtension?: `.${string}`; // File extension of source files (default: '.mts')
-    exportExtension?: `.${string}`; // Extension to use in exports (default: '.mjs')
-    excludePatterns?: string[]; // Glob patterns to exclude (default: excludes .d.* and .test.*)
+    /**
+     * Target directories to generate index files for (string or array of
+     * strings)
+     */
+    targetDirectory: string | readonly string[];
+
+    /**
+     * Glob patterns of files or predicate function to exclude from exports
+     * (default: excludes `'**\/*.{test,spec}.?(c|m)[jt]s?(x)'` and
+     * `'**\/*.d.?(c|m)ts'`)
+     */
+    exclude?:
+        | readonly string[]
+        | ((
+              args: Readonly<{
+                  absolutePath: string;
+                  relativePath: string;
+                  fileName: string;
+              }>,
+          ) => boolean);
+
+    /** File extensions of source files to export (default: ['.ts', '.tsx']) */
+    targetExtensions?: readonly `.${string}`[];
+
+    /** File extension of index files to generate (default: '.ts') */
+    indexFileExtension?: `.${string}`;
+
+    /** File extension to use in export statements (default: '.js') */
+    exportStatementExtension?: `.${string}` | 'none';
+
+    /** Command to run for formatting generated files (optional) */
+    formatCommand?: string;
+
+    /** Whether to suppress output during execution (default: false) */
+    silent?: boolean;
 }>;
 ```
 
@@ -392,6 +503,11 @@ type GenIndexConfig = DeepReadonly<{
 - Works with both single directories and directory arrays
 - Respects source and export extension configuration
 
+**Benefits:**
+
+- Prevents forgetting to export libraries
+- tsc can detect duplicate variables, type names, etc.
+
 ## Key Features
 
 - **Type Safety**: All functions use strict TypeScript types with readonly parameters
@@ -410,14 +526,14 @@ type GenIndexConfig = DeepReadonly<{
 ```typescript
 import { formatUntracked, assertExt, assertRepoIsClean } from 'ts-repo-utils';
 
-// Format changed files
-await formatUntracked();
-
 // Validate file extensions
 await assertExt({
     directories: [{ path: './src', extension: '.ts' }],
 });
 
+// Format changed files
+await formatUncommittedFiles();
+
 // Ensure repository is clean (exits if dirty)
 await assertRepoIsClean();
 ```
@@ -425,7 +541,7 @@ await assertRepoIsClean();
 ### Build Pipeline
 
 ```typescript
-import { assertExt, genIndex, $, formatFiles } from 'ts-repo-utils';
+import { assertExt, genIndex, $, formatFilesGlob } from 'ts-repo-utils';
 
 // Validate extensions
 await assertExt({
@@ -445,7 +561,7 @@ await $('tsc --noEmit');
 await $('rollup -c');
 
 // Format output
-await formatFiles('dist/**/*.js');
+await formatFilesGlob('dist/**/*.js');
 ```
 
 ### Project Validation

package/dist/cmd/assert-repo-is-clean.mjs

@@ -10,7 +10,7 @@ import 'child_process';
 
 const cmdDef = cmd.command({
     name: 'assert-repo-is-clean-cli',
-    version: '6.2.0',
+    version: '7.0.1',
     args: {
         silent: cmd.flag({
             long: 'silent',

package/dist/cmd/check-should-run-type-checks.mjs

@@ -10,7 +10,7 @@ import 'child_process';
 
 const cmdDef = cmd.command({
     name: 'check-should-run-type-checks-cli',
-    version: '6.2.0',
+    version: '7.0.1',
     args: {
         pathsIgnore: cmd.multioption({
             long: 'paths-ignore',

package/dist/cmd/format-diff-from.mjs

@@ -9,7 +9,7 @@ import 'child_process';
 
 const cmdDef = cmd.command({
     name: 'format-diff-from-cli',
-    version: '6.2.0',
+    version: '7.0.1',
     args: {
         base: cmd.positional({
             type: cmd.string,

package/dist/cmd/format-uncommitted.mjs

@@ -9,7 +9,7 @@ import 'child_process';
 
 const cmdDef = cmd.command({
     name: 'format-uncommitted-cli',
-    version: '6.2.0',
+    version: '7.0.1',
     args: {
         excludeUntracked: cmd.flag({
             long: 'exclude-untracked',

package/dist/cmd/gen-index-ts.mjs

@@ -28,7 +28,7 @@ const nonEmptyArray = (t, commandName) => cmd.extendType(cmd.array(t), {
 });
 const cmdDef = cmd.command({
     name: 'gen-index-ts-cli',
-    version: '6.2.0',
+    version: '7.0.1',
     args: {
         // required args
         targetDirectory: cmd.positional({

package/dist/functions/assert-repo-is-clean.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"assert-repo-is-clean.d.mts","sourceRoot":"","sources":["../../src/functions/assert-repo-is-clean.mts"],"names":[],"mappings":"AACA,OAAO,oBAAoB,CAAC;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GACtB,UAAU,QAAQ,CAAC;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,KACvC,OAAO,CAAC,OAAO,CAGjB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAC5B,UAAU,QAAQ,CAAC;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,KACvC,OAAO,CAAC,IAAI,CAiCd,CAAC"}
+{"version":3,"file":"assert-repo-is-clean.d.mts","sourceRoot":"","sources":["../../src/functions/assert-repo-is-clean.mts"],"names":[],"mappings":"AACA,OAAO,oBAAoB,CAAC;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GACtB,UAAU,QAAQ,CAAC;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,KACvC,OAAO,CAAC,OAAO,CAMjB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAC5B,UAAU,QAAQ,CAAC;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,KACvC,OAAO,CAAC,IAAI,CAkCd,CAAC"}

package/dist/functions/assert-repo-is-clean.mjs

@@ -9,41 +9,41 @@ import '../node-global.mjs';
  */
 const repoIsDirty = async (options) => {
     const status = await getGitStatus({ silent: options?.silent ?? false });
-    return status.isDirty;
+    if (Result.isErr(status)) {
+        throw new Error(`Failed to get git status: ${status.value}`);
+    }
+    return status.value.isDirty;
 };
 /**
  * Checks if the repository is clean and exits with code 1 if it is dirty. Shows
  * git status and diff output before exiting.
  */
 const assertRepoIsClean = async (options) => {
-    try {
-        const status = await getGitStatus({ silent: options?.silent ?? false });
-        if (!status.isDirty) {
-            echo('Repo is clean\n');
-            return;
-        }
-        echo('Repo is dirty\n');
-        echo('Changed files:\n');
-        echo(status.stdout);
-        // Show files not tracked by git and unstaged changes
-        const addResult = await $('git add -N .', {
-            silent: options?.silent ?? false,
-        });
-        if (Result.isErr(addResult)) {
-            echo('Warning: Failed to add untracked files for diff\n');
-        }
-        const diffResult = await $('git diff', {
-            silent: options?.silent ?? false,
-        });
-        if (Result.isErr(diffResult)) {
-            echo('Warning: Failed to show diff\n');
-        }
-        process.exit(1);
+    const silent = options?.silent ?? false;
+    const conditionalEcho = silent ? () => { } : echo;
+    const gitStatusResult = await getGitStatus({ silent });
+    if (Result.isErr(gitStatusResult)) {
+        conditionalEcho(gitStatusResult.value);
+        return;
+    }
+    const gitStatus = gitStatusResult.value;
+    if (!gitStatus.isDirty) {
+        conditionalEcho('Repo is clean\n');
+        return;
     }
-    catch (error) {
-        echo(`Error checking repository status: ${String(error)}\n`);
-        process.exit(1);
+    conditionalEcho('Repo is dirty\n');
+    conditionalEcho('Changed files:\n');
+    conditionalEcho(gitStatus.stdout);
+    // Show files not tracked by git and unstaged changes
+    const addResult = await $('git add -N .', { silent });
+    if (Result.isErr(addResult)) {
+        conditionalEcho('Warning: Failed to add untracked files for diff\n');
     }
+    const diffResult = await $('git diff', { silent });
+    if (Result.isErr(diffResult)) {
+        conditionalEcho('Warning: Failed to show diff\n');
+    }
+    process.exit(1);
 };
 /**
  * Gets the git status of the repository.
@@ -55,13 +55,13 @@ const getGitStatus = async (options) => {
         silent: options?.silent ?? false,
     });
     if (Result.isErr(res)) {
-        throw new Error(`Failed to get git status: ${res.value.message}`);
+        return Result.err(`Failed to get git status: ${res.value.message}`);
     }
     const { stdout } = res.value;
-    return {
+    return Result.ok({
         isDirty: stdout.trim() !== '',
         stdout,
-    };
+    });
 };
 
 export { assertRepoIsClean, repoIsDirty };

package/dist/functions/assert-repo-is-clean.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"assert-repo-is-clean.mjs","sources":["../../src/functions/assert-repo-is-clean.mts"],"sourcesContent":[null],"names":[],"mappings":";;;AAGA;;;;;AAKG;MACU,WAAW,GAAG,OACzB,OAAwC,KACpB;AACpB,IAAA,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,EAAE,CAAC;IACvE,OAAO,MAAM,CAAC,OAAO;AACvB;AAEA;;;AAGG;MACU,iBAAiB,GAAG,OAC/B,OAAwC,KACvB;AACjB,IAAA,IAAI;AACF,QAAA,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,EAAE,CAAC;AAEvE,QAAA,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;YACnB,IAAI,CAAC,iBAAiB,CAAC;YACvB;QACF;QAEA,IAAI,CAAC,iBAAiB,CAAC;QACvB,IAAI,CAAC,kBAAkB,CAAC;AACxB,QAAA,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;;AAGnB,QAAA,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,cAAc,EAAE;AACxC,YAAA,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK;AACjC,SAAA,CAAC;AACF,QAAA,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;YAC3B,IAAI,CAAC,mDAAmD,CAAC;QAC3D;AAEA,QAAA,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,UAAU,EAAE;AACrC,YAAA,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK;AACjC,SAAA,CAAC;AACF,QAAA,IAAI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;YAC5B,IAAI,CAAC,gCAAgC,CAAC;QACxC;AAEA,QAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjB;IAAE,OAAO,KAAK,EAAE;QACd,IAAI,CAAC,qCAAqC,MAAM,CAAC,KAAK,CAAC,CAAA,EAAA,CAAI,CAAC;AAC5D,QAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjB;AACF;AAEA;;;;AAIG;AACH,MAAM,YAAY,GAAG,OACnB,OAAwC,KAIrC;AACH,IAAA,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,wBAAwB,EAAE;AAC5C,QAAA,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK;AACjC,KAAA,CAAC;AAEF,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,CAAA,0BAAA,EAA6B,GAAG,CAAC,KAAK,CAAC,OAAO,CAAA,CAAE,CAAC;IACnE;AAEA,IAAA,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,KAAK;IAE5B,OAAO;AACL,QAAA,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE;QAC7B,MAAM;KACP;AACH,CAAC;;;;"}
+{"version":3,"file":"assert-repo-is-clean.mjs","sources":["../../src/functions/assert-repo-is-clean.mts"],"sourcesContent":[null],"names":[],"mappings":";;;AAGA;;;;;AAKG;MACU,WAAW,GAAG,OACzB,OAAwC,KACpB;AACpB,IAAA,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,EAAE,CAAC;AACvE,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,CAAA,0BAAA,EAA6B,MAAM,CAAC,KAAK,CAAA,CAAE,CAAC;IAC9D;AACA,IAAA,OAAO,MAAM,CAAC,KAAK,CAAC,OAAO;AAC7B;AAEA;;;AAGG;MACU,iBAAiB,GAAG,OAC/B,OAAwC,KACvB;AACjB,IAAA,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,KAAK;AACvC,IAAA,MAAM,eAAe,GAAG,MAAM,GAAG,MAAK,EAAE,CAAC,GAAG,IAAI;IAEhD,MAAM,eAAe,GAAG,MAAM,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;AAEtD,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE;AACjC,QAAA,eAAe,CAAC,eAAe,CAAC,KAAK,CAAC;QACtC;IACF;AAEA,IAAA,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK;AAEvC,IAAA,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;QACtB,eAAe,CAAC,iBAAiB,CAAC;QAClC;IACF;IAEA,eAAe,CAAC,iBAAiB,CAAC;IAClC,eAAe,CAAC,kBAAkB,CAAC;AACnC,IAAA,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC;;IAGjC,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,CAAC;AACrD,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;QAC3B,eAAe,CAAC,mDAAmD,CAAC;IACtE;IAEA,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,CAAC;AAClD,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;QAC5B,eAAe,CAAC,gCAAgC,CAAC;IACnD;AAEA,IAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AACjB;AAEA;;;;AAIG;AACH,MAAM,YAAY,GAAG,OACnB,OAAwC,KAStC;AACF,IAAA,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,wBAAwB,EAAE;AAC5C,QAAA,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK;AACjC,KAAA,CAAC;AAEF,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;AACrB,QAAA,OAAO,MAAM,CAAC,GAAG,CAAC,CAAA,0BAAA,EAA6B,GAAG,CAAC,KAAK,CAAC,OAAO,CAAA,CAAE,CAAC;IACrE;AAEA,IAAA,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,KAAK;IAE5B,OAAO,MAAM,CAAC,EAAE,CAAC;AACf,QAAA,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE;QAC7B,MAAM;AACP,KAAA,CAAC;AACJ,CAAC;;;;"}

package/dist/functions/diff.d.mts

@@ -14,8 +14,8 @@ export declare const getUntrackedFiles: (options?: Readonly<{
     message: string;
 }>>>;
 /**
- * Get untracked files from the working tree (files not added to git). Runs `git
- * git diff --staged --name-only [--diff-filter=d]`
+ * Get modified files from the working tree (files that have been changed but
+ * not staged). Runs `git diff --name-only [--diff-filter=d]`
  */
 export declare const getModifiedFiles: (options?: Readonly<{
     /** @default true */

package/dist/functions/diff.mjs

@@ -12,12 +12,12 @@ const getUntrackedFiles = async (options) => cmdResultToFiles({
     options,
 });
 /**
- * Get untracked files from the working tree (files not added to git). Runs `git
- * git diff --staged --name-only [--diff-filter=d]`
+ * Get modified files from the working tree (files that have been changed but
+ * not staged). Runs `git diff --name-only [--diff-filter=d]`
  */
 const getModifiedFiles = async (options) => cmdResultToFiles({
     cmd: `git diff --name-only`,
-    cmdOptionToExcludeDeleted: '--diff-filter=d',
+    cmdOptionToExcludeDeleted: '--diff-filter=d', // lower case 'd' means exclude deleted files
     cmdOptionToIncludeDeleted: '',
     options,
 });
@@ -27,7 +27,7 @@ const getModifiedFiles = async (options) => cmdResultToFiles({
  */
 const getStagedFiles = async (options) => cmdResultToFiles({
     cmd: `git diff --staged --name-only`,
-    cmdOptionToExcludeDeleted: '--diff-filter=d',
+    cmdOptionToExcludeDeleted: '--diff-filter=d', // lower case 'd' means exclude deleted files
     cmdOptionToIncludeDeleted: '',
     options,
 });

package/dist/functions/diff.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"diff.mjs","sources":["../../src/functions/diff.mts"],"sourcesContent":[null],"names":[],"mappings":";;;AAIA;;;AAGG;AACI,MAAM,iBAAiB,GAAG,OAC/B,OAKE,KAIF,gBAAgB,CAAC;AACf,IAAA,GAAG,EAAE,CAAA,wCAAA,CAA0C;AAC/C,IAAA,yBAAyB,EAAE,EAAE;AAC7B,IAAA,yBAAyB,EAAE,WAAW;IACtC,OAAO;AACR,CAAA;AAEH;;;AAGG;AACI,MAAM,gBAAgB,GAAG,OAC9B,OAKE,KAIF,gBAAgB,CAAC;AACf,IAAA,GAAG,EAAE,CAAA,oBAAA,CAAsB;AAC3B,IAAA,yBAAyB,EAAE,iBAAiB;AAC5C,IAAA,yBAAyB,EAAE,EAAE;IAC7B,OAAO;AACR,CAAA;AAEH;;;AAGG;AACI,MAAM,cAAc,GAAG,OAC5B,OAKE,KAIF,gBAAgB,CAAC;AACf,IAAA,GAAG,EAAE,CAAA,6BAAA,CAA+B;AACpC,IAAA,yBAAyB,EAAE,iBAAiB;AAC5C,IAAA,yBAAyB,EAAE,EAAE;IAC7B,OAAO;AACR,CAAA;AAEH;;;AAGG;AACI,MAAM,WAAW,GAAG,OACzB,IAAY,EACZ,OAKE,KAIF,gBAAgB,CAAC;IACf,GAAG,EAAE,CAAA,qBAAA,EAAwB,IAAI,CAAA,CAAE;AACnC,IAAA,yBAAyB,EAAE,iBAAiB;AAC5C,IAAA,yBAAyB,EAAE,EAAE;IAC7B,OAAO;AACR,CAAA;AAEH,MAAM,gBAAgB,GAAG,OAAO,EAC9B,GAAG,EACH,yBAAyB,EACzB,yBAAyB,EACzB,OAAO,GAWP,KAEE;AACF,IAAA,MAAM,MAAM,GAAG,MAAM,CAAC,CACpB;QACE,GAAG;AACH,QAAA,CAAC,OAAO,EAAE,cAAc,IAAI,IAAI;AAC9B,cAAE;AACF,cAAE,yBAAyB;AAC9B;SACE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE;AACtB,SAAA,IAAI,CAAC,GAAG,CAAC,EACZ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,EAAE,CACrC;AAED,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;AACxB,QAAA,OAAO,MAAM;IACf;AAEA,IAAA,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK;;IAG/B,MAAM,KAAK,GAAG;SACX,KAAK,CAAC,IAAI;SACV,GAAG,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;SACzB,MAAM,CAAC,CAAC,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;AAEhC,IAAA,OAAO,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC;AACzB,CAAC;;;;"}
+{"version":3,"file":"diff.mjs","sources":["../../src/functions/diff.mts"],"sourcesContent":[null],"names":[],"mappings":";;;AAIA;;;AAGG;AACI,MAAM,iBAAiB,GAAG,OAC/B,OAKE,KAIF,gBAAgB,CAAC;AACf,IAAA,GAAG,EAAE,CAAA,wCAAA,CAA0C;AAC/C,IAAA,yBAAyB,EAAE,EAAE;AAC7B,IAAA,yBAAyB,EAAE,WAAW;IACtC,OAAO;AACR,CAAA;AAEH;;;AAGG;AACI,MAAM,gBAAgB,GAAG,OAC9B,OAKE,KAIF,gBAAgB,CAAC;AACf,IAAA,GAAG,EAAE,CAAA,oBAAA,CAAsB;IAC3B,yBAAyB,EAAE,iBAAiB;AAC5C,IAAA,yBAAyB,EAAE,EAAE;IAC7B,OAAO;AACR,CAAA;AAEH;;;AAGG;AACI,MAAM,cAAc,GAAG,OAC5B,OAKE,KAIF,gBAAgB,CAAC;AACf,IAAA,GAAG,EAAE,CAAA,6BAAA,CAA+B;IACpC,yBAAyB,EAAE,iBAAiB;AAC5C,IAAA,yBAAyB,EAAE,EAAE;IAC7B,OAAO;AACR,CAAA;AAEH;;;AAGG;AACI,MAAM,WAAW,GAAG,OACzB,IAAY,EACZ,OAKE,KAIF,gBAAgB,CAAC;IACf,GAAG,EAAE,CAAA,qBAAA,EAAwB,IAAI,CAAA,CAAE;AACnC,IAAA,yBAAyB,EAAE,iBAAiB;AAC5C,IAAA,yBAAyB,EAAE,EAAE;IAC7B,OAAO;AACR,CAAA;AAEH,MAAM,gBAAgB,GAAG,OAAO,EAC9B,GAAG,EACH,yBAAyB,EACzB,yBAAyB,EACzB,OAAO,GAWP,KAEE;AACF,IAAA,MAAM,MAAM,GAAG,MAAM,CAAC,CACpB;QACE,GAAG;AACH,QAAA,CAAC,OAAO,EAAE,cAAc,IAAI,IAAI;AAC9B,cAAE;AACF,cAAE,yBAAyB;AAC9B;SACE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE;AACtB,SAAA,IAAI,CAAC,GAAG,CAAC,EACZ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,EAAE,CACrC;AAED,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;AACxB,QAAA,OAAO,MAAM;IACf;AAEA,IAAA,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK;;IAG/B,MAAM,KAAK,GAAG;SACX,KAAK,CAAC,IAAI;SACV,GAAG,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;SACzB,MAAM,CAAC,CAAC,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;AAEhC,IAAA,OAAO,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC;AACzB,CAAC;;;;"}

package/dist/functions/exec-async.d.mts

@@ -1,13 +1,13 @@
-import { type ExecException, type ExecOptions as ExecOptions_ } from 'node:child_process';
+import * as childProcess from 'node:child_process';
 import { Result } from 'ts-data-forge';
 type ExecOptionsCustom = Readonly<{
     silent?: boolean;
 }>;
-export type ExecOptions = DeepReadonly<ExecOptions_ & ExecOptionsCustom>;
+export type ExecOptions = childProcess.ExecOptions & ExecOptionsCustom;
 export type ExecResult<T extends string | Buffer> = Result<Readonly<{
     stdout: T;
     stderr: T;
-}>, ExecException>;
+}>, childProcess.ExecException>;
 /**
  * Executes a shell command asynchronously.
  *
@@ -15,12 +15,11 @@ export type ExecResult<T extends string | Buffer> = Result<Readonly<{
  * @param options - Optional configuration for command execution.
  * @returns A promise that resolves with the command result.
  */
-export declare function $(command: string, options?: ExecOptionsCustom): Promise<ExecResult<string>>;
-export declare function $(command: string, options: Readonly<{
-    encoding: 'buffer' | null;
-} & ExecOptions>): Promise<ExecResult<Buffer>>;
-export declare function $(command: string, options: Readonly<{
+export declare function $(command: string, options?: ExecOptionsCustom | Readonly<{
     encoding: BufferEncoding;
 } & ExecOptions>): Promise<ExecResult<string>>;
+export declare function $(command: string, options?: Readonly<{
+    encoding: 'buffer' | null;
+} & ExecOptions>): Promise<ExecResult<Buffer>>;
 export {};
 //# sourceMappingURL=exec-async.d.mts.map

package/dist/functions/exec-async.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"exec-async.d.mts","sourceRoot":"","sources":["../../src/functions/exec-async.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,WAAW,IAAI,YAAY,EACjC,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC,KAAK,iBAAiB,GAAG,QAAQ,CAAC;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC,YAAY,GAAG,iBAAiB,CAAC,CAAC;AAEzE,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,MAAM,CACxD,QAAQ,CAAC;IAAE,MAAM,EAAE,CAAC,CAAC;IAAC,MAAM,EAAE,CAAC,CAAA;CAAE,CAAC,EAClC,aAAa,CACd,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,CAAC,CACf,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;AAE/B,wBAAgB,CAAC,CACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,QAAQ,CAAC;IAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;CAAE,GAAG,WAAW,CAAC,GAC7D,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;AAE/B,wBAAgB,CAAC,CACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,QAAQ,CAAC;IAAE,QAAQ,EAAE,cAAc,CAAA;CAAE,GAAG,WAAW,CAAC,GAC5D,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC"}
+{"version":3,"file":"exec-async.d.mts","sourceRoot":"","sources":["../../src/functions/exec-async.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC,KAAK,iBAAiB,GAAG,QAAQ,CAAC;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,GAAG,iBAAiB,CAAC;AAEvE,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,MAAM,CACxD,QAAQ,CAAC;IAAE,MAAM,EAAE,CAAC,CAAC;IAAC,MAAM,EAAE,CAAC,CAAA;CAAE,CAAC,EAClC,YAAY,CAAC,aAAa,CAC3B,CAAC;AAEF;;;;;;GAMG;AAEH,wBAAgB,CAAC,CACf,OAAO,EAAE,MAAM,EAEf,OAAO,CAAC,EACJ,iBAAiB,GACjB,QAAQ,CAAC;IAAE,QAAQ,EAAE,cAAc,CAAA;CAAE,GAAG,WAAW,CAAC,GACvD,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;AAE/B,wBAAgB,CAAC,CACf,OAAO,EAAE,MAAM,EAEf,OAAO,CAAC,EAAE,QAAQ,CAAC;IAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;CAAE,GAAG,WAAW,CAAC,GAC9D,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC"}

package/dist/functions/exec-async.mjs

@@ -1,16 +1,16 @@
-import { exec } from 'node:child_process';
+import * as childProcess from 'node:child_process';
 import { Result } from 'ts-data-forge';
 
-function $(command, options) {
+function $(command, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+options) {
     const { silent = false, ...restOptions } = options ?? {};
     if (!silent) {
         echo(`$ ${command}`);
     }
     return new Promise((resolve) => {
         // eslint-disable-next-line security/detect-child-process
-        exec(command, 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
-        restOptions, (error, stdout, stderr) => {
+        childProcess.exec(command, restOptions, (error, stdout, stderr) => {
             if (!silent) {
                 if (stdout !== '') {
                     echo(stdout);

package/dist/functions/exec-async.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"exec-async.mjs","sources":["../../src/functions/exec-async.mts"],"sourcesContent":[null],"names":[],"mappings":";;;AAwCM,SAAU,CAAC,CACf,OAAe,EACf,OAEC,EAAA;AAED,IAAA,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,IAAI,EAAE;IAExD,IAAI,CAAC,MAAM,EAAE;AACX,QAAA,IAAI,CAAC,CAAA,EAAA,EAAK,OAAO,CAAA,CAAE,CAAC;IACtB;AAEA,IAAA,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,KAAI;;AAE7B,QAAA,IAAI,CACF,OAAO;;QAEP,WAEgB,EAChB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,KAAI;YACxB,IAAI,CAAC,MAAM,EAAE;AACX,gBAAA,IAAI,MAAM,KAAK,EAAE,EAAE;oBACjB,IAAI,CAAC,MAAM,CAAC;gBACd;AACA,gBAAA,IAAI,MAAM,KAAK,EAAE,EAAE;AACjB,oBAAA,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;gBACvB;YACF;AAEA,YAAA,IAAI,KAAK,KAAK,IAAI,EAAE;gBAClB,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC5B;iBAAO;AACL,gBAAA,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;YACxC;AACF,QAAA,CAAC,CACF;AACH,IAAA,CAAC,CAAC;AACJ;;;;"}
+{"version":3,"file":"exec-async.mjs","sources":["../../src/functions/exec-async.mts"],"sourcesContent":[null],"names":[],"mappings":";;;AAoCM,SAAU,CAAC,CACf,OAAe;AACf;AACA,OAEC,EAAA;AAED,IAAA,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,IAAI,EAAE;IAExD,IAAI,CAAC,MAAM,EAAE;AACX,QAAA,IAAI,CAAC,CAAA,EAAA,EAAK,OAAO,CAAA,CAAE,CAAC;IACtB;AAEA,IAAA,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,KAAI;;AAE7B,QAAA,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,KAAI;YAChE,IAAI,CAAC,MAAM,EAAE;AACX,gBAAA,IAAI,MAAM,KAAK,EAAE,EAAE;oBACjB,IAAI,CAAC,MAAM,CAAC;gBACd;AACA,gBAAA,IAAI,MAAM,KAAK,EAAE,EAAE;AACjB,oBAAA,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;gBACvB;YACF;AAEA,YAAA,IAAI,KAAK,KAAK,IAAI,EAAE;gBAClB,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC5B;iBAAO;AACL,gBAAA,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;YACxC;AACF,QAAA,CAAC,CAAC;AACJ,IAAA,CAAC,CAAC;AACJ;;;;"}

package/dist/functions/format.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"format.d.mts","sourceRoot":"","sources":["../../src/functions/format.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD,OAAO,EAAuB,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,oBAAoB,CAAC;AAQ5B;;;;GAIG;AACH,eAAO,MAAM,WAAW,GACtB,OAAO,SAAS,MAAM,EAAE,EACxB,UAAU,QAAQ,CAAC;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,KACvC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,OAAO,EAAE,CAAC,CA+F/C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAC1B,UAAU,MAAM,EAChB,UAAU,QAAQ,CAAC;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,KACvC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAyBpC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GACjC,UAAU,QAAQ,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,KACD,OAAO,CACR,MAAM,CACJ,SAAS,EACT,aAAa,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG,SAAS,OAAO,EAAE,CACnE,CAsDF,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,MAAM,EACZ,UAAU,QAAQ,CAAC;IACjB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,KACD,OAAO,CACR,MAAM,CACJ,SAAS,EACP,aAAa,GACb,QAAQ,CAAC;IACP,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC,GACF,SAAS,OAAO,EAAE,CACrB,CA8EF,CAAC"}
+{"version":3,"file":"format.d.mts","sourceRoot":"","sources":["../../src/functions/format.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD,OAAO,EAAuB,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,oBAAoB,CAAC;AAQ5B;;;;GAIG;AACH,eAAO,MAAM,WAAW,GACtB,OAAO,SAAS,MAAM,EAAE,EACxB,UAAU,QAAQ,CAAC;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,KACvC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,OAAO,EAAE,CAAC,CAqF/C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAC1B,UAAU,MAAM,EAChB,UAAU,QAAQ,CAAC;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,KACvC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAwBpC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GACjC,UAAU,QAAQ,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,KACD,OAAO,CACR,MAAM,CACJ,SAAS,EACT,aAAa,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG,SAAS,OAAO,EAAE,CACnE,CAsDF,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,MAAM,EACZ,UAAU,QAAQ,CAAC;IACjB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,KACD,OAAO,CACR,MAAM,CACJ,SAAS,EACP,aAAa,GACb,QAAQ,CAAC;IACP,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC,GACF,SAAS,OAAO,EAAE,CACrB,CA8EF,CAAC"}