# webpack-inject-plugin
> A webpack plugin to dynamically inject code into the bundle.
Latest version **1.5.5** (published 2020-11-19) · MIT license · 0 weekly downloads
## Install
```sh
npm install webpack-inject-plugin
pnpm add webpack-inject-plugin
yarn add webpack-inject-plugin
bun add webpack-inject-plugin
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.5.5 |
| Published | 2020-11-19 |
| First published | 2017-07-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 39.6 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 102 |
| Author | Adam Dierkens |
| Maintainers | adierkens |
| Keywords | webpack, plugin, loader, inject |
## Links
- npm: https://www.npmjs.com/package/webpack-inject-plugin
- Repository: https://github.com/adierkens/webpack-inject-plugin
- Homepage: https://github.com/adierkens/webpack-inject-plugin#readme
- Issues: https://github.com/adierkens/webpack-inject-plugin/issues
- npm.io page: https://npm.io/package/webpack-inject-plugin
## Dependencies (1)
- [loader-utils](https://npm.io/package/loader-utils.md) ~1.2.3
## Alternatives
- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads
## Recent versions
- 1.5.5 (latest) — 2020-11-19
- 1.5.4 — 2020-01-06
- 1.5.3 — 2019-08-01
- 1.5.2 — 2019-06-14
- 1.5.1 — 2019-06-12
- 1.5.0 — 2019-04-25
- 1.4.0 — 2019-04-12
- 1.3.0 — 2019-04-12
- 1.2.0 — 2019-04-12
- 1.1.2 — 2019-02-19
- 1.1.0 — 2019-02-19
- 1.0.2 — 2018-12-07
- 1.0.1 — 2018-12-07
- 1.0.0 — 2018-10-21
- 1.0.1-0 — 2018-10-19
- … 8 more at https://npm.io/package/webpack-inject-plugin/versions
## README
# webpack-inject-plugin
[](#contributors)
[](https://circleci.com/gh/adierkens/webpack-inject-plugin/tree/master) [](https://badge.fury.io/js/webpack-inject-plugin) [](https://www.npmjs.com/package/webpack-inject-plugin) [](https://github.com/xojs/xo) [](https://codecov.io/gh/adierkens/webpack-inject-plugin)
A webpack plugin to dynamically inject code into the bundle.
You can check out an example [here](./example)
## Usage
```javascript
# webpack.config.js
const InjectPlugin = require('webpack-inject-plugin').default;
module.exports = {
// Other stuff in your webpack config
plugins: [
new InjectPlugin(function() {
return "console.log('Hello World');"
});
]
};
```
This webpack plugin accepts a single argument, a function to which returns the code to inject into the bundle.
The function is called using the same context as the loader, so everything [here](https://webpack.js.org/api/loaders/#the-loader-context) applies.
You can either return the raw content to load, or a `Promise` which resolves to the content, if you wish to be async.
### options
You can also pass in more options:
```javascript
import InjectPlugin, { ENTRY_ORDER } from 'webpack-inject-plugin';
new InjectPlugin(loader, {
entryName: 'entry name', // Limit the injected code to only the entry w/ this name
entryOrder: ENTRY_ORDER.First // Make the injected code be the first entry point
ENTRY_ORDER.Last // Make the injected code be the last entry point
ENTRY_ORDER.NotLast // Make the injected code be second to last. (The last entry module is the API of the bundle. Useful when you don't want to override that.) This is the default.
});
```
### options.entryName
> `string` | `function`
A filter for which entries to inject code into.
If a `string`, only an entry with the same name will be used.
If a `function`, it will be called with each entry name -- and only inject code for each _truthy_ response
ex.
```javascript
new InjectPlugin(loader, {
// This will inject code into every entry that's not named `foo`
entryName: key => key !== 'foo'
});
```
### options.loaderID
> `string`
An optional uniquie ID for the injected loader. If omitted, one will automatically be generated for you.
## Additional Use Cases
Though this could be used as a standalone plugin, you could also use it to create other webpack plugins, such as injecting code into the build based on a config file.
Example:
```javascript
import InjectPlugin from 'webpack-inject-plugin';
function customLoader(options) {
return () => {
return "console.log('My custom code generated from `options`');";
};
}
export default class MyPlugin {
constructor(options) {
this.options = options;
}
apply(compiler) {
new InjectPlugin(customLoader(this.options)).apply(compiler);
}
}
```
## Contributors
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
| [
Adam Dierkens](https://adamdierkens.com)
[💻](https://github.com/adierkens/webpack-inject-plugin/commits?author=adierkens "Code") | [
YellowKirby](https://github.com/YellowKirby)
[💻](https://github.com/adierkens/webpack-inject-plugin/commits?author=YellowKirby "Code") | [
Chvin](https://github.com/chvin)
[💻](https://github.com/adierkens/webpack-inject-plugin/commits?author=chvin "Code") |
| :---: | :---: | :---: |
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!
---
_Source: https://npm.io/package/webpack-inject-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._