# webpack-file-injector-plugin

> webpack-file-injector-plugin is a simple plugin that allows you to insert the raw contents of a file into a chunk/module at the place of a keyword

Latest version **2.5.2** (published 2016-07-14) · 0 weekly downloads

## Install

```sh
npm install webpack-file-injector-plugin
pnpm add webpack-file-injector-plugin
yarn add webpack-file-injector-plugin
bun add webpack-file-injector-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 | 2.5.2 |
| Published | 2016-07-14 |
| First published | 2016-07-06 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Michael Wheeler |
| Maintainers | echo-peak |
| Keywords | webpack, file, injector, plugin |

## Links

- npm: https://www.npmjs.com/package/webpack-file-injector-plugin
- Repository: https://github.com/Echo-Peak/webpack-file-injector-plugin
- Issues: https://github.com/Echo-Peak/webpack-file-injector-plugin/issues
- npm.io page: https://npm.io/package/webpack-file-injector-plugin

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 2.5.2 (latest) — 2016-07-14
- 2.5.1 — 2016-07-13
- 2.5.0 — 2016-07-13
- 2.0.1 — 2016-07-06
- 2.0.0 — 2016-07-06

## README

**webpack-file-injector-plugin** is a simple plugin that allows you to insert the raw contents of a file into a chunk/module at the place of a keyword

Currently supports `html` ,`json` ,`js` , `txt`.

### webpack-file-injector-plugin
Installation

```
npm install webpack-file-injector-plugin
```

## API
#### InjectFile

`.options(Object)`

**Object.keyword**

Type: String

Default : InjectFile

Used in finding each instance of `keyword` in each chunk


**Object.verboseLogging**

Type: Boolean

Default : False

Logs when the plugin finds each instance of `keyword` and where it was found

**Object.beep**

Type: Boolean

Default : False

Outputs a auditory beep to console if a error occurred

---
`.plugin`

Stand alone function , take no paramerters used in webpack.config plugins array

---



## Usage
afile.js
```
const baz = InjectFile('baz-obj.js');
const html = InjectFile('body.html');

InjectFile('controller-logic.js')
```
`keyword` InjectFile should be treated as a function that takes must take one parameter and a optional json object

By default it look for  `baz-obj.js` in the same direcory where the `keyword` is found

you can change this by adding the 2 parameter
```
const baz = InjectFile('baz-obj.js' ,{"cwd":"./compiled"})
```
now it will look at the `Root directory` of the webpack process + `./compiled`;

---
**webpack-file-injector-plugin** also emits a `transform` event after injecting the contents of a file into each chunk that you can listen to.

webpack.config.js
```
let InjectFile = require('webpack-file-injector-plugin');

InjectFile.options({keyword:'IncludeFile' ,beep:false , verboseLogging:true});

InjectFile.on('transform' ,function(file, filePath , callback){
//use callback to transmute file and send it the compiler
let newFile = file.replace(/[a-k]/gmi, 'stuff')

callback(newFile)
})

module.exports = {
	entry:'somepath/somefile.js',
	plugins:[
	InjectFile.plugin
	]



}
```

---
_Source: https://npm.io/package/webpack-file-injector-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._