Command placeholder-extract

Extracts placeholders from a recipe (often for documentation).

Options

--alveolus, --recipe, -a, -r

Recipe/Alveolus name to lookup. When set to auto, it will look through all available manifests found in the from location. If you set manifest option, alveolus is set to auto and there is a single alveolus in it, this will default to it.

--asciidoc

Asciidoc filename (relative to dumpLocation) when outputType is FILE. Ignores this extraction if value is skip.

--completion

Completion properties filename - see https://github.com/rmannibucau/vscode-properties-custom-completion - (relative to dumpLocation) when outputType is FILE. Ignores this extraction if value is skip.

--descriptions

Properties (WARN: it is read line by line and not as java properties) file locations which contain key=the placeholder and value=the placeholder description.

--descriptor, -d

Enable to filer a single descriptor.

--dump, -o

Extraction location (directory) when outputType is FILE.

--fail-on-invalid, -e

Should documentation generation fail on missing/unexpected placeholder description.

--from, -f

Root dependency to download to get the manifest. If set to auto it is assumed to be present in current classpath.

--ignored-placeholders, -x

List of placeholders or prefixes (ended with .*) to ignore. This is common for templates placeholders which don't need documentation since they are wired in the manifest in general.

--json

JSON filename (relative to dumpLocation) when outputType is FILE. Ignores JSON dump if value is skip.

--manifest, -m

Manifest to load to start to lookup (a file path or inline). This optional setting mainly enables to use dependencies easily. Ignored if set to skip.

--markdown

Markdown filename (relative to dumpLocation) when outputType is FILE. Ignores this extraction if value is skip. Note it uses definition lists so it requires .UseDefinitionLists() for docfx/Markdig.

--output-type, -t

How to dump the placeholders, by default (LOG) it will print it but FILE will store it in a local file (using dumpLocation).

--properties

Properties filename (relative to dumpLocation) when outputType is FILE. Ignores properties extraction if value is skip.