@optique/git 1.0.0-dev.908 → 1.0.0

package/dist/index.cjs

@@ -126,8 +126,9 @@ function createAsyncValueParser(options, metavar, parseFn, suggestFn) {
 	}
 	const validatedDepth = options?.suggestionDepth ?? DEFAULT_SUGGESTION_DEPTH;
 	return {
-		$mode: "async",
+		mode: "async",
 		metavar,
+		placeholder: "",
 		parse(input) {
 			const dir = getRepoDir(options?.dir);
 			return parseFn(dir, input, options?.errors);
@@ -178,7 +179,7 @@ function gitBranch(options) {
 			};
 			return {
 				success: false,
-				error: __optique_core_message.message`Branch ${(0, __optique_core_message.value)(input)} does not exist. Available branches: ${(0, __optique_core_message.valueSet)(branches)}`
+				error: __optique_core_message.message`Branch ${(0, __optique_core_message.value)(input)} does not exist.${branches.length > 0 ? __optique_core_message.message` Available branches: ${(0, __optique_core_message.valueSet)(branches, "")}` : __optique_core_message.message``}`
 			};
 		} catch (error) {
 			const fallback = __optique_core_message.message`Failed to list branches. Ensure ${(0, __optique_core_message.value)(dir)} is a valid git repository.`;
@@ -215,6 +216,8 @@ function gitBranch(options) {
 * @param remote The remote name to validate against.
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts existing remote branch names.
+* @throws {TypeError} If `remote` is not a valid non-empty string without
+*   whitespace or control characters.
 * @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 *
@@ -227,6 +230,9 @@ function gitBranch(options) {
 * ~~~~
 */
 function gitRemoteBranch(remote, options) {
+	const expectedMessage = "Expected remote to be a non-empty string without whitespace or control characters";
+	if (typeof remote !== "string") throw new TypeError(`${expectedMessage}, but got: ${remote === null ? "null" : Array.isArray(remote) ? "array" : typeof remote}.`);
+	if (remote === "" || /[\s\x00-\x1f]/.test(remote)) throw new TypeError(`${expectedMessage}, but got: ${JSON.stringify(remote)}.`);
 	const metavar = options?.metavar ?? METAVAR_BRANCH;
 	return createAsyncValueParser(options, metavar, async (dir, input, errors) => {
 		try {
@@ -239,13 +245,34 @@ function gitRemoteBranch(remote, options) {
 				success: true,
 				value: input
 			};
+			if (branches.length === 0) {
+				const remotes = await isomorphic_git.listRemotes({
+					fs: gitFs,
+					dir
+				});
+				const names = remotes.map((r) => r.remote);
+				if (!names.includes(remote)) {
+					if (errors?.remoteNotFound) return {
+						success: false,
+						error: errors.remoteNotFound(remote, names)
+					};
+					if (errors?.notFound) return {
+						success: false,
+						error: errors.notFound(input, branches)
+					};
+					return {
+						success: false,
+						error: __optique_core_message.message`Remote ${(0, __optique_core_message.value)(remote)} does not exist.${names.length > 0 ? __optique_core_message.message` Available remotes: ${(0, __optique_core_message.valueSet)(names, "")}` : __optique_core_message.message``}`
+					};
+				}
+			}
 			if (errors?.notFound) return {
 				success: false,
 				error: errors.notFound(input, branches)
 			};
 			return {
 				success: false,
-				error: __optique_core_message.message`Remote branch ${(0, __optique_core_message.value)(input)} does not exist on remote ${(0, __optique_core_message.value)(remote)}. Available branches: ${(0, __optique_core_message.valueSet)(branches)}`
+				error: __optique_core_message.message`Remote branch ${(0, __optique_core_message.value)(input)} does not exist on remote ${(0, __optique_core_message.value)(remote)}.${branches.length > 0 ? __optique_core_message.message` Available branches: ${(0, __optique_core_message.valueSet)(branches, "")}` : __optique_core_message.message``}`
 			};
 		} catch (error) {
 			const fallback = __optique_core_message.message`Failed to list remote branches. Ensure remote ${(0, __optique_core_message.value)(remote)} exists.`;
@@ -301,7 +328,7 @@ function gitTag(options) {
 			};
 			return {
 				success: false,
-				error: __optique_core_message.message`Tag ${(0, __optique_core_message.value)(input)} does not exist. Available tags: ${(0, __optique_core_message.valueSet)(tags)}`
+				error: __optique_core_message.message`Tag ${(0, __optique_core_message.value)(input)} does not exist.${tags.length > 0 ? __optique_core_message.message` Available tags: ${(0, __optique_core_message.valueSet)(tags, "")}` : __optique_core_message.message``}`
 			};
 		} catch (error) {
 			const fallback = __optique_core_message.message`Failed to list tags. Ensure ${(0, __optique_core_message.value)(dir)} is a valid git repository.`;
@@ -356,7 +383,7 @@ function gitRemote(options) {
 			};
 			return {
 				success: false,
-				error: __optique_core_message.message`Remote ${(0, __optique_core_message.value)(input)} does not exist. Available remotes: ${(0, __optique_core_message.valueSet)(names)}`
+				error: __optique_core_message.message`Remote ${(0, __optique_core_message.value)(input)} does not exist.${names.length > 0 ? __optique_core_message.message` Available remotes: ${(0, __optique_core_message.valueSet)(names, "")}` : __optique_core_message.message``}`
 			};
 		} catch (error) {
 			const fallback = __optique_core_message.message`Failed to list remotes. Ensure ${(0, __optique_core_message.value)(dir)} is a valid git repository.`;
@@ -571,7 +598,8 @@ function gitRef(options) {
 * @param options Shared configuration for the parsers.
 * @returns An object containing git parsers.  Each returned method may throw
 *   a {@link RangeError} if the merged `suggestionDepth` is not a positive
-*   integer.
+*   integer.  `remoteBranch()` may also throw a {@link TypeError} if `remote`
+*   is not a valid non-empty string without whitespace or control characters.
 * @since 0.9.0
 */
 function createGitParsers(options) {

package/dist/index.d.cts

@@ -68,6 +68,16 @@ interface GitParserErrors {
    * @returns A custom error message.
    */
   invalidFormat?: (input: string) => Message;
+  /**
+   * Error message when the remote does not exist.
+   * Only used by {@link gitRemoteBranch}.
+   *
+   * @param remote The remote name that was not found.
+   * @param availableRemotes List of available remote names.
+   * @returns A custom error message.
+   * @since 1.0.0
+   */
+  remoteNotFound?: (remote: string, availableRemotes: readonly string[]) => Message;
 }
 /**
  * Git parsers factory interface.
@@ -87,6 +97,8 @@ interface GitParsers {
    * @param remote The remote name to validate against.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts existing remote branch names.
+   * @throws {TypeError} If `remote` is not a valid non-empty string without
+   *   whitespace or control characters.
    * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   remoteBranch(remote: string, options?: GitParserOptions): ValueParser<"async", string>;
@@ -149,6 +161,8 @@ declare function gitBranch(options?: GitParserOptions): ValueParser<"async", str
  * @param remote The remote name to validate against.
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts existing remote branch names.
+ * @throws {TypeError} If `remote` is not a valid non-empty string without
+ *   whitespace or control characters.
  * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  *
@@ -209,7 +223,8 @@ declare function gitRef(options?: GitParserOptions): ValueParser<"async", string
  * @param options Shared configuration for the parsers.
  * @returns An object containing git parsers.  Each returned method may throw
  *   a {@link RangeError} if the merged `suggestionDepth` is not a positive
- *   integer.
+ *   integer.  `remoteBranch()` may also throw a {@link TypeError} if `remote`
+ *   is not a valid non-empty string without whitespace or control characters.
  * @since 0.9.0
  */
 declare function createGitParsers(options?: GitParserOptions): GitParsers;

package/dist/index.d.ts

@@ -68,6 +68,16 @@ interface GitParserErrors {
    * @returns A custom error message.
    */
   invalidFormat?: (input: string) => Message;
+  /**
+   * Error message when the remote does not exist.
+   * Only used by {@link gitRemoteBranch}.
+   *
+   * @param remote The remote name that was not found.
+   * @param availableRemotes List of available remote names.
+   * @returns A custom error message.
+   * @since 1.0.0
+   */
+  remoteNotFound?: (remote: string, availableRemotes: readonly string[]) => Message;
 }
 /**
  * Git parsers factory interface.
@@ -87,6 +97,8 @@ interface GitParsers {
    * @param remote The remote name to validate against.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts existing remote branch names.
+   * @throws {TypeError} If `remote` is not a valid non-empty string without
+   *   whitespace or control characters.
    * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   remoteBranch(remote: string, options?: GitParserOptions): ValueParser<"async", string>;
@@ -149,6 +161,8 @@ declare function gitBranch(options?: GitParserOptions): ValueParser<"async", str
  * @param remote The remote name to validate against.
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts existing remote branch names.
+ * @throws {TypeError} If `remote` is not a valid non-empty string without
+ *   whitespace or control characters.
  * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  *
@@ -209,7 +223,8 @@ declare function gitRef(options?: GitParserOptions): ValueParser<"async", string
  * @param options Shared configuration for the parsers.
  * @returns An object containing git parsers.  Each returned method may throw
  *   a {@link RangeError} if the merged `suggestionDepth` is not a positive
- *   integer.
+ *   integer.  `remoteBranch()` may also throw a {@link TypeError} if `remote`
+ *   is not a valid non-empty string without whitespace or control characters.
  * @since 0.9.0
  */
 declare function createGitParsers(options?: GitParserOptions): GitParsers;

package/dist/index.js

@@ -104,8 +104,9 @@ function createAsyncValueParser(options, metavar, parseFn, suggestFn) {
 	}
 	const validatedDepth = options?.suggestionDepth ?? DEFAULT_SUGGESTION_DEPTH;
 	return {
-		$mode: "async",
+		mode: "async",
 		metavar,
+		placeholder: "",
 		parse(input) {
 			const dir = getRepoDir(options?.dir);
 			return parseFn(dir, input, options?.errors);
@@ -156,7 +157,7 @@ function gitBranch(options) {
 			};
 			return {
 				success: false,
-				error: message`Branch ${value(input)} does not exist. Available branches: ${valueSet(branches)}`
+				error: message`Branch ${value(input)} does not exist.${branches.length > 0 ? message` Available branches: ${valueSet(branches, "")}` : message``}`
 			};
 		} catch (error) {
 			const fallback = message`Failed to list branches. Ensure ${value(dir)} is a valid git repository.`;
@@ -193,6 +194,8 @@ function gitBranch(options) {
 * @param remote The remote name to validate against.
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts existing remote branch names.
+* @throws {TypeError} If `remote` is not a valid non-empty string without
+*   whitespace or control characters.
 * @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 *
@@ -205,6 +208,9 @@ function gitBranch(options) {
 * ~~~~
 */
 function gitRemoteBranch(remote, options) {
+	const expectedMessage = "Expected remote to be a non-empty string without whitespace or control characters";
+	if (typeof remote !== "string") throw new TypeError(`${expectedMessage}, but got: ${remote === null ? "null" : Array.isArray(remote) ? "array" : typeof remote}.`);
+	if (remote === "" || /[\s\x00-\x1f]/.test(remote)) throw new TypeError(`${expectedMessage}, but got: ${JSON.stringify(remote)}.`);
 	const metavar = options?.metavar ?? METAVAR_BRANCH;
 	return createAsyncValueParser(options, metavar, async (dir, input, errors) => {
 		try {
@@ -217,13 +223,34 @@ function gitRemoteBranch(remote, options) {
 				success: true,
 				value: input
 			};
+			if (branches.length === 0) {
+				const remotes = await git.listRemotes({
+					fs: gitFs,
+					dir
+				});
+				const names = remotes.map((r) => r.remote);
+				if (!names.includes(remote)) {
+					if (errors?.remoteNotFound) return {
+						success: false,
+						error: errors.remoteNotFound(remote, names)
+					};
+					if (errors?.notFound) return {
+						success: false,
+						error: errors.notFound(input, branches)
+					};
+					return {
+						success: false,
+						error: message`Remote ${value(remote)} does not exist.${names.length > 0 ? message` Available remotes: ${valueSet(names, "")}` : message``}`
+					};
+				}
+			}
 			if (errors?.notFound) return {
 				success: false,
 				error: errors.notFound(input, branches)
 			};
 			return {
 				success: false,
-				error: message`Remote branch ${value(input)} does not exist on remote ${value(remote)}. Available branches: ${valueSet(branches)}`
+				error: message`Remote branch ${value(input)} does not exist on remote ${value(remote)}.${branches.length > 0 ? message` Available branches: ${valueSet(branches, "")}` : message``}`
 			};
 		} catch (error) {
 			const fallback = message`Failed to list remote branches. Ensure remote ${value(remote)} exists.`;
@@ -279,7 +306,7 @@ function gitTag(options) {
 			};
 			return {
 				success: false,
-				error: message`Tag ${value(input)} does not exist. Available tags: ${valueSet(tags)}`
+				error: message`Tag ${value(input)} does not exist.${tags.length > 0 ? message` Available tags: ${valueSet(tags, "")}` : message``}`
 			};
 		} catch (error) {
 			const fallback = message`Failed to list tags. Ensure ${value(dir)} is a valid git repository.`;
@@ -334,7 +361,7 @@ function gitRemote(options) {
 			};
 			return {
 				success: false,
-				error: message`Remote ${value(input)} does not exist. Available remotes: ${valueSet(names)}`
+				error: message`Remote ${value(input)} does not exist.${names.length > 0 ? message` Available remotes: ${valueSet(names, "")}` : message``}`
 			};
 		} catch (error) {
 			const fallback = message`Failed to list remotes. Ensure ${value(dir)} is a valid git repository.`;
@@ -549,7 +576,8 @@ function gitRef(options) {
 * @param options Shared configuration for the parsers.
 * @returns An object containing git parsers.  Each returned method may throw
 *   a {@link RangeError} if the merged `suggestionDepth` is not a positive
-*   integer.
+*   integer.  `remoteBranch()` may also throw a {@link TypeError} if `remote`
+*   is not a valid non-empty string without whitespace or control characters.
 * @since 0.9.0
 */
 function createGitParsers(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/git",
-  "version": "1.0.0-dev.908+f60f037d",
+  "version": "1.0.0",
   "description": "Git value parsers for Optique",
   "keywords": [
     "CLI",
@@ -57,9 +57,9 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@logtape/logtape": "^1.2.2",
+    "@logtape/logtape": "^2.0.4",
     "isomorphic-git": "^1.36.1",
-    "@optique/core": "1.0.0-dev.908+f60f037d"
+    "@optique/core": "1.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.19.9",