check

check Command

The check command is used to validate the configuration file for dodo-doc. It ensures that all required fields are present and correctly formatted, helping to prevent errors during document processing.

Flags

  • -c, --config stringPath to the configuration file (default is ".dodo.yaml"). Use this flag to specify a different configuration file if needed.

  • --debugEnable debug mode. This provides additional output useful for troubleshooting.

  • --no-colorDisable color output. Useful for environments that do not support colored text.

Error Handling

The check command will output errors if the configuration file does not meet the required standards. Common errors include missing fields and incorrect date formats. Ensure that all fields follow the expected format to avoid these errors.

Examples

bash
$ dodo-cli check
  ⨯ .dodo.yaml:10:12 the `title` field should exist in the markdown file when you use `match`: /xxx/usage1.md
    >     - match: "/xxx/*"
  ⨯ .dodo.yaml:10:12 the `path` field should exist in the markdown file when you use `match`: /xxx/usage2.md
    >     - match: "/xxx/*"
  ⨯ .dodo.yaml:10:12 the `title` field should exist in the markdown file when you use `match`: /xxx/usage3.md
    >     - match: "/xxx/*"

...

  ⨯ .dodo.yaml:20:12 `created_at` should follow the RFC3339 format. Got: 20241113: /yyy/20241113.md
    >     - match: "/yyy/*"
  ⨯ .dodo.yaml:20:12 `created_at` should follow the RFC3339 format. Got: 20240818: /yyy/20240818.md
    >     - match: "/yyy/*"
  ⨯ .dodo.yaml:20:12 `created_at` should follow the RFC3339 format. Got: 20240617: /yyy/20240617.md
    >     - match: "/yyy/*"
Error: 79 errors:

Previous Page
upload
Next Page
touch