Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ForbesLindesay/umd
Universal Module Definition for use in automated build systems
https://github.com/ForbesLindesay/umd
Last synced: 6 days ago
JSON representation
Universal Module Definition for use in automated build systems
- Host: GitHub
- URL: https://github.com/ForbesLindesay/umd
- Owner: ForbesLindesay
- License: mit
- Created: 2013-03-16T16:53:30.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-10-28T15:32:07.000Z (about 2 years ago)
- Last Synced: 2024-10-30T04:54:44.435Z (13 days ago)
- Language: JavaScript
- Size: 69.3 KB
- Stars: 145
- Watchers: 7
- Forks: 28
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
# umd
Universal Module Definition for use in automated build systems
- simple synchronous wrapping of a string
- `return` style module support
- CommonJS support
- prevents internal UMDs from conflicting[![Build Status](https://img.shields.io/travis/ForbesLindesay/umd/master.svg)](https://travis-ci.org/ForbesLindesay/umd)
[![Dependency Status](https://img.shields.io/david/ForbesLindesay/umd.svg)](https://david-dm.org/ForbesLindesay/umd)
[![NPM version](https://img.shields.io/npm/v/umd.svg)](https://www.npmjs.com/package/umd)## Source Format
In order for the UMD wrapper to work the source code for your module should `return` the export, e.g.
```javascript
function method() {
//code
}
method.helper = function () {
//code
}
return method;
```For examples, see the examples directory. The CommonJS module format is also supported by passing true as the second argument to methods.
## API
options:
- `commonJS` (default: `false`) - If commonJS is `true` then it will accept CommonJS source instead of source code which `return`s the module.
### umd(name, source, [options])
The `name` should the the name of the module. Use a string like name, all lower case with hyphens instead of spaces.
If `source` should be a string, that is wrapped in umd and returned as a string.
### umd.prelude(module, [options])
return the text which will be inserted before a module.
### umd.postlude(module, [options])
return the text which will be inserted after a module.
## Command Line
```
Usage: umd [options]Pipe Usage: umd [options] < source > destination
Options:
-h --help Display usage information
-c --commonJS Use CommonJS module format
```You can easilly pipe unix commands together like:
```js
cat my-module.js | umd my-module | uglify-js > my-module.umd.min.js
```## Name Casing and Characters
The `name` passed to `umd` will be converted to camel case (`my-library` becomes `myLibrary`) and may only contain:
* alphanumeric characters
* $
* _The name may not begin with a number. Invalid characters will be stripped.
## License
MIT