generator-videojs-plugin
This is an opinionated Yeoman generator for video.js plugins. It is based on the recommendations of the video.js core team as well as tools and conventions for developing plugins at Brightcove.
To learn more about video.js plugins and this generator's standards and opinions, check out:
Table of Contents
Getting Started
If you don't know what Yeoman is or what generators are, check out the Yeoman Getting Started document. Long story short, make sure you have Yeoman and this generator installed globally:
$ npm install -g yo generator-videojs-pluginThen, creating the foundation for your video.js plugin is as simple as:
$ yo videojs-pluginYou will be walked through several options and finish with a working, buildable, testable video.js plugin. Of course, this plugin won't do anything out of the box - that part is left to your creativity!
Options
Install
By default, the generator will run npm install after it is finished. This can be a slow process and you may not always need it; so, it can be disabled (this option is provided by Yeoman itself, but it's useful and worth documenting here).
Turn installation off with: yo videojs-plugin --skip-install
Prompt
By default, the generator will present the user with a series of prompts to choose various settings. This can be disabled if you've previously selected values and don't want to change them.
Turn prompts off with: yo videojs-plugin --skip-prompt
Hurry
If you don't want to change configuration, but just want to update an existing plugin and skip all the other stuff (prompts, installation, "yosay"s), you can use this option to do that. You may need to run the installation manually if dependencies changed!
Turn prompts off with: yo videojs-plugin --hurry
Brightcove Defaults
Set certain values automatically for Brightcove-authored plugins. Has the following effects:
- Sets the author to
"Brightcove, Inc." - Limits open-source license options to
Apache-2.0only.
Turn on these Brightcove defaults with: yo videojs-plugin --bcov
Updating an Existing Project
Running a Yeoman generator in an empty directory poses no difficulties; however, running it against an existing project can cause conflicts. Yeoman provides a mechanism, which can be confusing because it's not clearly documented, for resolving these conflicts. It will prompt you to choose one of:
Y: yes (default)n: noa: yes to allx: exitd: diffh: help
Recommendations
Most of what this generator does is localized to the package.json file. Luckily, the generator does a good job of merging your existing contents with the generated contents. In general, it's safe to select Y for the package.json in your project.
Other files you'll usually want to select n on - particularly those files plugin authors will edit the most: anything in src/ or test/.
However, files that are not commonly edited by plugin authors may deserve a diff check (d) if you've made changes to these sorts of files. For example, anything in scripts/.
Extra Tools
This generator provides some simple CLI programs that go beyond the basic generator behavior.
These programs can be used on any plugin project - not just those using the generator! They do not provide prompts or accept arguments or options; they do one thing only. The only expectation is that they are run in the project root of a video.js plugin (process.cwd()).
Cleanup with vjsgenclean
The generator is non-destructive: it will only add to or update your project. This script will remove files and package.json fields that were removed since the previous major version of the generator.
For example, if 1.x produced the file foo/bar.js, but 2.x does not, this script will delete it.
$ vjsgencleanValidation with vjsplugincheck
This script supports validating a directory as following current video.js Plugin Standards. Using it is very simple; run the following command:
$ vjsplugincheck
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent