Lead Maintainer: Pat O'Neill @misteroneill
Maintenance Status: Stable
To learn more about Video.js plugins and this generator's conventions and opinions, check out:
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-plugin
Then, creating the foundation for your Video.js plugin is as simple as:
$ yo videojs-plugin
You 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!
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).
yo videojs-plugin --skip-install
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.
yo videojs-plugin --skip-prompt
If you don't want to change configuration, but just want to update an existing plugin and skip all the other stuff (e.g., prompts, installation), you can use this option to do that. You may need to run the installation manually if dependencies changed!
yo videojs-plugin --hurry
In some cases - especially when updating previously generated projects - you may want to only update certain "meta" files without needing to deal with prompts for source files and test files you definitely do not want to overwrite. The
--limit-to-meta option helps with this.
--limit-to accepts keys which will limit the generated files to only those specified. The possible keys are:
dotfiles: Updates only those files starting with a
pkg: Updates only
scripts: Updates only the
These keys can be combined to create larger sets of files. For example,
--limit-to=dotfiles,pkg will update the files matched by
--limit-to-meta option is available as a shortcut for using
--limit-to with all the available keys.
Update a subset of files with:
yo videojs-plugin --limit-to=pkg,scripts
Update all "meta" files with:
yo videojs-plugin --limit-to-meta
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)
a: yes to all
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
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