Initial commit for the extraneous file cleanup plugin

Author: AnujRNair

.gitignore

@@ -0,0 +1,2 @@
+.idea/
+/node_modules

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Anuj Nair
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,36 @@
+# Webpack Extraneous File Cleanup Plugin
+
+A webpack plugin to remove unwanted files which may have been created and output due to multiple entry points
+
+https://github.com/AnujRNair/webpack-extraneous-file-cleanup-plugin
+
+## Usage
+
+In your `webpack.config.js` file:
+
+```js
+import ExtraneousFileCleanupPlugin from 'webpack-extraneous-file-cleanup-plugin';
+
+module.exports = {
+  ...
+  plugins: [
+    new ExtraneousFileCleanupPlugin(opts)
+  ]
+}
+```
+
+## Configuration
+
+The ExtraneousFileCleanupPlugin accepts an object of options with the following signature:
+
+```js
+{
+  extensions: ['.extensions', '.to', 'whitelist'],
+  minBytes: 1024,
+  manifestJsonName: 'manifest.json'
+}
+```
+
+* `extensions` - a list of extensions we're allowed to analyze for their file size. Useful for not removing small `.js.map` files, or small `.css` files.
+* `minBytes` - the minimum byte size a file has to meet to not be deleted.
+* `manifestJsonName` - if you're outputting a `manifest.json` file, this plugin will also remove deleted files from the manifest.

index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/plugin')

lib/plugin.js

@@ -0,0 +1,99 @@
+const fs = require('fs')
+
+function ExtraneousFileCleanupPlugin (options) {
+  options = options || {}
+  this.extensions = options.extensions || []
+  this.minBytes = options.minBytes || 1024 // 1 KB minimum size
+  this.manifestJsonName = options.manifestJsonName || 'manifest.json'
+}
+
+// check if the extension is in our allowed list
+ExtraneousFileCleanupPlugin.prototype.validExtension = function (fileName) {
+  let i
+  let len
+
+  // all extensions are valid
+  if (this.extensions.length === 0) {
+    return true
+  }
+
+  for (i = 0, len = this.extensions.length; i < len; i++) {
+    if (fileName.endsWith(this.extensions[i])) {
+      return true
+    }
+  }
+
+  return false
+}
+
+ExtraneousFileCleanupPlugin.prototype.removeFromWebpackStats = (compilation, assetKey) => {
+  for (let i = 0, iLen = compilation.chunks.length; i < iLen; i++) {
+    if (typeof compilation.chunks[i] === 'undefined') {
+      continue
+    }
+
+    for (let j = 0, jLen = compilation.chunks[i].files.length; j < jLen; j++) {
+      if (compilation.chunks[i].files[j] === assetKey) {
+        delete compilation.chunks[i]
+        return
+      }
+    }
+  }
+}
+
+ExtraneousFileCleanupPlugin.prototype.apply = function (compiler) {
+  compiler.plugin('after-emit', (compilation, callback) => {
+    const outputPath = compilation.options.output.path
+
+    let manifestJson = {}
+    let usingManifestJson = false
+    let manifestOutputPath = outputPath + '/' + this.manifestJsonName
+    let manifestKey
+    let assetStat
+
+    // if we're using the webpack manifest plugin, we need to make sure we clean that up too
+    if (fs.existsSync(manifestOutputPath)) {
+      usingManifestJson = true
+      manifestJson = JSON.parse(fs.readFileSync(manifestOutputPath).toString())
+    }
+
+    // for all assets
+    Object.keys(compilation.assets).forEach(assetKey => {
+      if (!this.validExtension(assetKey)) {
+        return
+      }
+
+      // if it passes min byte check, ignore it
+      assetStat = fs.statSync(outputPath + '/' + assetKey)
+      if (assetStat.size > this.minBytes) {
+        return
+      }
+
+      // remove from various places
+      fs.unlinkSync(outputPath + '/' + assetKey)          // unlink the asset
+      fs.unlinkSync(outputPath + '/' + assetKey + '.map') // unlink the map file
+      delete compilation.assets[assetKey]                 // remove from webpack output
+      delete compilation.assets[assetKey + '.map']        // remove from webpack output
+
+      if (usingManifestJson) {
+        for (manifestKey in manifestJson) {
+          if (manifestJson.hasOwnProperty(manifestKey) && manifestJson[manifestKey] === assetKey) {
+            delete manifestJson[manifestKey]              // remove from manifest.json
+            delete manifestJson[manifestKey + '.map']
+          }
+        }
+      }
+
+      this.removeFromWebpackStats(compilation, assetKey)  // remove from webpack stats
+    })
+
+    // write the new manifest.json file if we're using it
+    if (usingManifestJson) {
+      fs.writeFileSync(manifestOutputPath, JSON.stringify(manifestJson, null, 2))
+    }
+
+    callback()
+  })
+}
+
+module.exports = ExtraneousFileCleanupPlugin

package.json

@@ -0,0 +1,29 @@
+{
+  "name": "webpack-extraneous-file-cleanup-plugin",
+  "version": "1.0.0",
+  "description": "A webpack plugin to remove unwanted files which may have been created and output due to multiple entry points",
+  "main": "index.js",
+  "scripts": {
+    "test": "./node_modules/.bin/standard && ./node_modules/.bin/jasmine"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AnujRNair/webpack-extraneous-file-cleanup-plugin.git"
+  },
+  "keywords": [
+    "webpack",
+    "plugin",
+    "cleanup",
+    "extraneous",
+    "chunks",
+    "multiple",
+    "entry",
+    "points"
+  ],
+  "author": "Anuj Nair <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/AnujRNair/webpack-extraneous-file-cleanup-plugin/issues"
+  },
+  "homepage": "https://github.com/AnujRNair/webpack-extraneous-file-cleanup-plugin#readme"
+}

yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+