{"id":28490985,"url":"https://github.com/videojs/generator-videojs-plugin","last_synced_at":"2025-07-08T01:31:42.654Z","repository":{"id":16439575,"uuid":"19191187","full_name":"videojs/generator-videojs-plugin","owner":"videojs","description":"Yeoman generator for video.js plugins.","archived":false,"fork":false,"pushed_at":"2023-07-21T12:20:39.000Z","size":4223,"stargazers_count":81,"open_issues_count":10,"forks_count":35,"subscribers_count":23,"default_branch":"main","last_synced_at":"2025-06-08T07:44:12.153Z","etag":null,"topics":["javascript","videojs","videojs-plugin","yeoman-generator"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/videojs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-04-26T23:35:48.000Z","updated_at":"2024-11-02T16:47:28.000Z","dependencies_parsed_at":"2024-06-18T22:43:35.075Z","dependency_job_id":"e5b7b047-8e4e-4813-8a74-ceafd0525d13","html_url":"https://github.com/videojs/generator-videojs-plugin","commit_stats":null,"previous_names":[],"tags_count":85,"template":false,"template_full_name":null,"purl":"pkg:github/videojs/generator-videojs-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/videojs%2Fgenerator-videojs-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/videojs%2Fgenerator-videojs-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/videojs%2Fgenerator-videojs-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/videojs%2Fgenerator-videojs-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/videojs","download_url":"https://codeload.github.com/videojs/generator-videojs-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/videojs%2Fgenerator-videojs-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264175364,"owners_count":23568450,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","videojs","videojs-plugin","yeoman-generator"],"created_at":"2025-06-08T07:30:59.244Z","updated_at":"2025-07-08T01:31:42.642Z","avatar_url":"https://github.com/videojs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generator-videojs-plugin\n\n[![Build Status](https://travis-ci.org/videojs/generator-videojs-plugin.svg?branch=master)](https://travis-ci.org/videojs/generator-videojs-plugin)\n[![Greenkeeper badge](https://badges.greenkeeper.io/videojs/generator-videojs-plugin.svg)](https://greenkeeper.io/)\n[![Slack Status](http://slack.videojs.com/badge.svg)](http://slack.videojs.com)\n\n[![NPM](https://nodei.co/npm/generator-videojs-plugin.png?downloads=true\u0026downloadRank=true)](https://nodei.co/npm/generator-videojs-plugin/)\n\nThis is an opinionated [Yeoman][yo] generator for [Video.js][vjs] plugins. It is based on the recommendations of the Video.js core team as well as tools and conventions for developing plugins at [Brightcove][bcov].\n\nLead Maintainer: Pat O'Neill [@misteroneill](https://github.com/misteroneill)\n\nMaintenance Status: Stable\n\nTo learn more about Video.js plugins and this generator's conventions and opinions, check out:\n\n- [Video.js Plugins Guide][plugins-guide].\n- [Video.js Plugin Conventions][conventions].\n\n### Table of Contents\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n\n- [Getting Started](#getting-started)\n  - [Options](#options)\n    - [Install](#install)\n    - [Prompt](#prompt)\n    - [Hurry](#hurry)\n- [Updating an Existing Project](#updating-an-existing-project)\n  - [Recommendations](#recommendations)\n  - [Migrating to the Latest Version](#migrating-to-the-latest-version)\n  - [Where do dependencies come from?](#where-do-dependencies-come-from)\n    - [`videojs-generate-rollup-config`](#videojs-generate-rollup-config)\n    - [`videojs-generate-karma-config`](#videojs-generate-karma-config)\n    - [`videojs-generate-postcss-config`](#videojs-generate-postcss-config)\n    - [`videojs-generator-verify`](#videojs-generator-verify)\n    - [`@videojs/generator-helpers`](#videojsgenerator-helpers)\n    - [No longer needed](#no-longer-needed)\n- [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Getting Started\n\nIf you don't know what Yeoman is or what generators are, check out the Yeoman [Getting Started][getting-started] document. Long story short, make sure you have Yeoman and this generator installed globally:\n\n```sh\n$ npm install -g yo generator-videojs-plugin\n```\n\nThen, creating the foundation for your Video.js plugin is as simple as:\n\n```sh\n$ yo videojs-plugin\n```\n\nYou 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!\n\n### Options\n\n#### Install\n\nBy 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).\n\n```sh\nyo videojs-plugin --skip-install\n```\n\n#### Prompt\n\nBy 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.\n\n```sh\nyo videojs-plugin --skip-prompt\n```\n\n#### Hurry\n\nIf 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!_\n\n```sh\nyo videojs-plugin --hurry\n```\n\n## Updating an Existing Project\n\nRunning 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:\n\n- `Y`: yes (default)\n- `n`: no\n- `a`: yes to all\n- `x`: exit\n- `d`: diff\n- `h`: help\n\n### Recommendations\n\nMost 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.\n\nOther files you'll usually want to select `n` on - particularly those files plugin authors will edit the most: anything in `src/` or `test/`.\n\nHowever, 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/`.\n\n### Migrating to the Latest Version\n\n\u003e **NOTE:** This section comes with the caveat that you know your project better than we do; so, do what you think is best.\n\nMigrating 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.\n\nYou may - depending on your customizations - want to prepare your project by doing one of two things.\n\nIf you have made no customizations, the simplest process may be to remove some or all of the following:\n\n- `dependencies`, `devDependencies`, and/or `scripts` from `package.json`\n- `package-lock.json`\n- `scripts/*.js`\n- `test/karma.conf.js`\n- `test/index.html`\n\nFor a more conservative approach, you should be able to remove any dependencies not listed in [`plugin/package.json`](plugin/package.json) unless it is specifically needed by your project.\n\n### Where do dependencies come from?\n\n#### `videojs-generate-rollup-config`\n```\nbabel-core\nbabel-plugin-external-helpers\nbabel-plugin-transform-object-assign\nbabel-preset-env\n@babel/preset-env\n@babel/plugin-transform-object-assign\n@babel/core\n@babel/plugin-external-helpers\nrollup-plugin-babel\nrollup-plugin-commonjs\nrollup-plugin-json\nrollup-plugin-multi-entry\nrollup-plugin-node-resolve\nrollup-plugin-uglify\nrollup-plugin-terser\nuglify-es\n```\n\n#### `videojs-generate-karma-config`\n```\nkarma-browserstack-launcher\nkarma-chrome-launcher\nkarma-coverage\nkarma-detect-browsers\nkarma-firefox-launcher\nkarma-ie-launcher\nkarma-qunit\nkarma-safari-launcher\nkarma-safaritechpreview-launcher\nkarma-safari-applescript-launcher\nkarma-teamcity-reporter\nkarma-static-server\nqunit\n```\n\n#### `videojs-generate-postcss-config`\n```\nautoprefixer\npostcss-banner\npostcss-calc\npostcss-csso\npostcss-custom-properties\npostcss-import\npostcss-nesting\npostcss-progress\n```\n\n#### `videojs-generator-verify`\n```\nes-check\npkg-ok\npkg-can-install\n```\n\n#### `@videojs/generator-helpers`\n```\nconventional-changelog-cli\nconventional-changelog-videojs\ndoctoc\nhusky\nlint-staged\nnot-prerelease\nnpm-merge-driver-install\nnpm-run-all\nshx\n```\n\n#### No longer needed\n\nNo longer needed for other reasons\n* `serve-static`: replaced by `karma-static-server`\n* `in-publish`: replaced by using `prepublishOnly` via a new version of npm\n* `mkdirp`: replaced by using `shx`\n* `rimraf`: replaced by using `shx`\n* `semver`: replaced by `@videojs/generator-helpers`\n\n## License\n\n[Apache 2.0][license]\n\n[bcov]: https://www.brightcove.com/\n[getting-started]: http://yeoman.io/learning/index.html\n[license]: LICENSE\n[plugins-guide]: https://github.com/videojs/Video.js/blob/master/docs/guides/plugins.md\n[conventions]: docs/conventions.md\n[vjs]: http://videojs.com/\n[yo]: http://yeoman.io/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvideojs%2Fgenerator-videojs-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvideojs%2Fgenerator-videojs-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvideojs%2Fgenerator-videojs-plugin/lists"}