browserify-shim

Shims modules that aren't installed as npm modules so they can be browserified even if they aren't commonJS compatible.

NOTE: This version of browserify-shim is compatible with browserify@1.x. For a version compatible with browserify@v2.x see browserify-shim@2.0

var browserify = require('browserify')
  , shim = require('browserify-shim');

var bundled = browserify({ debug: true })

    // jquery attaches itself to the window as '$' so we assign the exports accordingly
  .use(shim({ alias: 'jquery', path: './js/vendor/jquery.js', exports: '$' }))

    // underscore is commonJS compliant, so no further export is needed which we specify by assigning exports 'null'
  .use(shim({ alias: 'underscore', path: './js/vendor/underscore.js', exports: null }))

  .addEntry('./js/entry.js')
  .bundle();

fs.writeFileSync(builtFile, bundled);

Installation

npm install browserify-shim@1.x

Features

• shims non commonJS modules in order for them to be browserified by specifying an alias, the path to the file and the identifier under which the module attaches itself to the global window object
• handles even those modules out there that just declare a var foo = ... on the script level and assume it gets attached to the window object since the only way they will ever be run is in the global context - "ahem, ... NO?!"
• loads commonJS modules that are not residing in your node_modules from a specific path
• includes depends to support shimming libraries that depend on other libraries to be in the global namespace
• makes define and if an export is specified also module be undefined in order to prevent improper authored libs from attaching their export to the window because they think they are being required via commonJS. This can cause problems, e.g., when libraries are improperly concatenated like here. For more info read comment inside this fixture

Dependents

Some libraries depend on other libraries to have attached their exports to the window for historical reasons :(. (hopefully soon we can truly say that this bad design is history)

As an example backbone.stickit depends on Backbone, underscore.js, and jQuery or Zepto.

We would properly declare its dependents when shimming it as follows:

var bundled = browserify()
  .use(shim({ alias: 'jquery'     , path: './js/vendor/jquery.js'    ,  exports: '$' }))
  .use(shim({ alias: 'underscore' , path: './js/vendor/underscore.js',  exports: null }))
  .use(shim({ alias: 'backbone'   , path: './js/vendor/backbone.js'  ,  exports: null }))
  .use(shim({
      alias: 'backbone.stickit'
    , path: './js/vendor/backbone.stickit.js'
    , exports: null
      // Below we are declaring the dependencies and under what name/symbol 
      // they are expected to be attached to the window.
    , depends: { jquery: '$', underscore: '_', backbone: 'Backbone' }  
    })
  )
  .addEntry('./js/entry.js')
  .bundle();

Note: the order of shim declarations doesn't matter, i.e. we could have shimmed backbone.stickit at the very top (before the libraries it depends on).

Examples

• shim-jquery
• shim-underscore