@optique/git 1.0.0-dev.1136 → 1.0.0-dev.1163

package/dist/index.cjs

@@ -215,6 +215,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 +229,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 {
@@ -592,7 +597,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

@@ -97,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>;
@@ -159,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
  *
@@ -219,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

@@ -97,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>;
@@ -159,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
  *
@@ -219,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

@@ -193,6 +193,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 +207,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 {
@@ -570,7 +575,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.1136+00dc9aa5",
+  "version": "1.0.0-dev.1163+65b042cd",
   "description": "Git value parsers for Optique",
   "keywords": [
     "CLI",
@@ -59,7 +59,7 @@
   "dependencies": {
     "@logtape/logtape": "^1.2.2",
     "isomorphic-git": "^1.36.1",
-    "@optique/core": "1.0.0-dev.1136+00dc9aa5"
+    "@optique/core": "1.0.0-dev.1163+65b042cd"
   },
   "devDependencies": {
     "@types/node": "^20.19.9",