VersaTiles Release Tools

Tools used internally for:

• creating Markdown documentation of TypeScript libraries: vrt ts2md
• creating Markdown documentation of executables: vrt cmd2md
• inserting Markdown into documents: vrt insertmd
• updating "Table of Content" in Markdown files: vrt inserttoc
• releasing the current version 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.

Have a look at this package.json as an example.

Command vrt