ts-repo-utils 6.1.0 → 7.0.0

package/README.md

@@ -72,21 +72,24 @@ npm exec -- assert-repo-is-clean --silent
 
 - `--silent` - Suppress output messages (optional)
 
-### `format-untracked`
+### `format-uncommitted`
 
 Formats only untracked/modified files using Prettier.
 
 ```bash
 # Basic usage
-npm exec -- format-untracked
+npm exec -- format-uncommitted
 
 # Silent mode
-npm exec -- format-untracked --silent
+npm exec -- format-uncommitted --silent
 ```
 
 **Options:**
 
-- `--silent` - Suppress output messages (optional)
+- `--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`
 
@@ -112,9 +115,10 @@ npm exec -- format-diff-from main --silent
 **Options:**
 
 - `<base>` - Base branch name or commit hash to compare against (required)
-- `--include-untracked` - Include untracked files in addition to diff files (default: true)
-- `--exclude-untracked` - Exclude untracked files, only format diff files (optional)
-- `--silent` - Suppress output messages (optional)
+- `--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`
 
@@ -279,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.
 
@@ -300,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.
 
@@ -352,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.
 
@@ -363,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'],
 });
 ```
 
@@ -373,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;
 }>;
 ```
 
@@ -388,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
@@ -406,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();
 ```
@@ -421,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({
@@ -441,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.1.0',
+    version: '7.0.0',
     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.1.0',
+    version: '7.0.0',
     args: {
         pathsIgnore: cmd.multioption({
             long: 'paths-ignore',

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

@@ -1,6 +1,6 @@
 #!/usr/bin/env -S npx tsx
 import * as cmd from 'cmd-ts';
-import 'ts-data-forge';
+import { Result } from 'ts-data-forge';
 import '../node-global.mjs';
 import 'node:child_process';
 import { formatDiffFrom } from '../functions/format.mjs';
@@ -9,17 +9,27 @@ import 'child_process';
 
 const cmdDef = cmd.command({
     name: 'format-diff-from-cli',
-    version: '6.1.0',
+    version: '7.0.0',
     args: {
         base: cmd.positional({
             type: cmd.string,
             displayName: 'base',
             description: 'Base branch name or commit hash to compare against',
         }),
-        includeUntracked: cmd.flag({
-            long: 'include-untracked',
+        excludeUntracked: cmd.flag({
+            long: 'exclude-untracked',
             type: cmd.optional(cmd.boolean),
-            description: 'Include untracked files in addition to diff files (default: true)',
+            description: 'Exclude untracked files in addition to diff files (default: false)',
+        }),
+        excludeModified: cmd.flag({
+            long: 'exclude-modified',
+            type: cmd.optional(cmd.boolean),
+            description: 'Exclude modified files in addition to diff files (default: false)',
+        }),
+        excludeStaged: cmd.flag({
+            long: 'exclude-staged',
+            type: cmd.optional(cmd.boolean),
+            description: 'Exclude staged files in addition to diff files (default: false)',
         }),
         silent: cmd.flag({
             long: 'silent',
@@ -28,15 +38,26 @@ const cmdDef = cmd.command({
         }),
     },
     handler: (args) => {
-        main(args).catch((error) => {
+        main({
+            base: args.base,
+            excludeUntracked: args.excludeUntracked ?? false,
+            excludeModified: args.excludeModified ?? false,
+            excludeStaged: args.excludeStaged ?? false,
+            silent: args.silent ?? false,
+        }).catch((error) => {
             console.error('An error occurred:', error);
             process.exit(1);
         });
     },
 });
 const main = async (args) => {
-    const result = await formatDiffFrom(args.base, args);
-    if (result === 'err') {
+    const result = await formatDiffFrom(args.base, {
+        includeUntracked: !args.excludeUntracked,
+        includeModified: !args.excludeModified,
+        includeStaged: !args.excludeStaged,
+        silent: args.silent,
+    });
+    if (Result.isErr(result)) {
         process.exit(1);
     }
 };

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

@@ -1 +1 @@
-{"version":3,"file":"format-diff-from.mjs","sources":["../../src/cmd/format-diff-from.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;AAKA,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC;AACzB,IAAA,IAAI,EAAE,sBAAsB;AAC5B,IAAA,OAAO,EAAE,OAAO;AAChB,IAAA,IAAI,EAAE;AACJ,QAAA,IAAI,EAAE,GAAG,CAAC,UAAU,CAAC;YACnB,IAAI,EAAE,GAAG,CAAC,MAAM;AAChB,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,WAAW,EAAE,oDAAoD;SAClE,CAAC;AACF,QAAA,gBAAgB,EAAE,GAAG,CAAC,IAAI,CAAC;AACzB,YAAA,IAAI,EAAE,mBAAmB;YACzB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;AAC/B,YAAA,WAAW,EACT,mEAAmE;SACtE,CAAC;AACF,QAAA,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC;AACf,YAAA,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;AAC/B,YAAA,WAAW,EAAE,sDAAsD;SACpE,CAAC;AACH,KAAA;AACD,IAAA,OAAO,EAAE,CAAC,IAAI,KAAI;QAChB,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAI;AACzB,YAAA,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,KAAK,CAAC;AAC1C,YAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AACjB,QAAA,CAAC,CAAC;IACJ,CAAC;AACF,CAAA,CAAC;AAEF,MAAM,IAAI,GAAG,OACX,IAIE,KACe;IACjB,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;AAEpD,IAAA,IAAI,MAAM,KAAK,KAAK,EAAE;AACpB,QAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjB;AACF,CAAC;AAED,MAAM,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"format-diff-from.mjs","sources":["../../src/cmd/format-diff-from.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;AAMA,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC;AACzB,IAAA,IAAI,EAAE,sBAAsB;AAC5B,IAAA,OAAO,EAAE,OAAO;AAChB,IAAA,IAAI,EAAE;AACJ,QAAA,IAAI,EAAE,GAAG,CAAC,UAAU,CAAC;YACnB,IAAI,EAAE,GAAG,CAAC,MAAM;AAChB,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,WAAW,EAAE,oDAAoD;SAClE,CAAC;AACF,QAAA,gBAAgB,EAAE,GAAG,CAAC,IAAI,CAAC;AACzB,YAAA,IAAI,EAAE,mBAAmB;YACzB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;AAC/B,YAAA,WAAW,EACT,oEAAoE;SACvE,CAAC;AACF,QAAA,eAAe,EAAE,GAAG,CAAC,IAAI,CAAC;AACxB,YAAA,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;AAC/B,YAAA,WAAW,EACT,mEAAmE;SACtE,CAAC;AACF,QAAA,aAAa,EAAE,GAAG,CAAC,IAAI,CAAC;AACtB,YAAA,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;AAC/B,YAAA,WAAW,EACT,iEAAiE;SACpE,CAAC;AACF,QAAA,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC;AACf,YAAA,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;AAC/B,YAAA,WAAW,EAAE,sDAAsD;SACpE,CAAC;AACH,KAAA;AACD,IAAA,OAAO,EAAE,CAAC,IAAI,KAAI;AAChB,QAAA,IAAI,CAAC;YACH,IAAI,EAAE,IAAI,CAAC,IAAI;AACf,YAAA,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,IAAI,KAAK;AAChD,YAAA,eAAe,EAAE,IAAI,CAAC,eAAe,IAAI,KAAK;AAC9C,YAAA,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,KAAK;AAC1C,YAAA,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK;AAC7B,SAAA,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAI;AACjB,YAAA,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,KAAK,CAAC;AAC1C,YAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AACjB,QAAA,CAAC,CAAC;IACJ,CAAC;AACF,CAAA,CAAC;AAEF,MAAM,IAAI,GAAG,OACX,IAME,KACe;IACjB,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE;AAC7C,QAAA,gBAAgB,EAAE,CAAC,IAAI,CAAC,gBAAgB;AACxC,QAAA,eAAe,EAAE,CAAC,IAAI,CAAC,eAAe;AACtC,QAAA,aAAa,EAAE,CAAC,IAAI,CAAC,aAAa;QAClC,MAAM,EAAE,IAAI,CAAC,MAAM;AACpB,KAAA,CAAC;AAEF,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;AACxB,QAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjB;AACF,CAAC;AAED,MAAM,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC"}

package/dist/cmd/format-uncommitted.d.mts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S npx tsx
+export {};
+//# sourceMappingURL=format-uncommitted.d.mts.map

package/dist/cmd/format-uncommitted.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-uncommitted.d.mts","sourceRoot":"","sources":["../../src/cmd/format-uncommitted.mts"],"names":[],"mappings":""}

package/dist/cmd/format-uncommitted.mjs

@@ -0,0 +1,59 @@
+#!/usr/bin/env -S npx tsx
+import * as cmd from 'cmd-ts';
+import { Result } from 'ts-data-forge';
+import '../node-global.mjs';
+import 'node:child_process';
+import { formatUncommittedFiles } from '../functions/format.mjs';
+import 'micromatch';
+import 'child_process';
+
+const cmdDef = cmd.command({
+    name: 'format-uncommitted-cli',
+    version: '7.0.0',
+    args: {
+        excludeUntracked: cmd.flag({
+            long: 'exclude-untracked',
+            type: cmd.optional(cmd.boolean),
+            description: 'Exclude untracked files in addition to diff files (default: false)',
+        }),
+        excludeModified: cmd.flag({
+            long: 'exclude-modified',
+            type: cmd.optional(cmd.boolean),
+            description: 'Exclude modified files in addition to diff files (default: false)',
+        }),
+        excludeStaged: cmd.flag({
+            long: 'exclude-staged',
+            type: cmd.optional(cmd.boolean),
+            description: 'Exclude staged files in addition to diff files (default: false)',
+        }),
+        silent: cmd.flag({
+            long: 'silent',
+            type: cmd.optional(cmd.boolean),
+            description: 'If true, suppresses output messages (default: false)',
+        }),
+    },
+    handler: (args) => {
+        main({
+            excludeUntracked: args.excludeUntracked ?? false,
+            excludeModified: args.excludeModified ?? false,
+            excludeStaged: args.excludeStaged ?? false,
+            silent: args.silent ?? false,
+        }).catch((error) => {
+            console.error('An error occurred:', error);
+            process.exit(1);
+        });
+    },
+});
+const main = async (args) => {
+    const result = await formatUncommittedFiles({
+        untracked: !args.excludeUntracked,
+        modified: !args.excludeModified,
+        staged: !args.excludeStaged,
+        silent: args.silent,
+    });
+    if (Result.isErr(result)) {
+        process.exit(1);
+    }
+};
+await cmd.run(cmdDef, process.argv.slice(2));
+//# sourceMappingURL=format-uncommitted.mjs.map

package/dist/cmd/format-uncommitted.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-uncommitted.mjs","sources":["../../src/cmd/format-uncommitted.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;AAMA,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC;AACzB,IAAA,IAAI,EAAE,wBAAwB;AAC9B,IAAA,OAAO,EAAE,OAAO;AAChB,IAAA,IAAI,EAAE;AACJ,QAAA,gBAAgB,EAAE,GAAG,CAAC,IAAI,CAAC;AACzB,YAAA,IAAI,EAAE,mBAAmB;YACzB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;AAC/B,YAAA,WAAW,EACT,oEAAoE;SACvE,CAAC;AACF,QAAA,eAAe,EAAE,GAAG,CAAC,IAAI,CAAC;AACxB,YAAA,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;AAC/B,YAAA,WAAW,EACT,mEAAmE;SACtE,CAAC;AACF,QAAA,aAAa,EAAE,GAAG,CAAC,IAAI,CAAC;AACtB,YAAA,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;AAC/B,YAAA,WAAW,EACT,iEAAiE;SACpE,CAAC;AACF,QAAA,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC;AACf,YAAA,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;AAC/B,YAAA,WAAW,EAAE,sDAAsD;SACpE,CAAC;AACH,KAAA;AACD,IAAA,OAAO,EAAE,CAAC,IAAI,KAAI;AAChB,QAAA,IAAI,CAAC;AACH,YAAA,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,IAAI,KAAK;AAChD,YAAA,eAAe,EAAE,IAAI,CAAC,eAAe,IAAI,KAAK;AAC9C,YAAA,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,KAAK;AAC1C,YAAA,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK;AAC7B,SAAA,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAI;AACjB,YAAA,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,KAAK,CAAC;AAC1C,YAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AACjB,QAAA,CAAC,CAAC;IACJ,CAAC;AACF,CAAA,CAAC;AAEF,MAAM,IAAI,GAAG,OACX,IAKE,KACe;AACjB,IAAA,MAAM,MAAM,GAAG,MAAM,sBAAsB,CAAC;AAC1C,QAAA,SAAS,EAAE,CAAC,IAAI,CAAC,gBAAgB;AACjC,QAAA,QAAQ,EAAE,CAAC,IAAI,CAAC,eAAe;AAC/B,QAAA,MAAM,EAAE,CAAC,IAAI,CAAC,aAAa;QAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;AACpB,KAAA,CAAC;AACF,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;AACxB,QAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjB;AACF,CAAC;AAED,MAAM,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC"}

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.1.0',
+    version: '7.0.0',
     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

@@ -1,7 +1,10 @@
 import { type ExecException } from 'node:child_process';
 import { Result } from 'ts-data-forge';
 import '../node-global.mjs';
-/** Get files that have been changed (git status). */
+/**
+ * Get untracked files from the working tree (files not added to git). Runs `git
+ * ls-files --others --exclude-standard [--deleted]`
+ */
 export declare const getUntrackedFiles: (options?: Readonly<{
     /** @default true */
     excludeDeleted?: boolean;
@@ -10,7 +13,34 @@ export declare const getUntrackedFiles: (options?: Readonly<{
 }>) => Promise<Result<readonly string[], ExecException | Readonly<{
     message: string;
 }>>>;
-/** Get files that differ from the specified base branch or commit */
+/**
+ * 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 */
+    excludeDeleted?: boolean;
+    /** @default false */
+    silent?: boolean;
+}>) => Promise<Result<readonly string[], ExecException | Readonly<{
+    message: string;
+}>>>;
+/**
+ * Get files that are staged for commit (files added with git add). Runs `git
+ * diff --staged --name-only [--diff-filter=d]`
+ */
+export declare const getStagedFiles: (options?: Readonly<{
+    /** @default true */
+    excludeDeleted?: boolean;
+    /** @default false */
+    silent?: boolean;
+}>) => Promise<Result<readonly string[], ExecException | Readonly<{
+    message: string;
+}>>>;
+/**
+ * Get files that differ from the specified base branch or commit. Runs `git
+ * diff --name-only <base> [--diff-filter=d]`
+ */
 export declare const getDiffFrom: (base: string, options?: Readonly<{
     /** @default true */
     excludeDeleted?: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"diff.d.mts","sourceRoot":"","sources":["../../src/functions/diff.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,oBAAoB,CAAC;AAE5B,qDAAqD;AACrD,eAAO,MAAM,iBAAiB,GAC5B,UAAU,QAAQ,CAAC;IACjB,oBAAoB;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qBAAqB;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,KACD,OAAO,CACR,MAAM,CAAC,SAAS,MAAM,EAAE,EAAE,aAAa,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC,CA2BzE,CAAC;AAEF,qEAAqE;AACrE,eAAO,MAAM,WAAW,GACtB,MAAM,MAAM,EACZ,UAAU,QAAQ,CAAC;IACjB,oBAAoB;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qBAAqB;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,KACD,OAAO,CACR,MAAM,CAAC,SAAS,MAAM,EAAE,EAAE,aAAa,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC,CA2BzE,CAAC"}
+{"version":3,"file":"diff.d.mts","sourceRoot":"","sources":["../../src/functions/diff.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,oBAAoB,CAAC;AAE5B;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAC5B,UAAU,QAAQ,CAAC;IACjB,oBAAoB;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qBAAqB;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,KACD,OAAO,CACR,MAAM,CAAC,SAAS,MAAM,EAAE,EAAE,aAAa,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC,CAOtE,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAC3B,UAAU,QAAQ,CAAC;IACjB,oBAAoB;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qBAAqB;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,KACD,OAAO,CACR,MAAM,CAAC,SAAS,MAAM,EAAE,EAAE,aAAa,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC,CAOtE,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,cAAc,GACzB,UAAU,QAAQ,CAAC;IACjB,oBAAoB;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qBAAqB;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,KACD,OAAO,CACR,MAAM,CAAC,SAAS,MAAM,EAAE,EAAE,aAAa,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC,CAOtE,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,WAAW,GACtB,MAAM,MAAM,EACZ,UAAU,QAAQ,CAAC;IACjB,oBAAoB;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qBAAqB;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC,KACD,OAAO,CACR,MAAM,CAAC,SAAS,MAAM,EAAE,EAAE,aAAa,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC,CAOtE,CAAC"}