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
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
NOTE: This section comes with the caveat that you know your project better than we do; so, do what you think is best.
Migrating across major versions can be a bit of a pain sometimes, but we're working on making it better with the generator. Here are some notes on migrating to the current major version.
You may - depending on your customizations - want to prepare your project by doing one of two things.
If you have made no customizations, the simplest process may be to remove some or all of the following:
For a more conservative approach, you should be able to remove any of the following
devDependencies from your generated project:
babel-core babel-plugin-external-helpers babel-plugin-transform-object-assign babel-preset-env karma-browserstack-launcher karma-chrome-launcher karma-detect-browsers karma-firefox-launcher karma-ie-launcher karma-qunit karma-safari-launcher karma-teamcity-reporter mkdirp qunit rimraf rollup-plugin-babel rollup-plugin-commonjs rollup-plugin-json rollup-plugin-multi-entry rollup-plugin-node-resolve rollup-plugin-uglify semver serve-static sinon uglify-es
All these dependencies should be removable because, in general, build tools are now using the new
videojs-generate-* libraries. This should make it easier to manage dependencies by offloading much of that work to the Video.js organization. The behavior of these new tools is customizable by editing the files in
Regardless, you'll almost certainly want allow the generator to fully overwrite all files as described in the previous section - except those that are likely to have been edited by you:
Finally, be sure to run, at minimum,
npm test afterward to make sure your stuff still works!