@optique/logtape 1.0.0-dev.1410 → 1.0.0-dev.1424

package/dist/index.cjs

@@ -42,6 +42,17 @@ const LOG_LEVELS = [
 	"fatal"
 ];
 /**
+* Validates that the given value is a valid {@link LogLevel}.
+*
+* @param value The value to validate.
+* @param paramName The parameter name for the error message.
+* @throws {TypeError} If the value is not a valid log level.
+* @since 1.0.0
+*/
+function validateLogLevel(value, paramName) {
+	if (!LOG_LEVELS.includes(value)) throw new TypeError(`Invalid log level for ${paramName}: ${String(value)}.  Expected ${LOG_LEVELS.map((l) => `"${l}"`).join(", ")}.`);
+}
+/**
 * Creates a {@link ValueParser} for LogTape log levels.
 *
 * This parser validates that the input is one of the valid LogTape severity
@@ -114,6 +125,7 @@ const WARNING_INDEX = 2;
 *
 * @param options Configuration options for the verbosity parser.
 * @returns A {@link Parser} that produces a {@link LogLevel}.
+* @throws {TypeError} If `baseLevel` is not a valid log level.
 *
 * @example Basic usage
 * ```typescript
@@ -148,6 +160,7 @@ function verbosity(options = {}) {
 	const short = options.short ?? "-v";
 	const long = options.long ?? "--verbose";
 	const baseLevel = options.baseLevel ?? "warning";
+	validateLogLevel(baseLevel, "baseLevel");
 	const baseIndex = VERBOSITY_LEVELS.indexOf(baseLevel);
 	const effectiveBaseIndex = baseIndex >= 0 ? baseIndex : WARNING_INDEX;
 	const flagParser = (0, __optique_core_primitives.flag)(short, long, { description: options.description ?? __optique_core_message.message`Be more verbose. Can be repeated.` });
@@ -170,6 +183,8 @@ function verbosity(options = {}) {
 *
 * @param options Configuration options for the debug flag parser.
 * @returns A {@link Parser} that produces a {@link LogLevel}.
+* @throws {TypeError} If `debugLevel` or `normalLevel` is not a valid log
+*   level.
 *
 * @example Basic usage
 * ```typescript
@@ -203,6 +218,8 @@ function debug(options = {}) {
 	const long = options.long ?? "--debug";
 	const debugLevel = options.debugLevel ?? "debug";
 	const normalLevel = options.normalLevel ?? "info";
+	validateLogLevel(debugLevel, "debugLevel");
+	validateLogLevel(normalLevel, "normalLevel");
 	const flagParser = (0, __optique_core_primitives.flag)(short, long, { description: options.description ?? __optique_core_message.message`Enable debug logging.` });
 	return (0, __optique_core_modifiers.map)((0, __optique_core_modifiers.optional)(flagParser), (value) => {
 		return value === true ? debugLevel : normalLevel;
@@ -460,6 +477,9 @@ Original error: ${e}`);
 * // --debug
 * ```
 *
+* @throws {TypeError} If the `level` discriminant is not one of `"option"`,
+*   `"verbosity"`, or `"debug"`, or if a log level option (`default`,
+*   `debugLevel`, `normalLevel`, or `baseLevel`) is not a valid log level.
 * @since 0.8.0
 */
 function loggingOptions(config) {
@@ -472,6 +492,7 @@ function loggingOptions(config) {
 			const long = config.long ?? "--log-level";
 			const short = config.short ?? "-l";
 			const defaultLevel = config.default ?? "info";
+			validateLogLevel(defaultLevel, "default");
 			levelParser = (0, __optique_core_modifiers.withDefault)((0, __optique_core_primitives.option)(short, long, logLevel()), defaultLevel);
 			break;
 		}
@@ -494,6 +515,7 @@ function loggingOptions(config) {
 			levelParser = debug(debugOptions);
 			break;
 		}
+		default: throw new TypeError(`Unsupported level configuration: ${String(config.level)}.  Expected "option", "verbosity", or "debug".`);
 	}
 	const defaultOutput = { type: "console" };
 	const outputParser = (0, __optique_core_modifiers.withDefault)(logOutput({ long: outputLong }), defaultOutput);

package/dist/index.d.cts

@@ -8,6 +8,15 @@ import { Parser } from "@optique/core/parser";
  * All valid log levels in order from lowest to highest severity.
  */
 declare const LOG_LEVELS: readonly LogLevel$1[];
+/**
+ * Validates that the given value is a valid {@link LogLevel}.
+ *
+ * @param value The value to validate.
+ * @param paramName The parameter name for the error message.
+ * @throws {TypeError} If the value is not a valid log level.
+ * @since 1.0.0
+ */
+
 /**
  * Options for creating a log level value parser.
  * @since 0.8.0
@@ -105,6 +114,7 @@ interface VerbosityOptions {
  *
  * @param options Configuration options for the verbosity parser.
  * @returns A {@link Parser} that produces a {@link LogLevel}.
+ * @throws {TypeError} If `baseLevel` is not a valid log level.
  *
  * @example Basic usage
  * ```typescript
@@ -177,6 +187,8 @@ interface DebugOptions {
  *
  * @param options Configuration options for the debug flag parser.
  * @returns A {@link Parser} that produces a {@link LogLevel}.
+ * @throws {TypeError} If `debugLevel` or `normalLevel` is not a valid log
+ *   level.
  *
  * @example Basic usage
  * ```typescript
@@ -571,6 +583,9 @@ type LoggingOptionsConfig = LoggingOptionsWithLevel | LoggingOptionsWithVerbosit
  * // --debug
  * ```
  *
+ * @throws {TypeError} If the `level` discriminant is not one of `"option"`,
+ *   `"verbosity"`, or `"debug"`, or if a log level option (`default`,
+ *   `debugLevel`, `normalLevel`, or `baseLevel`) is not a valid log level.
  * @since 0.8.0
  */
 declare function loggingOptions(config: LoggingOptionsConfig): Parser<"sync", LoggingOptionsResult, unknown>;

package/dist/index.d.ts

@@ -8,6 +8,15 @@ import { Parser } from "@optique/core/parser";
  * All valid log levels in order from lowest to highest severity.
  */
 declare const LOG_LEVELS: readonly LogLevel$1[];
+/**
+ * Validates that the given value is a valid {@link LogLevel}.
+ *
+ * @param value The value to validate.
+ * @param paramName The parameter name for the error message.
+ * @throws {TypeError} If the value is not a valid log level.
+ * @since 1.0.0
+ */
+
 /**
  * Options for creating a log level value parser.
  * @since 0.8.0
@@ -105,6 +114,7 @@ interface VerbosityOptions {
  *
  * @param options Configuration options for the verbosity parser.
  * @returns A {@link Parser} that produces a {@link LogLevel}.
+ * @throws {TypeError} If `baseLevel` is not a valid log level.
  *
  * @example Basic usage
  * ```typescript
@@ -177,6 +187,8 @@ interface DebugOptions {
  *
  * @param options Configuration options for the debug flag parser.
  * @returns A {@link Parser} that produces a {@link LogLevel}.
+ * @throws {TypeError} If `debugLevel` or `normalLevel` is not a valid log
+ *   level.
  *
  * @example Basic usage
  * ```typescript
@@ -571,6 +583,9 @@ type LoggingOptionsConfig = LoggingOptionsWithLevel | LoggingOptionsWithVerbosit
  * // --debug
  * ```
  *
+ * @throws {TypeError} If the `level` discriminant is not one of `"option"`,
+ *   `"verbosity"`, or `"debug"`, or if a log level option (`default`,
+ *   `debugLevel`, `normalLevel`, or `baseLevel`) is not a valid log level.
  * @since 0.8.0
  */
 declare function loggingOptions(config: LoggingOptionsConfig): Parser<"sync", LoggingOptionsResult, unknown>;

package/dist/index.js

@@ -19,6 +19,17 @@ const LOG_LEVELS = [
 	"fatal"
 ];
 /**
+* Validates that the given value is a valid {@link LogLevel}.
+*
+* @param value The value to validate.
+* @param paramName The parameter name for the error message.
+* @throws {TypeError} If the value is not a valid log level.
+* @since 1.0.0
+*/
+function validateLogLevel(value, paramName) {
+	if (!LOG_LEVELS.includes(value)) throw new TypeError(`Invalid log level for ${paramName}: ${String(value)}.  Expected ${LOG_LEVELS.map((l) => `"${l}"`).join(", ")}.`);
+}
+/**
 * Creates a {@link ValueParser} for LogTape log levels.
 *
 * This parser validates that the input is one of the valid LogTape severity
@@ -91,6 +102,7 @@ const WARNING_INDEX = 2;
 *
 * @param options Configuration options for the verbosity parser.
 * @returns A {@link Parser} that produces a {@link LogLevel}.
+* @throws {TypeError} If `baseLevel` is not a valid log level.
 *
 * @example Basic usage
 * ```typescript
@@ -125,6 +137,7 @@ function verbosity(options = {}) {
 	const short = options.short ?? "-v";
 	const long = options.long ?? "--verbose";
 	const baseLevel = options.baseLevel ?? "warning";
+	validateLogLevel(baseLevel, "baseLevel");
 	const baseIndex = VERBOSITY_LEVELS.indexOf(baseLevel);
 	const effectiveBaseIndex = baseIndex >= 0 ? baseIndex : WARNING_INDEX;
 	const flagParser = flag(short, long, { description: options.description ?? message`Be more verbose. Can be repeated.` });
@@ -147,6 +160,8 @@ function verbosity(options = {}) {
 *
 * @param options Configuration options for the debug flag parser.
 * @returns A {@link Parser} that produces a {@link LogLevel}.
+* @throws {TypeError} If `debugLevel` or `normalLevel` is not a valid log
+*   level.
 *
 * @example Basic usage
 * ```typescript
@@ -180,6 +195,8 @@ function debug(options = {}) {
 	const long = options.long ?? "--debug";
 	const debugLevel = options.debugLevel ?? "debug";
 	const normalLevel = options.normalLevel ?? "info";
+	validateLogLevel(debugLevel, "debugLevel");
+	validateLogLevel(normalLevel, "normalLevel");
 	const flagParser = flag(short, long, { description: options.description ?? message`Enable debug logging.` });
 	return map(optional(flagParser), (value) => {
 		return value === true ? debugLevel : normalLevel;
@@ -437,6 +454,9 @@ Original error: ${e}`);
 * // --debug
 * ```
 *
+* @throws {TypeError} If the `level` discriminant is not one of `"option"`,
+*   `"verbosity"`, or `"debug"`, or if a log level option (`default`,
+*   `debugLevel`, `normalLevel`, or `baseLevel`) is not a valid log level.
 * @since 0.8.0
 */
 function loggingOptions(config) {
@@ -449,6 +469,7 @@ function loggingOptions(config) {
 			const long = config.long ?? "--log-level";
 			const short = config.short ?? "-l";
 			const defaultLevel = config.default ?? "info";
+			validateLogLevel(defaultLevel, "default");
 			levelParser = withDefault(option(short, long, logLevel()), defaultLevel);
 			break;
 		}
@@ -471,6 +492,7 @@ function loggingOptions(config) {
 			levelParser = debug(debugOptions);
 			break;
 		}
+		default: throw new TypeError(`Unsupported level configuration: ${String(config.level)}.  Expected "option", "verbosity", or "debug".`);
 	}
 	const defaultOutput = { type: "console" };
 	const outputParser = withDefault(logOutput({ long: outputLong }), defaultOutput);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/logtape",
-  "version": "1.0.0-dev.1410+b8ee2165",
+  "version": "1.0.0-dev.1424+71e81eec",
   "description": "LogTape logging integration for Optique CLI parser",
   "keywords": [
     "CLI",
@@ -63,7 +63,7 @@
     }
   },
   "dependencies": {
-    "@optique/core": "1.0.0-dev.1410+b8ee2165"
+    "@optique/core": "1.0.0-dev.1424+71e81eec"
   },
   "devDependencies": {
     "@logtape/file": "^2.0.4",