@sorrell/cli-utilities 1.0.46 → 1.0.47

package/Distribution/Git/Git.Internal.Types.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @file      Git.Internal.Types.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+/** The data used in {@link RepoNotCleanError}. */
+export type FRepoNotCleanErrorData = Readonly<{
+    RepositoryPath: string;
+    StatusOutput: string;
+}>;
+//# sourceMappingURL=Git.Internal.Types.d.ts.map

package/Distribution/Git/Git.Internal.Types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Git.Internal.Types.d.ts","sourceRoot":"","sources":["../../Source/Git/Git.Internal.Types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,kDAAkD;AAClD,MAAM,MAAM,sBAAsB,GAC9B,QAAQ,CAAC;IACL,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;CACxB,CAAC,CAAC"}

package/Distribution/Git/Git.Internal.Types.js

@@ -0,0 +1,8 @@
+/**
+ * @file      Git.Internal.Types.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+export {};
+//# sourceMappingURL=Git.Internal.Types.js.map

package/Distribution/Git/Git.Internal.Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Git.Internal.Types.js","sourceRoot":"","sources":["../../Source/Git/Git.Internal.Types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/Distribution/Git/Git.Types.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @file      Git.Types.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+import type { CommandExecutor, Error } from "@effect/platform";
+import type { RepoNotCleanError } from "./Git.js";
+import type { Effect } from "effect";
+/** The {@link Effect.Effect | effect} returned by {@link RequireCleanGitRepository}. */
+export type ERequireCleanRepo = Effect.Effect<void, RepoNotCleanError | Error.PlatformError, CommandExecutor.CommandExecutor>;
+//# sourceMappingURL=Git.Types.d.ts.map

package/Distribution/Git/Git.Types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Git.Types.d.ts","sourceRoot":"","sources":["../../Source/Git/Git.Types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAE/D,OAAO,KAAK,EAAE,iBAAiB,EAA6B,MAAM,UAAU,CAAC;AAC7E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,wFAAwF;AACxF,MAAM,MAAM,iBAAiB,GACzB,MAAM,CAAC,MAAM,CACT,IAAI,EACJ,iBAAiB,GAAG,KAAK,CAAC,aAAa,EACvC,eAAe,CAAC,eAAe,CAClC,CAAC"}

package/Distribution/Git/Git.Types.js

@@ -0,0 +1,8 @@
+/**
+ * @file      Git.Types.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+export {};
+//# sourceMappingURL=Git.Types.js.map

package/Distribution/Git/Git.Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Git.Types.js","sourceRoot":"","sources":["../../Source/Git/Git.Types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/Distribution/Git/Git.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @file      Git.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+import type { ERequireCleanRepo } from "./Git.Types.js";
+import type { FRepoNotCleanErrorData } from "./Git.Internal.Types.js";
+declare const RepoNotCleanError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "RepoNotCleanError";
+} & Readonly<A>;
+/** The error that is thrown when the current `git` repo must be clean, but is not. */
+export declare class RepoNotCleanError extends RepoNotCleanError_base<FRepoNotCleanErrorData> {
+}
+/**
+ * Get an {@link Effect.Effect | effect} that causes the program to fail if a given `git`
+ * repo is not clean.
+ *
+ * @param RepositoryPath - The *optional* path to a directory in the repository.  If no path is specified,
+ * then the current working directory is used.
+ *
+ * @returns {ERequireCleanRepo} An {@link Effect.Effect | effect} that causes the program to fail
+ * if the `git` repo at the given {@link RepositoryPath} (or CWD if no {@link RepositoryPath} is specified)
+ * is not clean.
+ */
+export declare function RequireCleanGitRepository(RepositoryPath?: string): ERequireCleanRepo;
+export {};
+//# sourceMappingURL=Git.d.ts.map

package/Distribution/Git/Git.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Git.d.ts","sourceRoot":"","sources":["../../Source/Git/Git.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;;;;AAEtE,sFAAsF;AACtF,qBAAa,iBAAkB,SAAQ,uBAAsC,sBAAsB,CAAC;CAAI;AAIxG;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,iBAAiB,CA0BpF"}

package/Distribution/Git/Git.js

@@ -0,0 +1,43 @@
+/**
+ * @file      Git.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+import { Data, Effect } from "effect";
+import { Command } from "@effect/platform";
+/** The error that is thrown when the current `git` repo must be clean, but is not. */
+export class RepoNotCleanError extends Data.TaggedError("RepoNotCleanError") {
+}
+;
+/* eslint-disable jsdoc/require-example */
+/**
+ * Get an {@link Effect.Effect | effect} that causes the program to fail if a given `git`
+ * repo is not clean.
+ *
+ * @param RepositoryPath - The *optional* path to a directory in the repository.  If no path is specified,
+ * then the current working directory is used.
+ *
+ * @returns {ERequireCleanRepo} An {@link Effect.Effect | effect} that causes the program to fail
+ * if the `git` repo at the given {@link RepositoryPath} (or CWD if no {@link RepositoryPath} is specified)
+ * is not clean.
+ */
+export function RequireCleanGitRepository(RepositoryPath) {
+    return Effect.gen(function* () {
+        if (RepositoryPath === undefined) {
+            RepositoryPath = process.cwd();
+        }
+        const StatusCommand = Command
+            .make("git", "status", "--porcelain=v1")
+            .pipe(Command.workingDirectory(RepositoryPath));
+        const StatusOutput = yield* Command.string(StatusCommand);
+        if (StatusOutput.trim().length > 0) {
+            return yield* Effect.fail(new RepoNotCleanError({
+                RepositoryPath,
+                StatusOutput
+            }));
+        }
+    });
+}
+/* eslint-enable jsdoc/require-example */
+//# sourceMappingURL=Git.js.map

package/Distribution/Git/Git.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Git.js","sourceRoot":"","sources":["../../Source/Git/Git.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAI3C,sFAAsF;AACtF,MAAM,OAAO,iBAAkB,SAAQ,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAyB;CAAI;AAAA,CAAC;AAEzG,0CAA0C;AAE1C;;;;;;;;;;GAUG;AACH,MAAM,UAAU,yBAAyB,CAAC,cAAuB;IAE7D,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAEvB,IAAI,cAAc,KAAK,SAAS,EAChC,CAAC;YACG,cAAc,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;QACnC,CAAC;QAED,MAAM,aAAa,GACf,OAAO;aACF,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,gBAAgB,CAAC;aACvC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC;QAExD,MAAM,YAAY,GAAW,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAElE,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAClC,CAAC;YACG,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CACrB,IAAI,iBAAiB,CAAC;gBAClB,cAAc;gBACd,YAAY;aACf,CAAC,CACL,CAAC;QACN,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED,yCAAyC"}

package/Distribution/Git/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @file      index.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+export * from "./Git.js";
+export * from "./Git.Types.js";
+//# sourceMappingURL=index.d.ts.map

package/Distribution/Git/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../Source/Git/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}

package/Distribution/Git/index.js

@@ -0,0 +1,9 @@
+/**
+ * @file      index.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+export * from "./Git.js";
+export * from "./Git.Types.js";
+//# sourceMappingURL=index.js.map

package/Distribution/Git/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../Source/Git/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}

package/Distribution/index.d.ts

@@ -5,7 +5,11 @@
  * @license   MIT
  */
 export * as Command from "./Command/index.js";
+export * as English from "./English/index.js";
+export * as PackageConfig from "./PackageConfig/index.js";
 export * as Listr from "./Listr/index.js";
+export * as Fs from "./FileSystem/index.js";
+export * as Git from "./Git/index.js";
 export * as PseudoTerminal from "./PseudoTerminal/index.js";
 export * as Format from "./Format/index.js";
 export * as Ora from "./Ora/index.js";

package/Distribution/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAC1C,OAAO,KAAK,cAAc,MAAM,2BAA2B,CAAC;AAC5D,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC;AAC5C,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAC;AACtC,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAC;AAC1D,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAC1C,OAAO,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC5C,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAC;AACtC,OAAO,KAAK,cAAc,MAAM,2BAA2B,CAAC;AAC5D,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC;AAC5C,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAC;AACtC,cAAc,0BAA0B,CAAC"}

package/Distribution/index.js

@@ -5,7 +5,11 @@
  * @license   MIT
  */
 export * as Command from "./Command/index.js";
+export * as English from "./English/index.js";
+export * as PackageConfig from "./PackageConfig/index.js";
 export * as Listr from "./Listr/index.js";
+export * as Fs from "./FileSystem/index.js";
+export * as Git from "./Git/index.js";
 export * as PseudoTerminal from "./PseudoTerminal/index.js";
 export * as Format from "./Format/index.js";
 export * as Ora from "./Ora/index.js";

package/Distribution/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAC1C,OAAO,KAAK,cAAc,MAAM,2BAA2B,CAAC;AAC5D,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC;AAC5C,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAC;AACtC,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAC;AAC1D,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAC1C,OAAO,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC5C,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAC;AACtC,OAAO,KAAK,cAAc,MAAM,2BAA2B,CAAC;AAC5D,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC;AAC5C,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAC;AACtC,cAAc,0BAA0B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sorrell/cli-utilities",
-  "version": "1.0.46",
+  "version": "1.0.47",
   "description": "Utilities developing CLI tools with TypeScript.",
   "keywords": [
     "cli",
@@ -8,9 +8,12 @@
     "utilities",
     "typescript",
     "ts",
+    "sorrell",
     "inquirer",
     "ora",
-    "commander"
+    "commander",
+    "clack",
+    "prompts"
   ],
   "homepage": "https://github.com/GageSorrell/SorrellWm/tree/Master/Package/CliUtilities",
   "bugs": {
@@ -46,6 +49,12 @@
       "require": "./Distribution/FileSystem/index.js",
       "types": "./Distribution/FileSystem/index.d.ts"
     },
+    "./git": {
+      "default": "./Distribution/Git/index.js",
+      "import": "./Distribution/Git/index.js",
+      "require": "./Distribution/Git/index.js",
+      "types": "./Distribution/Git/index.d.ts"
+    },
     "./inquirer": {
       "default": "./Distribution/Inquirer/index.js",
       "import": "./Distribution/Inquirer/index.js",