editable-sources-webpack-plugin
v0.1.0#Editable sources plugin for Webpack
Overview
editable-sources-webpack-plugin allows to modify source code of any webpack
bundle during bundling. For example if some npm
package doesn't have webpack
plugin, you can use this package inside editable-sources-webpack-plugin callback
function.
Installation
Install the package with NPM and add it to your devDependencies:
npm install --save-dev editable-sources-webpack-plugin
Usage:
new EditableSourcesWebpackPlugin(matchRegExp, callback);
const webpack = require('webpack');
const EditableSourcesWebpackPlugin = require('editable-sources-webpack-plugin');
const NpmPackageWithoutWebpackSupport = require('some-npm-package');
module.exports = {
devtool: 'source-map',
entry: {
app: './src/app.ts'
},
output: {
filename: '[name].js',
},
plugins: [
new EditableSourcesWebpackPlugin(/\.js$/, function (sourceCode) {
sourceCode = sourceCode
.replace(/\.catch\(/g, `['catch'](`)
.replace(/\.throw\(/g, `['throw'](`);
return NpmPackageWithoutWebpackSupport(sourceCode);
})
],
resolve: {
extensions: ['.ts', '.js']
}
};
Test
git clone
npm install
npm test
- open
dist/bundle.js
to check your upgraded code.
API
EditableSourcesWebpackPlugin
Type: constructor
Arguments:
matchRegExp
- RegExp to test bundle name (include extension) that will passed to callback
callback
- callback function for modifying code. Should return changed source code.
Any bundle that matched matchRegExp
will be passed to the callback
as sourceCode
argument. Should return changed source code.
If bundle contains source map, new source map will be generated for the edited source code.
If new source map was generated inside callback, you should returns object with sourceCode
and sourceMap
properties instead string
.
new EditableSourcesWebpackPlugin(/\.js$/, function (sourceCode) {
var data = NpmPackageWithoutWebpackSupport(sourceCode);
return {
sourceCode: data.sourceCode,
sourceMap: data.sourceMap
};
})
License
Copyright (C) 2016 Timofey Kachalov.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL
Metadata
- BSD-2-Clause
- >=4.0.0
- Timofey Kachalov
- released 12/18/2016