Skip to content

Commit

Permalink
docs: update packages that can be removed (#282)
Browse files Browse the repository at this point in the history
  • Loading branch information
brandonocasey authored Apr 22, 2019
1 parent fb49f83 commit 1d6f7d6
Showing 1 changed file with 69 additions and 19 deletions.
88 changes: 69 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ To learn more about Video.js plugins and this generator's conventions and opinio
- [Hurry](#hurry)
- [Updating an Existing Project](#updating-an-existing-project)
- [Recommendations](#recommendations)
- [Migrating to the Latest Version](#migrating-to-the-latest-version)
- [Where do dependencies come from?](#where-do-dependencies-come-from)
- [`videojs-generate-rollup-config`](#videojs-generate-rollup-config)
- [`videojs-generate-karma-config`](#videojs-generate-karma-config)
- [`videojs-generate-postcss-config`](#videojs-generate-postcss-config)
- [`videojs-generator-verify`](#videojs-generator-verify)
- [`@videojs/generator-helpers`](#videojsgenerator-helpers)
- [No longer needed](#no-longer-needed)
- [License](#license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -111,45 +119,87 @@ If you have made no customizations, the simplest process may be to remove some o
- `test/karma.conf.js`
- `test/index.html`

For a more conservative approach, you should be able to remove any of the following `devDependencies` from your generated project:
For 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.

### Where do dependencies come from?

#### `videojs-generate-rollup-config`
```
babel-core
babel-plugin-external-helpers
babel-plugin-transform-object-assign
babel-preset-env
@babel/preset-env
@babel/plugin-transform-object-assign
@babel/core
@babel/plugin-external-helpers
rollup-plugin-babel
rollup-plugin-commonjs
rollup-plugin-json
rollup-plugin-multi-entry
rollup-plugin-node-resolve
rollup-plugin-uglify
rollup-plugin-terser
uglify-es
```

#### `videojs-generate-karma-config`
```
karma-browserstack-launcher
karma-chrome-launcher
karma-coverage
karma-detect-browsers
karma-firefox-launcher
karma-ie-launcher
karma-qunit
karma-safari-launcher
karma-safaritechpreview-launcher
karma-safari-applescript-launcher
karma-teamcity-reporter
mkdirp
karma-static-server
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 `scripts/`.
#### `videojs-generate-postcss-config`
```
autoprefixer
postcss-banner
postcss-calc
postcss-csso
postcss-custom-properties
postcss-import
postcss-nesting
postcss-progress
```

#### `videojs-generator-verify`
```
es-check
pkg-ok
pkg-can-install
```

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:
#### `@videojs/generator-helpers`
```
conventional-changelog-cli
conventional-changelog-videojs
doctoc
husky
lint-staged
not-prerelease
npm-merge-driver-install
npm-run-all
shx
```

- `src/*`
- `test/*.test.js`
- `README.md`
#### No longer needed

Finally, be sure to run, at minimum, `npm test` afterward to make sure your stuff still works!
No longer needed for other reasons
* `serve-static`: replaced by `karma-static-server`
* `in-publish`: replaced by using `prepublishOnly` via a new version of npm
* `mkdirp`: replaced by using `shx`
* `rimraf`: replaced by using `shx`
* `semver`: replaced by `@videojs/generator-helpers`

## License

Expand Down

0 comments on commit 1d6f7d6

Please sign in to comment.