Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webpack-contrib/install-webpack-plugin
Speed up development by automatically installing & saving dependencies with Webpack.
https://github.com/webpack-contrib/install-webpack-plugin
webpack-plugin
Last synced: 7 days ago
JSON representation
Speed up development by automatically installing & saving dependencies with Webpack.
- Host: GitHub
- URL: https://github.com/webpack-contrib/install-webpack-plugin
- Owner: webpack-contrib
- License: mit
- Created: 2015-11-30T00:40:53.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T03:56:43.000Z (almost 2 years ago)
- Last Synced: 2024-11-28T08:48:50.397Z (15 days ago)
- Topics: webpack-plugin
- Language: JavaScript
- Homepage:
- Size: 2.13 MB
- Stars: 1,431
- Watchers: 27
- Forks: 92
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-github-star - install-webpack-plugin - contrib | 1440 | (JavaScript)
- awesome-list - install-webpack-plugin - contrib | 1430 | (JavaScript)
README
[![npm][npm]][npm-url]
[![deps][deps]][deps-url]
[![test][test]][test-url]
[![coverage][cover]][cover-url]
[![chat][chat]][chat-url]
Install Webpack Plugin
Speed up development by automatically installing & saving dependencies with Webpack.
It is inefficient to Ctrl-C your
build script & server just to install
a dependency you didn't know you needed until now.
Instead, use `require` or `import` how you normally would and installation
will happen **automatically to install & save missing dependencies** while you work!
# Installation
```bash
$ npm install --save-dev install-webpack-plugin
```
# Usage
In your `webpack.config.js`:
```js
plugins: [
new InstallPlugin()
],
```
**This is equivalent to**:
```js
plugins: [
new InstallPlugin({
dependencies: {
peer: true,
},
packageManager: {
type: this.getDefaultPackageManager(),
options: {
dev: false,
quiet: false,
},
},
prompt: true,
});
],
```
# Options
## dependencies
**Type:** `Object`
Dependencies related options.
### peer
**Type:** `Boolean`
**Default:** `true`
Install missing peer dependencies.
```js
plugins: [
new InstallPlugin({
dependencies: {
peer: true,
}
}),
],
```
## packageManager
**Type:** `'npm' | 'yarn' | 'pnpm' | Object | Function`
Package manager to use for installing dependencies.
```js
plugins: [
new InstallPlugin({
packageManager: 'yarn'
},
}),
],
```
You can provide a `Function` to the `packageManager` to make it dynamic:
```js
plugins: [
new InstallPlugin({
packageManager: function(module, path) {
return [
"babel-preset-react-hmre",
"webpack-dev-middleware",
"webpack-hot-middleware",
].indexOf(module) !== -1;
},
}),
],
```
### type
**Type:** `'npm' | 'yarn' | 'pnpm'`
Name of package manager to use for installing dependencies.
### options
**Type:** `Object`
Package manager related options.
### arguments
**Type:** `Array`
Provide custom arguments to use with package manager.
```js
plugins: [
new InstallPlugin({
packageManager: {
type: 'npm',
options: {
arguments: ['--ignore-scripts']
}
}
},
}),
],
```
### dev
**Type:** `Boolean`
**Default:** `false`
Install as development dependencies.
```js
plugins: [
new InstallPlugin({
packageManager: {
type: 'npm',
options: {
dev: true,
}
}
},
}),
],
```
### quiet
**Type:** `Boolean`
**Default:** `false`
Reduce the amount of console logging.
```js
plugins: [
new InstallPlugin({
packageManager: {
type: 'npm',
options: {
quiet: true,
}
}
},
}),
],
```
## prompt
**Type:** `Boolean`
**Default:** `true`
Show a prompt to confirm installation.
```js
plugins: [
new InstallPlugin({
prompt: true,
},
}),
],
```
# Demo
# Features
- [x] Works with webpack `^v5.0.0`.
- [x] Auto-installs `.babelrc` plugins & presets.
- [x] Supports both ES5 & ES6 Modules.
(e.g. `require`, `import`)
- [x] Supports Namespaced packages.
(e.g. `@cycle/dom`)
- [x] Supports Dot-delimited packages.
(e.g. `lodash.capitalize`)
- [x] Supports CSS imports.
(e.g. `@import "~bootstrap"`)
- [x] Supports webpack loaders.
(e.g. `babel-loader`, `file-loader`, etc.)
- [x] Supports inline webpack loaders.
(e.g. `require("bundle?lazy!./App"`)
- [x] Auto-installs missing `peerDependencies`.
(e.g. `@cycle/core` will automatically install `rx@*`)
- [x] Supports webpack's `resolve.alias` & `resolve.root` configuration.
(e.g. `require("react")` can alias to `react-lite`)
## Contributing
Please take a moment to read our contributing guidelines if you haven't yet done so.
[CONTRIBUTING](./.github/CONTRIBUTING.md)
[npm]: https://img.shields.io/npm/v/install-webpack-plugin.svg
[npm-url]: https://npmjs.com/package/install-webpack-plugin
[deps]: https://david-dm.org/webpack-contrib/install-webpack-plugin.svg
[deps-url]: https://david-dm.org/webpack-contrib/install-webpack-plugin
[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
[chat-url]: https://gitter.im/webpack/webpack
[test]: https://travis-ci.org/webpack-contrib/install-webpack-plugin.svg?branch=master
[test-url]: https://travis-ci.org/webpack-contrib/install-webpack-plugin
[cover]: https://codecov.io/gh/webpack-contrib/install-webpack-plugin/branch/master/graph/badge.svg
[cover-url]: https://codecov.io/gh/webpack-contrib/install-webpack-plugin