Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

manifest check

Validate manifest files for installation errors and quality warnings.

Usage

foton manifest check [OPTIONS] <MANIFEST>...

Arguments

<MANIFEST>

Paths to the manifest files to validate.

Options

--no-source-checks

Skip checks that require downloading and examining the source archives or files.

--registry-root <REGISTRY_ROOT>

Treat the given manifest files as belonging to the package registry rooted at this directory.

Global options

--exit-on-lock

Exit immediately if the package database is locked by another operation.

--no-confirm

Skip interactive confirmation prompts.

--warnings-as-errors

Treat warnings as errors, causing the command to fail if any warning is emitted.

What the command checks

By default, manifest check reads the manifest and then stages it as if it were going to be installed. This includes downloading and examining the source archives or files described by the manifest. Use --no-source-checks to skip those source-dependent checks.

The command reports:

  • installation errors that would prevent the package from being installed
  • quality warnings for common authoring mistakes

Common warnings

For common warning types, see Package Manifest Reference.

Examples

foton manifest check <manifest-path>

Skip source-dependent checks when validating many manifests, for example in a registry:

foton manifest check --no-source-checks <registry-root>\packages\**\manifest.toml

Validate a manifest as part of a package registry rooted at a known directory:

foton manifest check --registry-root <registry-root> <manifest-path>

Treat warnings as errors:

foton --warnings-as-errors manifest check <manifest-path>

Notes

  • This command is primarily intended for package authors.
  • Because the command fetches sources by default, network access may be required.
  • A manifest that parses successfully can still fail manifest check if the sources are invalid or the selected fonts do not install correctly.