https://github.com/developit/grunt-esperanto
Wrapper for the esperanto module transpiler
https://github.com/developit/grunt-esperanto
Last synced: 9 months ago
JSON representation
Wrapper for the esperanto module transpiler
- Host: GitHub
- URL: https://github.com/developit/grunt-esperanto
- Owner: developit
- License: mit
- Created: 2014-11-14T17:51:23.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-05-09T15:23:00.000Z (over 8 years ago)
- Last Synced: 2025-04-10T00:36:07.720Z (9 months ago)
- Language: JavaScript
- Size: 18.6 KB
- Stars: 3
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-esperanto
> Wrapper for the [esperanto](https://github.com/esperantojs/esperanto) module transpiler
[](https://travis-ci.org/developit/grunt-esperanto)
[](https://www.npmjs.com/package/grunt-esperanto)
## Getting Started
This plugin requires Grunt `~0.4.5`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-esperanto --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-esperanto');
```
## The "esperanto" task
### Overview
In your project's Gruntfile, add a section named `esperanto` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
esperanto: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
```
### Options
#### options.separator
Type: `String`
Default value: `'\n'`
A string to place between concatenated files.
#### options.type
Type: `String`
Default value: `'amd'`
Specify the output format.
**Available types:**
- `'amd'` to output AMD modules, works with e.g. [Require.JS](http://requirejs.org/)
- `'commonjs'` or `cjs` to output CommonJS modules, works with **node.js** and **io.js**.
- `'umd'` to output UMD (universal module definition) content - works as an AMD module, a CommonJS module, or as a browser global.
#### options.bundleOpts
Type: `Object`
Default value: `{}`
Accept an esperanto [options](https://github.com/esperantojs/esperanto/wiki/Converting-a-single-module#options) parameter.
#### options.filePathAsModule
Type: `Boolean`
Default value: `false`
When outputting an amd module, if true will use the file path as the module name, stripping the `.js` suffix. This supercedes using `bundleOpts.amdName` which is a static equivalent.
### Usage Examples
```js
grunt.initConfig({
esperanto: {
options: {
type: 'cjs',
},
files: {
expand: true,
cwd: 'src/es6',
src : ['**/*.js'],
dest: 'dest/out.js'
}
}
});
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).