https://github.com/videojs/generator-helpers

A package to keep all of our generator helpers packages, so everything can be updated more easily.
https://github.com/videojs/generator-helpers

Last synced: 6 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/videojs/generator-helpers
• Owner: videojs
• License: other
• Created: 2018-10-31T19:19:19.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2023-07-21T15:53:04.000Z (over 2 years ago)
• Last Synced: 2025-06-08T07:44:10.815Z (7 months ago)
• Size: 212 KB
• Stars: 1
• Watchers: 14
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @videojs/generator-helpers

[![Build Status](https://travis-ci.org/videojs/generator-helpers.svg?branch=master)](https://travis-ci.org/videojs/generator-helpers)

[![Greenkeeper badge](https://badges.greenkeeper.io/videojs/generator-helpers.svg)](https://greenkeeper.io/)

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

- [Installation](#installation)

- [What does it provide/do](#what-does-it-providedo)

## 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](https://github.com/videojs/conventional-changelog-videojs/blob/master/convention.md)

* `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](https://github.com/okonet/lint-staged) or what we use in [the generator](https://github.com/videojs/generator-videojs-plugin/blob/master/generators/app/package-json.js#L190)

* `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](https://github.com/mysticatea/npm-run-all)

* `shx` A cross platform and lightweight binary that supports running shell commands across operating system. See the [docs for what it can do](https://github.com/shelljs/shx#readme)

* `husky` provides git hooks so that certain commands can be run when git commands are run. [See the docs](https://github.com/typicode/husky#readme)

* `cross-env` a binary to set shell enviornment variables and run scripts across operating systems.