feat(cli-vector): implement reports and docs commands BM-1215

[tawera-manaena]

Motivation

Now that we can generate Shortbread MBTiles, we need a system for automatically generating schema-like documentation. The system should create markdown files detailing the layers, features within those layers, and attributes for each feature, similar to Shortbread's Vector Tile Schema documentation.

Modifications

This work introduces two new cli commands for the cli-vector package:

reports

Parses an MBTiles file to extract and report detailed information about its contents. Identifies the layers, features within those layers, and attributes for each feature. For each identified layer, the command exports a JSON Report file, saving it into the target directory.

Inputs

Name	Type	Description
mbtiles	Url	Path to the mbtiles from which to generate reports.
target	UrlFolder	Target directory into which to save the generated reports.

Outputs

For each layer extracted from the MBTiles file:

Name	Type	Description
${layer.name}.json	Report	A JSON Report file detailing a layer's features, and attributes for each feature.

docs

Parses a directory of JSON Report files, a directory of JSON Schema files, and a Mustache template file to generate a collection of Vector Tile schema-like markdown files. For each JSON Report file, the command re-maps the report into a runtime Doc object, feeds the Doc into Mustache, and then exports a Markdown file, saving it into the target directory.

Inputs

Name	Type	Description
schemas	UrlFolder	Path to the directory containing schemas from which to extract layer-specific information.
reports	UrlFolder	Path to the directory containing JSON Report files from which to extract layer, feature, and attribute information.
template	Url	Path to the Mustache template markdown file.
target	Url	Target directory into which to save the generated markdown documentation.

Outputs

For each JSON Report file:

Name	Type	Description
${layer.name}.md	Markdown	A Markdown file detailing a layer's features, attributes for each feature, and values.

Verification

[tawera-manaena]

We've changed direction regarding how we will automatically generating schema-like documentation. I will look to close this pull request once I've built our desired solution.