Skip to content

Piero Bosio Social Web Site Personale Logo Fediverso

Social Forum federato con il resto del mondo. Non contano le istanze, contano le persone

Stop writing if statements for your CLI flags

  • If you've built CLI tools, you've written code like this:

    if (opts.reporter === "junit" && !opts.outputFile) {
      throw new Error("--output-file is required for junit reporter");
    }
    if (opts.reporter === "html" && !opts.outputFile) {
      throw new Error("--output-file is required for html reporter");
    }
    if (opts.reporter === "console" && opts.outputFile) {
      console.warn("--output-file is ignored for console reporter");
    }
    

    A few months ago, I wrote Stop writing CLI validation. Parse it right the first time. about parsing individual option values correctly. But it didn't cover the relationships between options.

    In the code above, --output-file only makes sense when --reporter is junit or html. When it's console, the option shouldn't exist at all.

    We're using TypeScript. We have a powerful type system. And yet, here we are, writing runtime checks that the compiler can't help with. Every time we add a new reporter type, we need to remember to update these checks. Every time we refactor, we hope we didn't miss one.

    The state of TypeScript CLI parsers

    The old guard—Commander, yargs, minimist—were built before TypeScript became mainstream. They give you bags of strings and leave type safety as an exercise for the reader.

    But we've made progress. Modern TypeScript-first libraries like cmd-ts and Clipanion (the library powering Yarn Berry) take types seriously:

    // cmd-ts
    const app = command({
      args: {
        reporter: option({ type: string, long: 'reporter' }),
        outputFile: option({ type: string, long: 'output-file' }),
      },
      handler: (args) => {
        // args.reporter: string
        // args.outputFile: string
      },
    });
    
    // Clipanion
    class TestCommand extends Command {
      reporter = Option.String('--reporter');
      outputFile = Option.String('--output-file');
    }
    

    These libraries infer types for individual options. --port is a number. --verbose is a boolean. That's real progress.

    But here's what they can't do: express that --output-file is required when --reporter is junit, and forbidden when --reporter is console. The relationship between options isn't captured in the type system.

    So you end up writing validation code anyway:

    handler: (args) => {
      // Both cmd-ts and Clipanion need this
      if (args.reporter === "junit" && !args.outputFile) {
        throw new Error("--output-file required for junit");
      }
      // args.outputFile is still string | undefined
      // TypeScript doesn't know it's definitely string when reporter is "junit"
    }
    

    Rust's clap and Python's Click have requires and conflicts_with attributes, but those are runtime checks too. They don't change the result type.

    If the parser configuration knows about option relationships, why doesn't that knowledge show up in the result type?

    Modeling relationships with conditional()

    Optique treats option relationships as a first-class concept. Here's the test reporter scenario:

    import { conditional, object } from "@optique/core/constructs";
    import { option } from "@optique/core/primitives";
    import { choice, string } from "@optique/core/valueparser";
    import { run } from "@optique/run";
    
    const parser = conditional(
      option("--reporter", choice(["console", "junit", "html"])),
      {
        console: object({}),
        junit: object({
          outputFile: option("--output-file", string()),
        }),
        html: object({
          outputFile: option("--output-file", string()),
          openBrowser: option("--open-browser"),
        }),
      }
    );
    
    const [reporter, config] = run(parser);
    

    The conditional() combinator takes a discriminator option (--reporter) and a map of branches. Each branch defines what other options are valid for that discriminator value.

    TypeScript infers the result type automatically:

    type Result =
      | ["console", {}]
      | ["junit", { outputFile: string }]
      | ["html", { outputFile: string; openBrowser: boolean }];
    

    When reporter is "junit", outputFile is string—not string | undefined. The relationship is encoded in the type.

    Now your business logic gets real type safety:

    const [reporter, config] = run(parser);
    
    switch (reporter) {
      case "console":
        runWithConsoleOutput();
        break;
      case "junit":
        // TypeScript knows config.outputFile is string
        writeJUnitReport(config.outputFile);
        break;
      case "html":
        // TypeScript knows config.outputFile and config.openBrowser exist
        writeHtmlReport(config.outputFile);
        if (config.openBrowser) openInBrowser(config.outputFile);
        break;
    }
    

    No validation code. No runtime checks. If you add a new reporter type and forget to handle it in the switch, the compiler tells you.

    A more complex example: database connections

    Test reporters are a nice example, but let's try something with more variation. Database connection strings:

    myapp --db=sqlite --file=./data.db
    myapp --db=postgres --host=localhost --port=5432 --user=admin
    myapp --db=mysql --host=localhost --port=3306 --user=root --ssl
    

    Each database type needs completely different options:

    • SQLite just needs a file path
    • PostgreSQL needs host, port, user, and optionally password
    • MySQL needs host, port, user, and has an SSL flag

    Here's how you model this:

    import { conditional, object } from "@optique/core/constructs";
    import { withDefault, optional } from "@optique/core/modifiers";
    import { option } from "@optique/core/primitives";
    import { choice, string, integer } from "@optique/core/valueparser";
    
    const dbParser = conditional(
      option("--db", choice(["sqlite", "postgres", "mysql"])),
      {
        sqlite: object({
          file: option("--file", string()),
        }),
        postgres: object({
          host: option("--host", string()),
          port: withDefault(option("--port", integer()), 5432),
          user: option("--user", string()),
          password: optional(option("--password", string())),
        }),
        mysql: object({
          host: option("--host", string()),
          port: withDefault(option("--port", integer()), 3306),
          user: option("--user", string()),
          ssl: option("--ssl"),
        }),
      }
    );
    

    The inferred type:

    type DbConfig =
      | ["sqlite", { file: string }]
      | ["postgres", { host: string; port: number; user: string; password?: string }]
      | ["mysql", { host: string; port: number; user: string; ssl: boolean }];
    

    Notice the details: PostgreSQL defaults to port 5432, MySQL to 3306. PostgreSQL has an optional password, MySQL has an SSL flag. Each database type has exactly the options it needs—no more, no less.

    With this structure, writing dbConfig.ssl when the mode is sqlite isn't a runtime error—it's a compile-time impossibility.

    Try expressing this with requires_if attributes. You can't. The relationships are too rich.

    The pattern is everywhere

    Once you see it, you find this pattern in many CLI tools:

    Authentication modes:

    const authParser = conditional(
      option("--auth", choice(["none", "basic", "token", "oauth"])),
      {
        none: object({}),
        basic: object({
          username: option("--username", string()),
          password: option("--password", string()),
        }),
        token: object({
          token: option("--token", string()),
        }),
        oauth: object({
          clientId: option("--client-id", string()),
          clientSecret: option("--client-secret", string()),
          tokenUrl: option("--token-url", url()),
        }),
      }
    );
    

    Deployment targets, output formats, connection protocols—anywhere you have a mode selector that determines what other options are valid.

    Why conditional() exists

    Optique already has an or() combinator for mutually exclusive alternatives. Why do we need conditional()?

    The or() combinator distinguishes branches based on structure—which options are present. It works well for subcommands like git commit vs git push, where the arguments differ completely.

    But in the reporter example, the structure is identical: every branch has a --reporter flag. The difference lies in the flag's value, not its presence.

    // This won't work as intended
    const parser = or(
      object({ reporter: option("--reporter", choice(["console"])) }),
      object({ 
        reporter: option("--reporter", choice(["junit", "html"])),
        outputFile: option("--output-file", string())
      }),
    );
    

    When you pass --reporter junit, or() tries to pick a branch based on what options are present. Both branches have --reporter, so it can't distinguish them structurally.

    conditional() solves this by reading the discriminator's value first, then selecting the appropriate branch. It bridges the gap between structural parsing and value-based decisions.

    The structure is the constraint

    Instead of parsing options into a loose type and then validating relationships, define a parser whose structure is the constraint.

    Traditional approach Optique approach
    Parse → Validate → Use Parse (with constraints) → Use
    Types and validation logic maintained separately Types reflect the constraints
    Mismatches found at runtime Mismatches found at compile time

    The parser definition becomes the single source of truth. Add a new reporter type? The parser definition changes, the inferred type changes, and the compiler shows you everywhere that needs updating.

    Try it

    If this resonates with a CLI you're building:

    Next time you're about to write an if statement checking option relationships, ask: could the parser express this constraint instead?

    The structure of your parser is the constraint. You might not need that validation code at all.

  • hongminhee@hollo.socialundefined hongminhee@hollo.social shared this topic on

Gli ultimi otto messaggi ricevuti dalla Federazione
Post suggeriti
  • Working with #JavaScript again.

    Uncategorized javascript
    1
    1
    0 Votes
    1 Posts
    3 Views
    Working with #JavaScript again.
  • 0 Votes
    1 Posts
    11 Views
    Anyone aware of #Javascript jobs at a not evil/impactful company? I’ve got 15 years of experience, fluent in React and NodeJS with Express. Experience with Postgres, SQLite and NoSQL databases. Got my last company Cyber Essentials Certified. Im proficient in dev ops and sys admin. Have a small (but growing!) portfolio of FOSS work.Have an extensive background in teaching programming too, so can mentor juniors. I LOVE mentoring. Have an academic background too. #GetFediHired boosts welcome 💖
  • 0 Votes
    1 Posts
    15 Views
    I just published v0.98 of #jSH, a #JavaScript scripting environment for #MSDOS. This is the 'little' text-mode brother to #DOjS. - updated curl, mbedTLS and ziphttps://github.com/SuperIlu/jSH#RetroComputing#FreeDOS#DJGPP#RetroDev#RetroDevelopment
  • 0 Votes
    1 Posts
    11 Views
    We're pleased to announce the release of Optique 0.5.0, which brings significant improvements to error handling, help text generation, and overall developer experience. This release maintains full backward compatibility, so you can upgrade without modifying existing code. Better code organization through module separation The large @optique/core/parser module has been refactored into three focused modules that better reflect their purposes. Primitive parsers like option() and argument() now live in @optique/core/primitives, modifier functions such as optional() and withDefault() have moved to @optique/core/modifiers, and combinator functions including object() and or() are now in @optique/core/constructs. // Before: everything from one module import { option, flag, argument, // primitives optional, withDefault, multiple, // modifiers object, or, merge // constructs } from "@optique/core/parser"; // After: organized imports (recommended) import { option, flag, argument } from "@optique/core/primitives"; import { optional, withDefault, multiple } from "@optique/core/modifiers"; import { object, or, merge } from "@optique/core/constructs"; While we recommend importing from these specialized modules for better clarity, all functions continue to be re-exported from the original @optique/core/parser module to ensure your existing code works unchanged. This reorganization makes the codebase more maintainable and helps developers understand the relationships between different parser types. Smarter error handling with automatic conversion One of the most requested features has been better error handling for default value callbacks in withDefault(). Previously, if your callback threw an error—say, when an environment variable wasn't set—that error would bubble up as a runtime exception. Starting with 0.5.0, these errors are automatically caught and converted to parser-level errors, providing consistent error formatting and proper exit codes. // Before (0.4.x): runtime exception that crashes the app const parser = object({ apiUrl: withDefault(option("--url", url()), () => { if (!process.env.API_URL) { throw new Error("API_URL not set"); // Uncaught exception! } return new URL(process.env.API_URL); }) }); // After (0.5.0): graceful parser error const parser = object({ apiUrl: withDefault(option("--url", url()), () => { if (!process.env.API_URL) { throw new Error("API_URL not set"); // Automatically caught and formatted } return new URL(process.env.API_URL); }) }); We've also introduced the WithDefaultError class, which accepts structured messages instead of plain strings. This means you can now throw errors with rich formatting that matches the rest of Optique's error output: import { WithDefaultError, message, envVar } from "@optique/core"; const parser = object({ // Plain error - automatically converted to text databaseUrl: withDefault(option("--db", url()), () => { if (!process.env.DATABASE_URL) { throw new Error("Database URL not configured"); } return new URL(process.env.DATABASE_URL); }), // Rich error with structured message apiToken: withDefault(option("--token", string()), () => { if (!process.env.API_TOKEN) { throw new WithDefaultError( message`Environment variable ${envVar("API_TOKEN")} is required for authentication` ); } return process.env.API_TOKEN; }) }); The new envVar message component ensures environment variables are visually distinct in error messages, appearing bold and underlined in colored output or wrapped in backticks in plain text. More helpful help text with custom default descriptions Default values in help text can sometimes be misleading, especially when they come from environment variables or are computed at runtime. Optique 0.5.0 allows you to customize how default values appear in help output through an optional third parameter to withDefault(). import { withDefault, message, envVar } from "@optique/core"; const parser = object({ // Before: shows actual URL value in help apiUrl: withDefault( option("--api-url", url()), new URL("https://api.example.com") ), // Help shows: --api-url URL [https://api.example.com] // After: shows descriptive text apiUrl: withDefault( option("--api-url", url()), new URL("https://api.example.com"), { message: message`Default API endpoint` } ), // Help shows: --api-url URL [Default API endpoint] }); This is particularly useful for environment variables and computed defaults: const parser = object({ // Environment variable authToken: withDefault( option("--token", string()), () => process.env.AUTH_TOKEN || "anonymous", { message: message`${envVar("AUTH_TOKEN")} or anonymous` } ), // Help shows: --token STRING [AUTH_TOKEN or anonymous] // Computed value workers: withDefault( option("--workers", integer()), () => os.cpus().length, { message: message`Number of CPU cores` } ), // Help shows: --workers INT [Number of CPU cores] // Sensitive information apiKey: withDefault( option("--api-key", string()), () => process.env.SECRET_KEY || "", { message: message`From secure storage` } ), // Help shows: --api-key STRING [From secure storage] }); Instead of displaying the actual default value, you can now show descriptive text that better explains where the value comes from. This is particularly useful for sensitive information like API tokens or for computed defaults like the number of CPU cores. The help system now properly handles ANSI color codes in default value displays, maintaining dim styling even when inner components have their own color formatting. This ensures default values remain visually distinct from the main help text. Comprehensive error message customization We've added a systematic way to customize error messages across all parser types and combinators. Every parser now accepts an errors option that lets you provide context-specific feedback instead of generic error messages. This applies to primitive parsers, value parsers, combinators, and even specialized parsers in companion packages. Primitive parser errors import { option, flag, argument, command } from "@optique/core/primitives"; import { message, optionName, metavar } from "@optique/core/message"; // Option parser with custom errors const serverPort = option("--port", integer(), { errors: { missing: message`Server port is required. Use ${optionName("--port")} to specify.`, invalidValue: (error) => message`Invalid port number: ${error}`, endOfInput: message`${optionName("--port")} requires a ${metavar("PORT")} number.` } }); // Command parser with custom errors const deployCommand = command("deploy", deployParser, { errors: { notMatched: (expected, actual) => message`Unknown command "${actual}". Did you mean "${expected}"?` } }); Value parser errors Error customization can be static messages for consistent errors or dynamic functions that incorporate the problematic input: import { integer, choice, string } from "@optique/core/valueparser"; // Integer with range validation const port = integer({ min: 1024, max: 65535, errors: { invalidInteger: message`Port must be a valid number.`, belowMinimum: (value, min) => message`Port ${String(value)} is reserved. Use ${String(min)} or higher.`, aboveMaximum: (value, max) => message`Port ${String(value)} exceeds maximum. Use ${String(max)} or lower.` } }); // Choice with helpful suggestions const logLevel = choice(["debug", "info", "warn", "error"], { errors: { invalidChoice: (input, choices) => message`"${input}" is not a valid log level. Choose from: ${values(choices)}.` } }); // String with pattern validation const email = string({ pattern: /^[^@]+@[^@]+\.[^@]+$/, errors: { patternMismatch: (input) => message`"${input}" is not a valid email address. Use format: user@example.com` } }); Combinator errors import { or, multiple, object } from "@optique/core/constructs"; // Or combinator with custom no-match error const format = or( flag("--json"), flag("--yaml"), flag("--xml"), { errors: { noMatch: message`Please specify an output format: --json, --yaml, or --xml.`, unexpectedInput: (token) => message`Unknown format option "${token}".` } } ); // Multiple parser with count validation const inputFiles = multiple(argument(string()), { min: 1, max: 5, errors: { tooFew: (count, min) => message`At least ${String(min)} file required, but got ${String(count)}.`, tooMany: (count, max) => message`Maximum ${String(max)} files allowed, but got ${String(count)}.` } }); Package-specific errors Both @optique/run and @optique/temporal packages have been updated with error customization support for their specialized parsers: // @optique/run path parser import { path } from "@optique/run/valueparser"; const configFile = option("--config", path({ mustExist: true, type: "file", extensions: [".json", ".yaml"], errors: { pathNotFound: (input) => message`Configuration file "${input}" not found. Please check the path.`, notAFile: (input) => message`"${input}" is a directory. Please specify a file.`, invalidExtension: (input, extensions, actual) => message`Invalid config format "${actual}". Use ${values(extensions)}.` } })); // @optique/temporal instant parser import { instant, duration } from "@optique/temporal"; const timestamp = option("--time", instant({ errors: { invalidFormat: (input) => message`"${input}" is not a valid timestamp. Use ISO 8601 format: 2024-01-01T12:00:00Z` } })); const timeout = option("--timeout", duration({ errors: { invalidFormat: (input) => message`"${input}" is not a valid duration. Use ISO 8601 format: PT30S (30 seconds), PT5M (5 minutes)` } })); Error customization integrates seamlessly with Optique's structured message format, ensuring consistent styling across all error output. The system helps you provide helpful, actionable feedback that guides users toward correct usage rather than leaving them confused by generic error messages. Looking forward This release focuses on improving the developer experience without breaking existing code. Every new feature is opt-in, and all changes maintain backward compatibility. We believe these improvements make Optique more pleasant to work with, especially when building user-friendly CLI applications that need clear error messages and helpful documentation. We're grateful to the community members who suggested these improvements and helped shape this release through discussions and issue reports. Your feedback continues to drive Optique's evolution toward being a more capable and ergonomic CLI parser for TypeScript. To upgrade to Optique 0.5.0, simply update your dependencies: npm update @optique/core @optique/run # or deno update For detailed migration guidance and API documentation, please refer to the official documentation. While no code changes are required, we encourage you to explore the new error customization options and help text improvements to enhance your CLI applications.