makestatic-dom-version v1.0.2

DOM Version

Inject version information into HTML pages

Writes version information to HTML pages using the version information created by the build-version plugin.

• Install
• API
  • DomVersion
    • See Also
    • DomVersion
      • Options
      • Throws
    • .setVersionsMeta
    • .sources
• License

Install

yarn add makestatic-dom-version

API

DomVersion

Inject version information into HTML pages.

Use this plugin to generate meta elements containing version information or add visible version information to HTML pages.

See Also

• Build Version
• Parse HTML

DomVersion

new DomVersion(context, options)

Inject version information into HTML pages.

Configure this plugin for the transform phase. Expects that the build-version plugin has already generated version information and that the HTML parser has been enabled for the parse phase.

For each matched HTML page with an abstract syntax tree call each function in the behaviours option.

If no behaviours are specified this implementation will generate a meta element for each entry in the versions map.

The signature for a behaviour function is:

function behaviour(context, html, versions)

Where context is the processing context, html is the AST for the HTML file currently being processed and versions is the map of version information generated by the build-version plugin.

• context Object the processing context.
• options Object plugin options.

Options

• behaviours Array list of behaviour functions.

Throws

• Error if no versions information is available.

.setVersionsMeta

DomVersion.prototype.setVersionsMeta(context, html, versions)

Default behaviour function that generates a meta element for each key in the versions map.

The name attribute of each meta element is set to the key suffixed with -version and the content is set to the version value for the key.

Such that {package: '1.0.0'} generates:

meta(name="package-version" content="1.0.0")

• context Object the processing context.
• html Object the HTML document AST.
• versions Object list of project versions.

.sources

DomVersion.prototype.sources(file, context, options)

For each matched file with an HTML AST call all the behaviour functions associated with this plugin.

• file File the current file.
• context Object the processing context.
• options Object plugin options.

License

MIT

Created by mkdoc on March 12, 2017