@videojs/generator-helpers

A package to keep all of our generator helpers packages, so everything can be updated more easily.

Usage no npm install needed!

<script type="module">
  import videojsGeneratorHelpers from 'https://cdn.skypack.dev/@videojs/generator-helpers';
</script>

README

@videojs/generator-helpers

Build Status Greenkeeper badge

A package to keep all of our generator helpers packages, so everything can be updated more easily.

Installation

To install run

npm i --save-dev @videojs/generator-helpers

What does it provide/do

  • @videojs/update-changelog: provides a binary called vjs-update-changelog that we use to automate our changelog updates during releases. See commit conventions for details on how this is generated see the docs for that
  • doctoc: provides a doctoc binary that will a table of contents to any markdown file. Should be used with --notitle to avoid a title
  • lint-staged: provides a lint-staged binary that looks at package.json for instructions. See the docs or what we use in the generator
  • npm-merge-driver-install mostly automatic git conflict merging for package-lock.json.
  • npm-run-all Allows us to use npm as a task runner and more easily run tasks in parallel/sequence. See the docs for more info
  • shx A cross platform and lightweight binary that supports running shell commands across operating system. See the docs for what it can do
  • husky provides git hooks so that certain commands can be run when git commands are run. See the docs
  • cross-env a binary to set shell enviornment variables and run scripts across operating systems.