An open API service indexing awesome lists of open source software.

https://github.com/plasticine/inject-loader

πŸ’‰πŸ“¦ A Webpack loader for injecting code into modules via their dependencies.
https://github.com/plasticine/inject-loader

javascript loader webpack-loader

Last synced: 19 days ago
JSON representation

πŸ’‰πŸ“¦ A Webpack loader for injecting code into modules via their dependencies.

Awesome Lists containing this project

README

          


Β 

πŸ’‰πŸ“¦

inject-loader


A Webpack loader for injecting code into modules via their dependencies


build status npm version npm downloads

***

### Why

This is particularly useful for writing tests where mocking things inside your module-under-test is sometimes necessary before execution.

`inject-loader` was inspired by, and builds upon ideas introduced in [jauco/webpack-injectable](https://github.com/jauco/webpack-injectable).

### Usage

[Documentation: Using loaders](http://webpack.github.io/docs/using-loaders.html)

Use the inject loader by adding the `inject-loader!` [inline loader](https://webpack.js.org/concepts/loaders/#inline) when you use `require`, this will return a function that can used in test code to modify the injected module.

By default all `require` statements in an injected module will be altered to be replaced with an injector, though if a replacement it not specified the default values will be used.

### Examples

Given some code in a module like this:

```javascript
// MyStore.js

var Dispatcher = require('lib/dispatcher');
var EventEmitter = require('events').EventEmitter;
var handleAction = require('lib/handle_action');

Dispatcher.register(handleAction, 'MyStore');
```

You can manipulate it’s dependencies when you come to write tests as follows:

```javascript
// If no flags are provided when using the loader then
// all require statements will be wrapped in an injector
MyModuleInjector = require('inject-loader!MyStore')
MyModule = MyModuleInjector({
'lib/dispatcher': DispatcherMock,
'events': EventsMock,
'lib/handle_action': HandleActionMock
})
```

There are a few examples of complete test setups for both Webpack 1, 2, 3 & 4 in the [`example`](./example) folder.

## License

MIT (http://www.opensource.org/licenses/mit-license.php)