# grunt-esperanto

**Repository Path**: mirrors_developit/grunt-esperanto

## Basic Information

- **Project Name**: grunt-esperanto
- **Description**: Wrapper for the esperanto module transpiler
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-07-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# grunt-esperanto

> Wrapper for the [esperanto](https://github.com/esperantojs/esperanto) module transpiler

[![CI](http://img.shields.io/travis/developit/grunt-esperanto.svg?style=flat)](https://travis-ci.org/developit/grunt-esperanto)
[![NPM](http://img.shields.io/npm/v/grunt-esperanto.svg?style=flat)](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/).