plexiform-config-api

plexiform-config-api

Purpose

Interprets an api specification which is provided as a plexiform MdDom object (a parsed markdown specification) and outputs a JavaScript object representing that specification.

What?!

• Plexiform is a templated code generator
• A plexiform build script contain templates
• The build script also requires a specification object, on which the templates operate
• For ease of reading, it is preferable to define your specification using markdown
• Plexiform will parse the markdown file and provide it as an instance of its proprietary MdDom object
• This module will process the MdDom and return the specification objec that my 'api' build scripts expect

Considered 'Release' (v1.0.0) since 2018-01-02 when it incorporated the 'expand' code which had previously been duplicated across build scripts.

process

Process MdDom into a useful config.

expand

Expand the basic config with reciprocal refs, lookups, etc. to make it more convenient to consume in a build script.

Note: the circular refs mean that it can no longer be stringified.

build

Configure this as your build script, and it will merely dump the arguments to console.