@optique/git 1.0.0-dev.786 → 1.0.0-dev.885

package/dist/index.cjs

@@ -78,6 +78,14 @@ function listFailureMessage(error, dir, errors, fallback) {
 const DEFAULT_SUGGESTION_DEPTH = 15;
 function createAsyncValueParser(options, metavar, parseFn, suggestFn) {
 	(0, __optique_core_nonempty.ensureNonEmptyString)(metavar);
+	if (options?.suggestionDepth !== void 0) {
+		if (!Number.isInteger(options.suggestionDepth) || options.suggestionDepth < 1) {
+			const depth = options.suggestionDepth;
+			const repr = typeof depth === "number" ? String(depth) : typeof depth === "string" ? JSON.stringify(depth) : `${typeof depth} ${String(depth)}`;
+			throw new RangeError(`Invalid suggestionDepth (must be a positive integer): ${repr}`);
+		}
+	}
+	const validatedDepth = options?.suggestionDepth ?? DEFAULT_SUGGESTION_DEPTH;
 	return {
 		$mode: "async",
 		metavar,
@@ -90,10 +98,7 @@ function createAsyncValueParser(options, metavar, parseFn, suggestFn) {
 		},
 		async *suggest(prefix) {
 			const dir = getRepoDir(options?.dir);
-			if (suggestFn) {
-				const depth = options?.suggestionDepth ?? DEFAULT_SUGGESTION_DEPTH;
-				yield* suggestFn(dir, prefix, depth);
-			}
+			if (suggestFn) yield* suggestFn(dir, prefix, validatedDepth);
 		}
 	};
 }
@@ -105,6 +110,7 @@ function createAsyncValueParser(options, metavar, parseFn, suggestFn) {
 *
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts existing branch names.
+* @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 *
 * @example
@@ -170,6 +176,7 @@ 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 {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 *
 * @example
@@ -234,6 +241,7 @@ function gitRemoteBranch(remote, options) {
 *
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts existing tag names.
+* @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 */
 function gitTag(options) {
@@ -287,6 +295,7 @@ function gitTag(options) {
 *
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts existing remote names.
+* @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 */
 function gitRemote(options) {
@@ -344,6 +353,7 @@ function gitRemote(options) {
 *
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts existing commit SHAs.
+* @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 */
 function gitCommit(options) {
@@ -391,7 +401,7 @@ function gitCommit(options) {
 				depth
 			});
 			for (const commit of commits) if (commit.oid.startsWith(prefix)) {
-				const shortOid = commit.oid.slice(0, 7);
+				const shortOid = commit.oid.slice(0, Math.max(7, prefix.length));
 				const firstLine = commit.commit.message.split("\n")[0];
 				yield {
 					kind: "literal",
@@ -416,6 +426,7 @@ function gitCommit(options) {
 *
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts any git reference.
+* @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 */
 function gitRef(options) {
@@ -474,16 +485,25 @@ function gitRef(options) {
 					depth
 				})
 			]);
-			for (const branch of branches) if (branch.startsWith(prefix)) yield {
-				kind: "literal",
-				text: branch
-			};
-			for (const tag of tags) if (tag.startsWith(prefix)) yield {
-				kind: "literal",
-				text: tag
-			};
+			const seen = /* @__PURE__ */ new Set();
+			for (const branch of branches) if (branch.startsWith(prefix) && !seen.has(branch)) {
+				seen.add(branch);
+				yield {
+					kind: "literal",
+					text: branch
+				};
+			}
+			for (const tag of tags) if (tag.startsWith(prefix) && !seen.has(tag)) {
+				seen.add(tag);
+				yield {
+					kind: "literal",
+					text: tag
+				};
+			}
 			for (const commit of commits) if (commit.oid.startsWith(prefix)) {
-				const shortOid = commit.oid.slice(0, 7);
+				const shortOid = commit.oid.slice(0, Math.max(7, prefix.length));
+				if (seen.has(shortOid)) continue;
+				seen.add(shortOid);
 				const firstLine = commit.commit.message.split("\n")[0];
 				yield {
 					kind: "literal",
@@ -504,7 +524,9 @@ function gitRef(options) {
 * Creates a set of git parsers with shared configuration.
 *
 * @param options Shared configuration for the parsers.
-* @returns An object containing git parsers.
+* @returns An object containing git parsers.  Each returned method may throw
+*   a {@link RangeError} if the merged `suggestionDepth` is not a positive
+*   integer.
 * @since 0.9.0
 */
 function createGitParsers(options) {

package/dist/index.d.cts

@@ -29,7 +29,9 @@ interface GitParserOptions {
   errors?: GitParserErrors;
   /**
    * Maximum number of recent commits to include in shell completion suggestions.
-   * Only applies to `gitCommit()` and `gitRef()` parsers.
+   * Only affects suggestions from `gitCommit()` and `gitRef()` parsers, but
+   * is validated by all git parser functions.
+   * Must be a positive integer.
    * Defaults to 15.
    *
    * @since 0.9.0
@@ -77,6 +79,7 @@ interface GitParsers {
    * Creates a value parser that validates local branch names.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts existing branch names.
+   * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   branch(options?: GitParserOptions): ValueParser<"async", string>;
   /**
@@ -84,24 +87,28 @@ 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 {RangeError} If `suggestionDepth` is not a positive integer.
    */
   remoteBranch(remote: string, options?: GitParserOptions): ValueParser<"async", string>;
   /**
    * Creates a value parser that validates tag names.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts existing tag names.
+   * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   tag(options?: GitParserOptions): ValueParser<"async", string>;
   /**
    * Creates a value parser that validates remote names.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts existing remote names.
+   * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   remote(options?: GitParserOptions): ValueParser<"async", string>;
   /**
    * Creates a value parser that validates commit SHAs.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts existing commit SHAs.
+   * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   commit(options?: GitParserOptions): ValueParser<"async", string>;
   /**
@@ -109,6 +116,7 @@ interface GitParsers {
    * Accepts branch names, tag names, or commit SHAs.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts any git reference.
+   * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   ref(options?: GitParserOptions): ValueParser<"async", string>;
 }
@@ -120,6 +128,7 @@ interface GitParsers {
  *
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts existing branch names.
+ * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  *
  * @example
@@ -140,6 +149,7 @@ 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 {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  *
  * @example
@@ -156,6 +166,7 @@ declare function gitRemoteBranch(remote: string, options?: GitParserOptions): Va
  *
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts existing tag names.
+ * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  */
 declare function gitTag(options?: GitParserOptions): ValueParser<"async", string>;
@@ -164,6 +175,7 @@ declare function gitTag(options?: GitParserOptions): ValueParser<"async", string
  *
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts existing remote names.
+ * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  */
 declare function gitRemote(options?: GitParserOptions): ValueParser<"async", string>;
@@ -175,6 +187,7 @@ declare function gitRemote(options?: GitParserOptions): ValueParser<"async", str
  *
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts existing commit SHAs.
+ * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  */
 declare function gitCommit(options?: GitParserOptions): ValueParser<"async", string>;
@@ -186,6 +199,7 @@ declare function gitCommit(options?: GitParserOptions): ValueParser<"async", str
  *
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts any git reference.
+ * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  */
 declare function gitRef(options?: GitParserOptions): ValueParser<"async", string>;
@@ -193,7 +207,9 @@ declare function gitRef(options?: GitParserOptions): ValueParser<"async", string
  * Creates a set of git parsers with shared configuration.
  *
  * @param options Shared configuration for the parsers.
- * @returns An object containing git parsers.
+ * @returns An object containing git parsers.  Each returned method may throw
+ *   a {@link RangeError} if the merged `suggestionDepth` is not a positive
+ *   integer.
  * @since 0.9.0
  */
 declare function createGitParsers(options?: GitParserOptions): GitParsers;

package/dist/index.d.ts

@@ -29,7 +29,9 @@ interface GitParserOptions {
   errors?: GitParserErrors;
   /**
    * Maximum number of recent commits to include in shell completion suggestions.
-   * Only applies to `gitCommit()` and `gitRef()` parsers.
+   * Only affects suggestions from `gitCommit()` and `gitRef()` parsers, but
+   * is validated by all git parser functions.
+   * Must be a positive integer.
    * Defaults to 15.
    *
    * @since 0.9.0
@@ -77,6 +79,7 @@ interface GitParsers {
    * Creates a value parser that validates local branch names.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts existing branch names.
+   * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   branch(options?: GitParserOptions): ValueParser<"async", string>;
   /**
@@ -84,24 +87,28 @@ 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 {RangeError} If `suggestionDepth` is not a positive integer.
    */
   remoteBranch(remote: string, options?: GitParserOptions): ValueParser<"async", string>;
   /**
    * Creates a value parser that validates tag names.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts existing tag names.
+   * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   tag(options?: GitParserOptions): ValueParser<"async", string>;
   /**
    * Creates a value parser that validates remote names.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts existing remote names.
+   * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   remote(options?: GitParserOptions): ValueParser<"async", string>;
   /**
    * Creates a value parser that validates commit SHAs.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts existing commit SHAs.
+   * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   commit(options?: GitParserOptions): ValueParser<"async", string>;
   /**
@@ -109,6 +116,7 @@ interface GitParsers {
    * Accepts branch names, tag names, or commit SHAs.
    * @param options Configuration options for the parser.
    * @returns A value parser that accepts any git reference.
+   * @throws {RangeError} If `suggestionDepth` is not a positive integer.
    */
   ref(options?: GitParserOptions): ValueParser<"async", string>;
 }
@@ -120,6 +128,7 @@ interface GitParsers {
  *
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts existing branch names.
+ * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  *
  * @example
@@ -140,6 +149,7 @@ 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 {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  *
  * @example
@@ -156,6 +166,7 @@ declare function gitRemoteBranch(remote: string, options?: GitParserOptions): Va
  *
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts existing tag names.
+ * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  */
 declare function gitTag(options?: GitParserOptions): ValueParser<"async", string>;
@@ -164,6 +175,7 @@ declare function gitTag(options?: GitParserOptions): ValueParser<"async", string
  *
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts existing remote names.
+ * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  */
 declare function gitRemote(options?: GitParserOptions): ValueParser<"async", string>;
@@ -175,6 +187,7 @@ declare function gitRemote(options?: GitParserOptions): ValueParser<"async", str
  *
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts existing commit SHAs.
+ * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  */
 declare function gitCommit(options?: GitParserOptions): ValueParser<"async", string>;
@@ -186,6 +199,7 @@ declare function gitCommit(options?: GitParserOptions): ValueParser<"async", str
  *
  * @param options Configuration options for the parser.
  * @returns A value parser that accepts any git reference.
+ * @throws {RangeError} If `suggestionDepth` is not a positive integer.
  * @since 0.9.0
  */
 declare function gitRef(options?: GitParserOptions): ValueParser<"async", string>;
@@ -193,7 +207,9 @@ declare function gitRef(options?: GitParserOptions): ValueParser<"async", string
  * Creates a set of git parsers with shared configuration.
  *
  * @param options Shared configuration for the parsers.
- * @returns An object containing git parsers.
+ * @returns An object containing git parsers.  Each returned method may throw
+ *   a {@link RangeError} if the merged `suggestionDepth` is not a positive
+ *   integer.
  * @since 0.9.0
  */
 declare function createGitParsers(options?: GitParserOptions): GitParsers;

package/dist/index.js

@@ -56,6 +56,14 @@ function listFailureMessage(error, dir, errors, fallback) {
 const DEFAULT_SUGGESTION_DEPTH = 15;
 function createAsyncValueParser(options, metavar, parseFn, suggestFn) {
 	ensureNonEmptyString(metavar);
+	if (options?.suggestionDepth !== void 0) {
+		if (!Number.isInteger(options.suggestionDepth) || options.suggestionDepth < 1) {
+			const depth = options.suggestionDepth;
+			const repr = typeof depth === "number" ? String(depth) : typeof depth === "string" ? JSON.stringify(depth) : `${typeof depth} ${String(depth)}`;
+			throw new RangeError(`Invalid suggestionDepth (must be a positive integer): ${repr}`);
+		}
+	}
+	const validatedDepth = options?.suggestionDepth ?? DEFAULT_SUGGESTION_DEPTH;
 	return {
 		$mode: "async",
 		metavar,
@@ -68,10 +76,7 @@ function createAsyncValueParser(options, metavar, parseFn, suggestFn) {
 		},
 		async *suggest(prefix) {
 			const dir = getRepoDir(options?.dir);
-			if (suggestFn) {
-				const depth = options?.suggestionDepth ?? DEFAULT_SUGGESTION_DEPTH;
-				yield* suggestFn(dir, prefix, depth);
-			}
+			if (suggestFn) yield* suggestFn(dir, prefix, validatedDepth);
 		}
 	};
 }
@@ -83,6 +88,7 @@ function createAsyncValueParser(options, metavar, parseFn, suggestFn) {
 *
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts existing branch names.
+* @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 *
 * @example
@@ -148,6 +154,7 @@ 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 {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 *
 * @example
@@ -212,6 +219,7 @@ function gitRemoteBranch(remote, options) {
 *
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts existing tag names.
+* @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 */
 function gitTag(options) {
@@ -265,6 +273,7 @@ function gitTag(options) {
 *
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts existing remote names.
+* @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 */
 function gitRemote(options) {
@@ -322,6 +331,7 @@ function gitRemote(options) {
 *
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts existing commit SHAs.
+* @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 */
 function gitCommit(options) {
@@ -369,7 +379,7 @@ function gitCommit(options) {
 				depth
 			});
 			for (const commit of commits) if (commit.oid.startsWith(prefix)) {
-				const shortOid = commit.oid.slice(0, 7);
+				const shortOid = commit.oid.slice(0, Math.max(7, prefix.length));
 				const firstLine = commit.commit.message.split("\n")[0];
 				yield {
 					kind: "literal",
@@ -394,6 +404,7 @@ function gitCommit(options) {
 *
 * @param options Configuration options for the parser.
 * @returns A value parser that accepts any git reference.
+* @throws {RangeError} If `suggestionDepth` is not a positive integer.
 * @since 0.9.0
 */
 function gitRef(options) {
@@ -452,16 +463,25 @@ function gitRef(options) {
 					depth
 				})
 			]);
-			for (const branch of branches) if (branch.startsWith(prefix)) yield {
-				kind: "literal",
-				text: branch
-			};
-			for (const tag of tags) if (tag.startsWith(prefix)) yield {
-				kind: "literal",
-				text: tag
-			};
+			const seen = /* @__PURE__ */ new Set();
+			for (const branch of branches) if (branch.startsWith(prefix) && !seen.has(branch)) {
+				seen.add(branch);
+				yield {
+					kind: "literal",
+					text: branch
+				};
+			}
+			for (const tag of tags) if (tag.startsWith(prefix) && !seen.has(tag)) {
+				seen.add(tag);
+				yield {
+					kind: "literal",
+					text: tag
+				};
+			}
 			for (const commit of commits) if (commit.oid.startsWith(prefix)) {
-				const shortOid = commit.oid.slice(0, 7);
+				const shortOid = commit.oid.slice(0, Math.max(7, prefix.length));
+				if (seen.has(shortOid)) continue;
+				seen.add(shortOid);
 				const firstLine = commit.commit.message.split("\n")[0];
 				yield {
 					kind: "literal",
@@ -482,7 +502,9 @@ function gitRef(options) {
 * Creates a set of git parsers with shared configuration.
 *
 * @param options Shared configuration for the parsers.
-* @returns An object containing git parsers.
+* @returns An object containing git parsers.  Each returned method may throw
+*   a {@link RangeError} if the merged `suggestionDepth` is not a positive
+*   integer.
 * @since 0.9.0
 */
 function createGitParsers(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/git",
-  "version": "1.0.0-dev.786+3143e832",
+  "version": "1.0.0-dev.885+3300ebe1",
   "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.786+3143e832"
+    "@optique/core": "1.0.0-dev.885+3300ebe1"
   },
   "devDependencies": {
     "@types/node": "^20.19.9",