VersaTiles Release Tools

Tools used for:

• creating a graph of the source code as mermaid: vrt deps-graph
• upgrading all package dependencies: vrt deps-upgrade
• creating Markdown documentation of executables: vrt doc-command
• inserting Markdown into documents: vrt doc-insert
• updating "Table of Content" in Markdown files: vrt doc-toc
• releasing the project as npm package: vrt release-npm

Installation

npm i -D @versatiles/release-tool

configure scripts

You need to configure the scripts in the package.json:

{
  "scripts": {
    "check": "npm run lint && npm run build && npm run test",
    "prepack": "npm run build && npm run doc",
    "release": "vrt release-npm",
    ...
  },
  ...
}

• scripts.check is required by the release command. Here you can lint, build and test your code.
• scripts.prepack is recommended to ensure that all files are up-to-date before releasing. Here you can build code and documentation.
• scripts.release is recommended to make it easy to release a new version.

Command vrt

5-->4 6-->4 6-->7 8-->9 A-->4 B-->9 C-->D C-->4 C-->7 D-->7 E-->2 E-->5 E-->6 E-->8 E-->A E-->B E-->C

class 0,1,3 subgraphs; classDef subgraphs fill-opacity:0.1, fill:#888, color:#888, stroke:#888;