Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dotmpe/x-nodejs-gruntplug

Gruntplugin incubation repo
https://github.com/dotmpe/x-nodejs-gruntplug

Last synced: 11 days ago
JSON representation

Gruntplugin incubation repo

Host: GitHub
URL: https://github.com/dotmpe/x-nodejs-gruntplug
Owner: dotmpe
Created: 2014-06-09T21:02:15.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2016-05-14T01:59:01.000Z (over 8 years ago)
Last Synced: 2024-10-12T04:27:51.139Z (about 1 month ago)
Language: CoffeeScript
Size: 14.6 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# x-nodejs-grutplugin-mpe

Based on generated code. Docs below.
Going to experiment with concrete plugins in branches,
currently some exploration for a Python Docutils plugin is done.

## Getting Started
This plugin requires Grunt.

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 x-nodejs-grutplugin-mpe --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('x-nodejs-grutplugin-mpe');
```

## The "x_nodejs_grutplugin_mpe" task

### Overview
In your project's Gruntfile, add a section named `x_nodejs_grutplugin_mpe` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
x_nodejs_grutplugin_mpe: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
```

### Options

#### options.separator
Type: `String`
Default value: `', '`

A string value that is used to do something with whatever.

#### options.punctuation
Type: `String`
Default value: `'.'`

A string value that is used to do something else with whatever else.

### Usage Examples

#### Default Options
In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.`

```js
grunt.initConfig({
x_nodejs_grutplugin_mpe: {
options: {},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
})
```

#### Custom Options
In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!`

```js
grunt.initConfig({
x_nodejs_grutplugin_mpe: {
options: {
separator: ': ',
punctuation: ' !!!',
},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
})
```

## 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/).

## Release History
_(Nothing yet)_