prepare to publish

KyLeoHC · KyLeoHC · commit ca529058ffe5 · 2018-08-02T17:18:36.000+08:00
diff --git a/README.md b/README.md
@@ -1,2 +1,94 @@
+<a href="https://www.npmjs.com/package/inline-source-webpack-plugin"><img src="https://img.shields.io/npm/v/inline-source-webpack-plugin.svg" alt="Version"></a>
+
 # inline-source-webpack-plugin
-A plugin for webpack4.x
+A webpack plugin to embed css/js resource in the html with inline-source module(webpack 4.x and HtmlWebpackPlugin is needed).
+> This plugin doesn't support webpack v1.x,v2.x and v3.x. If you need this feature, you can try [this](https://github.com/KyLeoHC/inline-resource-plugin).
+
+## Install
+```bash
+$ npm install -S inline-source-webpack-plugin
+```
+
+## example
+```html
+<!-- ./build/hello.html -->
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>test</title>
+    <link href="inline.css" inline>
+    <script src="inline.js" inline></script>
+</head>
+<body>
+<div class="container">
+    <h1>hello world!</h1>
+</div>
+</body>
+</html>
+```
+
+```js
+/* ./src/inline.js */
+function Person() {
+}
+
+Person.prototype.sayHello = function () {
+    var word = 'hello';
+    console.log(word);
+};
+```
+
+```css
+/* ./src/inline.css */
+.container {
+    border: 1px solid #000;
+}
+```
+
+Output:
+```html
+<!-- ./build/hello.html -->
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>test</title>
+    <style>.container{border:1px solid #000}</style>
+    <script>function Person(){}Person.prototype.sayHello=function(){var o="hello";console.log(o)};</script>
+</head>
+<body>
+<div class="container">
+    <h1>hello world!</h1>
+</div>
+</body>
+</html>
+```
+
+## Usage
+Available `options` include(refer to [this](https://github.com/popeindustries/inline-source#usage) for more options):
+- `compress`: enable/disable compression.(default `false`)
+- `rootpath`: path used for resolving inlineable paths.
+
+```javascript
+// webpack.config.js example
+const HtmlWebpackPlugin = require('html-webpack-plugin');
+const InlineSourceWebpackPlugin = require('inline-source-webpack-plugin');
+
+module.exports = {
+    ...
+    plugins: [
+        new HtmlWebpackPlugin({
+            ...
+        }),
+        new InlineSourceWebpackPlugin({
+            compress: true,
+            rootpath: './src'
+        })
+    ]
+};
+```
+
+## License
+
+[MIT License](https://github.com/KyLeoHC/inline-source-webpack-plugin/blob/master/LICENSE)
diff --git a/index.js b/index.js
@@ -1,25 +1,45 @@
 const {inlineSource} = require('inline-source');
 
-class InlineResourceWebpackPlugin {
+class InlineSourceWebpackPlugin {
     constructor(options = {}) {
-        this.options = options;
-        this.name = 'InlineResourceWebpackPlugin';
+        this.name = 'InlineSourceWebpackPlugin';
+        this.options = Object.assign({
+            compress: false
+        }, options);
     }
 
     apply(compiler) {
         compiler.hooks.compilation.tap(this.name, compilation => {
+            // if htmlWebpackPlugin is not exist, just do nothing
             if (compilation.hooks.htmlWebpackPluginAfterHtmlProcessing) {
                 compilation.hooks.htmlWebpackPluginAfterHtmlProcessing.tapAsync(
                     this.name,
                     (data, cb) => {
-                        inlineSource(data.html, this.options)
+                        const options = Object.assign({}, this.options);
+                        options.handlers = (source, context) => {
+                            if (context && context.sources && context.sources.length) {
+                                // watch inline target
+                                context.sources.forEach(item => {
+                                    if (compilation.fileDependencies.add) {
+                                        compilation.fileDependencies.add(item.filepath);
+                                    } else {
+                                        // Before Webpack 4 - fileDepenencies was an array
+                                        compilation.fileDependencies.push(item.filepath);
+                                    }
+                                });
+                            }
+                            if (this.options.handlers) {
+                                return this.options.handlers(source, context);
+                            }
+                            return Promise.resolve();
+                        };
+                        inlineSource(data.html, options)
                             .then(html => {
                                 data.html = html;
                                 cb(null, data);
                             })
                             .catch(error => {
-                                cb(null, data);
-                                throw error;
+                                compilation.errors.push(error);
                             });
                     }
                 );
@@ -28,4 +48,4 @@ class InlineResourceWebpackPlugin {
     }
 }
 
-module.exports = InlineResourceWebpackPlugin;
+module.exports = InlineSourceWebpackPlugin;
diff --git a/package.json b/package.json
@@ -4,7 +4,6 @@
   "description": "A plugin for webpack4.x",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
     "type": "git",
