library-brunch

Wraps a brunch-compiled library to keep it off the global scope.

Usage no npm install needed!

<script type="module">
  import libraryBrunch from 'https://cdn.skypack.dev/library-brunch';
</script>

README

library-brunch

Wraps your library in a function keeping require out of the global scope so that your code may be used in other applications. global may be used to set only what you want on the global scope.

Usage

Install the plugin via npm with npm install --save library-brunch.

If you are using uglify, you MUST include the following configuration:

exports.config =
  plugins:
    uglify:
      mangle:
        except: ['window', 'global']

To sepcify the main module that should be required you can use:

exports.config =
  plugins:
    library:
      main: 'appName'

To add the main module to the global scope under the name of the module:

exports.config =
  plugins:
    library:
      main: 'appName'
      global: true

License

The MIT License (MIT)

Copyright (c) 2012-2014 Paul Miller (http://paulmillr.com)

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.