SF014 Project manifest

input tooling

The user shall be able to group all input files of a project in a single manifest file, and pass that manifest to the speky CLI instead of listing individual files.

A manifest is a YAML or TOML file with kind: project containing:

  • name: the project identifier, used as the namespace in reference tags (e.g. speky:my-project#SF001)

  • files: a list of glob patterns matching specification files to load

  • root_directory: an optional path relative to the manifest, used as the base for glob patterns and displayed file paths (defaults to the manifest’s own directory)

  • comments_csvs: an optional list of glob patterns for CSV comment files

When a manifest is loaded, all matched files are loaded in sorted order.

Tested by

TF012 Use a project manifest

References

Relates to:

Referenced by: SF015 Code sources in manifest

Source

Source file: specs/functional.yaml

Loaded from: speky

Implemented in: read_file

Comments

Antoine

For now, the Typst output uses a .typ file as its equivalent and does not support manifests.