https://github.com/knpwrs/webpack-to-memory

Run a webpack build and get the resulting modules from memory.
https://github.com/knpwrs/webpack-to-memory

Last synced: about 2 months ago
JSON representation

Run a webpack build and get the resulting modules from memory.

• Host: GitHub
• URL: https://github.com/knpwrs/webpack-to-memory
• Owner: knpwrs
• License: mit
• Created: 2016-02-01T05:02:57.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-08T22:27:19.000Z (almost 8 years ago)
• Last Synced: 2024-11-10T12:42:45.488Z (2 months ago)
• Language: JavaScript
• Size: 19.5 KB
• Stars: 25
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [webpack]-to-memory

[![Dependency Status](https://img.shields.io/david/knpwrs/webpack-to-memory.svg)](https://david-dm.org/knpwrs/webpack-to-memory)

[![devDependency Status](https://img.shields.io/david/dev/knpwrs/webpack-to-memory.svg)](https://david-dm.org/knpwrs/webpack-to-memory#info=devDependencies)

[![Build Status](https://img.shields.io/travis/knpwrs/webpack-to-memory.svg)](https://travis-ci.org/knpwrs/webpack-to-memory)

[![Npm Version](https://img.shields.io/npm/v/webpack-to-memory.svg)](https://www.npmjs.com/package/webpack-to-memory)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![Badges](https://img.shields.io/badge/badges-6-orange.svg)](http://shields.io/)

A quick 'n dirty module to compile one or more bundles using webpack and load

those compiled bundles as node modules -- all in memory!

## Usage

This module exports a single function which takes a [webpack] compiler

configured according to the [webpack Node Node API][wpapi] (note: you can ignore

the section on compiling to memory, this module takes care of that for you). The

most important things to configure are the `target` (`'node'`) and the

`libraryTarget` (`'commonjs2'`). The exported function returns a `Promise` which

resolves with an object mapping output filenames to compiled node modules.

```js

const webpack = require('webpack');

const load = require('webpack-to-memory');

load(webpack({

  entry: 'index.js',

  target: 'node',

  output: {

    libraryTarget: 'commonjs2',

    filename: 'bar.js',

  },

  module: {

    loaders: [{

      test: /\.js$/,

      loaders: ['babel'],

    }],

  },

})).then(files => {

  // Now you can get the node modules.

  const bar = files['bar.js']; // `bar` now contains the `exports` object from `bar.js`

});

```

## Caveats

All output is placed in an [in-memory filesystem][mfs]. Node doesn't read from

this filesystem directly, so if you create multiple bundles that depend on each

other your modules will fail to load (except in a few edge cases). If you have a

setup such as this it is probably better to just compile out to the real

filesystem ahead of time and `require` or `import` the modules as normal.

## License

[**MIT**](./LICENSE)

[mfs]: https://www.npmjs.com/package/memory-fs "mfs"

[webpack]: http://webpack.github.io/ "webpack"

[wpapi]: http://webpack.github.io/docs/node.js-api.html "webpack Node API"