Skip to content

Better documentation and error messages for verbose option in lychee.toml #1903

@user27182

Description

@user27182

I can use the --verbose flag with CLI as lychee . --verbose.

But if I want to move this to lychee.toml, it's not currently obvious how to do this. I tried verbose = true, but got this error:

% lychee .          
   [ERROR] Error while loading config: Cannot load default configuration file `lychee.toml`: Failed to parse configuration file

Caused by:
    TOML parse error at line 17, column 11
       |
    17 | verbose = true
       |           ^^^^
    invalid type: boolean `true`, expected a string

I had to look at the source code to figure out that --verbose is equivalent to verbose = 'info'. Maybe true should be supported as an alternative to 'info'? Or maybe the error message should tell me what the actual string options are, rather than a generic string type arg.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions