# gulp-library-umd

> Gulp plugin for transforming node modules into various flavors of UMD (Universal Module Definition) by wrapping files in umd templates.

Latest version **1.0.1** (published 2016-04-08) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install gulp-library-umd
pnpm add gulp-library-umd
yarn add gulp-library-umd
bun add gulp-library-umd
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-04-08 |
| First published | 2016-04-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Will Henderson |
| Maintainers | whenderson |
| Keywords | gulp, gulp-plugin, gulpplugin, UMD, amd, node, commonjs, cjs, web, sourcemap, sourcemaps, gulp-data, wrap |

## Links

- npm: https://www.npmjs.com/package/gulp-library-umd
- Repository: https://github.com/WHenderson/gulp-library-umd
- Homepage: https://github.com/WHenderson/gulp-library-umd#readme
- Issues: https://github.com/WHenderson/gulp-library-umd/issues
- npm.io page: https://npm.io/package/gulp-library-umd

## Dependencies (6)

- [dot](https://npm.io/package/dot.md) ^1.0.3
- [extend](https://npm.io/package/extend.md) ^3.0.0
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.7
- [source-map](https://npm.io/package/source-map.md) ^0.5.3
- [event-stream](https://npm.io/package/event-stream.md) ^3.3.2
- [vinyl-sourcemaps-apply](https://npm.io/package/vinyl-sourcemaps-apply.md) ^0.2.1

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2016-04-08
- 1.0.0 — 2016-04-07
- 0.2.0 — 2016-04-07
- 0.0.0 — 2016-04-07

## README

# gulp-library-umd
Gulp plugin for transforming node modules into various flavors of UMD (Universal Module Definition).
Wraps files with a specified UMD template.

*Supports [gulp-sourcemaps](https://www.npmjs.com/package/gulp-sourcemaps)!*
*Supports [gulp-data](https://www.npmjs.com/package/gulp-data)!*

## Templates
`gulp-library-umd` supports many templates out of the box, including all those provided by [UMDjs](https://github.com/umdjs/umd) and [gulp-umd](https://github.com/eduardolundgren/gulp-umd)

 
| origin                                                  | template                | amd | web | cjs | node | notes |
| :-----                                                  | :---------------------- | :-: | :-: | :-: | :--: | :---- |
| [UMDjs](https://github.com/umdjs/umd)                   | amdWeb.js               |  X  |  X  |     |      | Uses AMD or browser globals to create a module |
| [UMDjs](https://github.com/umdjs/umd)                   | amdWebGlobal.js         |  X  |  X  |     |      | Uses AMD or browser globals to create a module. Creates a web global when AMD is used | 
| [UMDjs](https://github.com/umdjs/umd)                   | commonjsAdapter.js      |  X  |     |  X  |      | Defines a module that works in CommonJS and AMD |
| [UMDjs](https://github.com/umdjs/umd)                   | commonjsStrict.js       |  X  |  X  |  X  |      | Uses CommonJS, AMD or browser globals to create a module |
| [UMDjs](https://github.com/umdjs/umd)                   | commonjsStrictGlobal.js |  X  |  X  |  X  |      | Uses CommonJS, AMD or browser globals to create a module. Creates a web global when AMD is used |
| [UMDjs](https://github.com/umdjs/umd)                   | jqueryPlugin.js         |  X  |  X  |  X  |  X   | Uses CommonJS, AMD or browser globals to create a jQuery plugin |
| [UMDjs](https://github.com/umdjs/umd)                   | nodeAdapter.js          |  X  |     |     |  X   | Defines a module that works in Node and AMD |
| [UMDjs](https://github.com/umdjs/umd)                   | returnExports.js        |  X  |  X  |     |  X   | Uses Node, AMD or browser globals to create a module. |
| [UMDjs](https://github.com/umdjs/umd)                   | returnExportsGlobal.js  |  X  |  X  |     |  X   | Uses Node, AMD or browser globals to create a module. Creates a web global when AMD is used |
| [gulp-umd](https://github.com/eduardolundgren/gulp-umd) | amd.js                  |  X  |     |     |      |   |
| [gulp-umd](https://github.com/eduardolundgren/gulp-umd) | amdCommonWeb.js         |  X  |  X  |  X  |      |   |
| [gulp-umd](https://github.com/eduardolundgren/gulp-umd) | common.js               |     |     |  X  |      |   |
| [gulp-umd](https://github.com/eduardolundgren/gulp-umd) | node.js                 |     |     |     |  X   |   |
| [gulp-umd](https://github.com/eduardolundgren/gulp-umd) | web.js                  |     |  X  |     |      |   |
| [gulp-library-umd](./)                                  | umd.js                  |  X  |  X  |  X  |  X   | Simple support for each of the major export platforms |
| [gulp-library-umd](./)                                  | umdGlobal.js            |  X  |  X  |  X  |  X   | Simple support for each of the major export platforms. Creates a web global when AMD is used |

## Usage

[`gulpfile.js`](./examples/usage/gulpfile.js)
```js
var gulp = require('gulp');
var gulpSourceMaps = require('gulp-sourcemaps'); // optional
var gulpData = require('gulp-data'); // optional
var gulpLibraryUmd = require('gulp-library-umd')

gulp.task('build', function () {
  return gulp.src('source.js')
    // optional per-file settings
    .pipe(gulpData(function (file) {
      return {};
    }))
    // optional source map support
    .pipe(gulpSourceMaps.init())
    // ...
    .pipe(gulpLibraryUmd({
      templateName: 'umd',
      require: {
        libA: 'libA',
        libB: {
          name: 'lib-b-default',
          amd: 'lib-b-amd',
          cjs: 'lib-b-cjs',
          node: 'lib-b-node',
          web: 'libBWeb'
        }
      },
      exports: 'result',
      namespace: 'myModuleGlobal'
    }))
    .pipe(gulpSourceMaps.write())
    .pipe(gulp.dest('dist'))
});
```

input: [`source.js`](./examples/usage/source.js)
```js
var result = {
  A: libA,
  B: libB,
  B: libC
};
```

**result**: [`dist/source.umd.js`](./examples/usage/source.js)
```js
(function (root, factory) {
  if (typeof define === 'function' && define.amd) {
    // AMD. Register as an anonymous module.
    
    define(["libA","lib-b-amd"], factory);
  } else if (typeof module === 'object' && module.exports) {
    // Node. Does not work with strict CommonJS, but
    // only CommonJS-like environments that support module.exports,
    // like Node.
    
    module.exports = factory(require("libA"), require("lib-b-node"));
  } else if (typeof exports === 'object' && typeof exports.nodeName !== 'string') {
    // CommonJs
    
    (function (results) {
      
      for (var key in results) {
        if ({}.hasOwnProperty.call(results, key))
          exports[key] = results[key];
      }
      
    })(factory(require("libA"), require("lib-b-cjs")));
  } else {
   // Browser globals
   
   root.myModuleGlobal = factory(root.libA, root.libBWeb);
  }
}(this, function (libA,libB) {
  var result = {
    A: libA,
    B: libB,
    B: libC
  };
  
  return result;
}));

//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNvdXJjZS5qcyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0VBQUE7RUFDQTtFQUNBO0VBQ0E7RUFDQTtFQUNBIiwiZmlsZSI6InNvdXJjZS51bWQuanMiLCJzb3VyY2VSb290IjoiL3NvdXJjZS8iLCJzb3VyY2VzQ29udGVudCI6WyJ2YXIgcmVzdWx0ID0ge1xyXG4gIEE6IGxpYkEsXHJcbiAgQjogbGliQixcclxuICBCOiBsaWJDXHJcbn07XHJcbiJdfQ==
```

## Options

| name            | type       | default     | description |
| --------------- | ---------- | ----------- | ----------- |
| `templateCache` | `Boolean`  | `true`      | Cache compiled templates |
| `templateName`  | `String`   | `undefined` | Name of the template to use. Overrides `templatePath` |
| `templatePath`  | `String`   | `undefined` | Full file path of the template to use. Overrides `template` |
| `template`      | `String`   | `undefined` | [doT.js](http://olado.github.io/doT/index.html) template source to be compiled and used |
| `template`      | `Function` | `undefined` | function which takes a single argument, context, and returns a string | 
| `modes`         | `Array`    | `['cjs', 'node', 'amd', 'web']` | List of modes to support. Used when providing distinct libraries for each mode |
| `indent`        | `Boolean`  | `true`      | Indent content according to the specified template |
| `rename`        | `Boolean`  | `true`      | Rename files to include the template name as an extension suffix on the basename. eg, `source.js` -> `source.amd.js` |
| `require`       | `Object`   | `{}`        | `variable name`:`library name id` mapping of each required library |
| `exports`       | `String`   | `exports`   | Name of the variable to export. In CommonJs, only own properties of this variable will be exported. |
| `exports`       | `Array`    |             | List of names to exports. In most modes, these will be exported as an object literal with the given properties |
| `namespace`     | `String`   | undefined   | Name to use when exporting as a global. Used in `web` and global modes. If no namespace is provied, one will be generated from the filename |

### Specifying libraries

**No libraries**
```js
gulpLibraryUmd({ })
```

**Identical libraries for each mode**
```js
gulpLibraryUmd({ 
  requires: { 
    libA: 'library-a', 
    libB: 'library-b' 
  } 
}) 
```

**Different libraries for each mode**
```js
gulpLibraryUmd({ 
  requires: { 
    libA: {
      name: 'library-a', // used as default name when no alternative is specified for the mode
      web : 'libraryA',  // web globals should be valid identifiers 
      amd : null         // AMD does not require this library
    }
  } 
})
```

## Installation

```
npm install --save-dev gulp-library-data
```

---
_Source: https://npm.io/package/gulp-library-umd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._