webpack-merge-and-include-globally-http

Merge multiple files (js,css..) or HTTP assets into single file to include somewhere

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
webpack-merge-and-include-globally-http
001.0.14 years ago4 years agoMinified + gzip package size for webpack-merge-and-include-globally-http in KB

Readme

NOTE: This is forked from markshapiro/webpack-merge-and-include-globally. It was forked in order to add HTTP fetching.
MERGE INTO SINGLE FILE PLUGIN FOR WEBPACK
Webpack plugin to merge your source files together into single file, to be included in index.html, and achieving same effect as you would by including them all separately through <script> or <link>.

Getting Started

npm install --save-dev webpack-merge-and-include-globally-http

Usage

Lets say you want to make libraries like jquery, moment (including 3 languages) and toastr available globally, and you're struggling to make them global with webpack or just importing them (in cases they aren't written well) because require() wraps the code into new scope and you want to execute it against a global scope, and you don't want to do this:
<script src="/node_modules/jquery/dist/jquery.min.js"></script>
<script src="/node_modules/moment/moment.js"></script>
<script src="/node_modules/moment/locale/cs.js"></script>
<script src="/node_modules/moment/locale/de.js"></script>
<script src="/node_modules/moment/locale/nl.js"></script>
<script src="/node_modules/toastr/build/toastr.min.js"></script>

<link rel="stylesheet" href="/node_modules/toastr/build/toastr.min.css">
because your node_modules is not available in production.
with this plugin you can achieve the desired effect this way:
const MergeIntoSingleFilePlugin = require('webpack-merge-and-include-globally-http');

module.exports = {
  ...
  plugins: [
      new MergeIntoSingleFilePlugin({
          files: {
              "vendor.js": [
                  'node_modules/jquery/dist/jquery.min.js',
                  //  will work too
                  //  'node_modules/jquery/**/*.min.js',
                  'node_modules/moment/moment.js',
                  'node_modules/moment/locale/cs.js',
                  'node_modules/moment/locale/de.js',
                  'node_modules/moment/locale/nl.js',
                  'node_modules/toastr/build/toastr.min.js',
                  // HTTP URLs are also supported:
                  // 'http://code.jquery.com/jquery-3.3.1.min.js'
              ],
              "vendor.css": [
                  'node_modules/toastr/build/toastr.min.css'
              ]
          }
      }),
  ]
this generates 2 files with merged js and css content, include them into your index.html to take effect:
<script src="./vendor.js"></script>
<link rel="stylesheet" href="./vendor.css">
now jQuery, moment and toastr are available globally throughout your application.

Options

files

Object that maps file names to array of all files (can also be defined by wildcard path) that will be merged together and saved under each file name.
For example to merge jquery, classnames and humps into vendor.js, do:
new MergeIntoSingle({
  files: {
    'vendor.js': [
      'node_modules/jquery/**/*.min.js',
      'node_modules/classnames/index.js',
      'node_modules/humps/humps.js'
    ],
    'style.css': [
      'example/test.css'
    ]
  }
})

transform

Object that maps resulting file names to tranform methods that will be applied on merged content before saving. Use to minify / uglify the result.
For example to minify the final merge result of vendor.js, do:
new MergeIntoSingle({
  files: { 'vendor.js': [...] },
  transform: {
    'vendor.js': code => require("uglify-js").minify(code).code
  }
})

ordered

default: false
if set true all files will be merged by their order in array, but makes build slower, good to use if you have dependencies that need to load sooner.

encoding

default: 'utf-8'
encoding of node.js reading

Working Example

working example already included in project.
to test first install npm i, then run npm run start to see it in action
and npm run build to build prod files with vendor file and index.html.