added jsdoc webpack plugin

Author: MitkoTschimev

README.md

@@ -1,2 +1,27 @@
-# jsdoc-webpack-plugin
-JsDoc Webpack Plugin
+jsdoc-webpack-plugin
+==========================
+
+
+WebPack plugin that runs [jsdoc](http://usejsdoc.org/) on your bundles
+
+# Usage
+In webpack.config.js:
+```javascript
+var webpack = require('webpack');
+var JsDocPlugin = require('jsdoc-webpack-plugin');
+
+module.exports = {
+    /// ... rest of config
+    plugins: [
+        new JsDocPlugin({
+            conf: './jsdoc.conf'
+        })
+    ]
+}
+
+```
+
+There are two ways how this plugin recognizes the files
+
+1. It takes the information from the jsdoc config file "source.include"
+2. If no "source.include" provided, it takes the whole files from your bundles

index.js

@@ -0,0 +1,85 @@
+var fs = require('fs');
+var path = require('path');
+var merge = require('lodash/merge');
+var spawn = require('child_process').spawn;
+var fsExtra = require('fs-extra');
+
+function Plugin(translationOptions) {
+  var defaultOptions = {
+    conf: './jsdoc.conf'
+  };
+
+  this.options = merge({}, defaultOptions, translationOptions);
+}
+
+Plugin.prototype.apply = function (compiler) {
+  var self = this;
+  var options = self.options;
+
+  compiler.plugin('watch-run', function (watching, callback) {
+    self.webpackIsWatching = true;
+    callback(null, null);
+  });
+
+  compiler.plugin('emit', function (compilation, callback) {
+    console.log('JSDOC Start generating');
+
+    fsExtra.readJson(path.resolve(process.cwd(), options.conf), function (err, obj) {
+      var files = [], jsdocErrors = [];
+      var jsdoc, cwd = process.cwd();
+
+      if(err) {
+        callback(err);
+        return;
+      }
+
+      if (obj.source && obj.source.include) {
+        console.log('Taking sources from config file');
+      } else {
+        compilation.chunks.forEach(function (chunk) {
+          chunk.modules.forEach(function (module) {
+            if (module.fileDependencies) {
+              module.fileDependencies.forEach(function (filepath) {
+                files.push(path.relative(process.cwd(), filepath));
+              });
+            }
+          });
+        });
+        merge(obj.source, { include: files });
+      }
+
+      var jsDocConfTmp = path.resolve(cwd, 'jsdoc.' + Date.now() + '.conf.tmp');
+      fs.writeFileSync(jsDocConfTmp, JSON.stringify(obj));
+
+      jsdoc = spawn('./node_modules/.bin/jsdoc', files.concat('-c', jsDocConfTmp));
+
+      jsdoc.stdout.on('data', function (data) {
+        console.log(data.toString());
+      });
+
+      jsdoc.stderr.on('data', function (data) {
+        jsdocErrors.push(data.toString());
+      });
+
+      jsdoc.on('close', function (data, code) {
+        if(jsdocErrors.length > 0) {
+          jsdocErrors.forEach(function (value) {
+            console.error(value);
+          });
+        } else {
+          console.log('JsDoc successful');
+        }
+        fs.unlink(jsDocConfTmp, function() {
+          callback();
+        });
+      });
+    });
+  });
+
+  compiler.plugin('done', function (stats) {
+    console.log('JSDOC Finished generating');
+    console.log('JSDOC TOTAL TIME:', stats.endTime - stats.startTime);
+  });
+};
+
+module.exports = Plugin;

package.json

@@ -0,0 +1,28 @@
+{
+  "name": "jsdoc-webpack-plugin",
+  "version": "0.0.1",
+  "description": "JsDoc Webpack Plugin",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tfiwm/jsdoc-webpack-plugin.git"
+  },
+  "keywords": [
+    "jsdoc",
+    "webpack"
+  ],
+  "author": "Mitko Tschimev <[email protected]> (http://www.mitko-tschimev.de)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/tfiwm/jsdoc-webpack-plugin/issues"
+  },
+  "homepage": "https://github.com/tfiwm/jsdoc-webpack-plugin#readme",
+  "dependencies": {
+    "fs-extra": "^0.30.0",
+    "jsdoc": "^3.4.0",
+    "lodash": "^4.11.2"
+  }
+}