https://github.com/begriffs/generator-omni-module
Write JS modules that run everywhere
https://github.com/begriffs/generator-omni-module
Last synced: about 1 year ago
JSON representation
Write JS modules that run everywhere
- Host: GitHub
- URL: https://github.com/begriffs/generator-omni-module
- Owner: begriffs
- License: mit
- Created: 2013-07-27T19:44:23.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2013-10-11T18:22:12.000Z (over 12 years ago)
- Last Synced: 2025-02-10T20:06:15.794Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 191 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Make a module you can use everywhere
[](https://travis-ci.org/begriffs/generator-omni-module)
You have written an amazing new JS library and now it's time
to distribute it to the world. Use this Yeoman generator
to make your module accessible on both the client side
([RequireJS](http://requirejs.org/) + [Bower](http://bower.io/)) and
the server ([CommonJS](http://wiki.commonjs.org/wiki/Modules/1.1) +
[NPM](https://npmjs.org/)).
With all the popularity your universally accessible module will gain
you'll want to be sure it's easy for you to maintain and others to
improve. That's why the boilerplate comes ready-made with a test
suite and [Travis](https://travis-ci.org/) hooks. It has a solid
[JSHint](http://www.jshint.com/) config and includes a lint step as
part of continuous integration so your codebase will stay fresh and
consistent no matter how many people modify it.
## Getting started
1. Create the boilerplate
```
mkdir your-module && cd $_
npm install -g yo
npm install -g generator-omni-module
yo omni-module
```
2. Answer the questions it asks you.
3. Add the Github upstream specified in `package.json`
4. Write your lovely code and a README.
## Testing your module
You will want both of these commands to be passing on stable code
branches.
grunt jshint # run JSHint on all code and tests
grunt test # run Mocha test suite
## Publishing your module
1. Register your module with Bower: `bower register `
2. Bump the version, tag the code, and publish with
```sh
grunt bump
npm publish
```
(see more [options](https://github.com/vojtajina/grunt-bump) for version bumping)
## License
The generator-omni-module is Copyright © 2013 Joe Nelson. It is free
software, and may be redistributed under the terms specified in the
LICENSE file.