# grunt-chimp

> A grunt plugin for interacting with the Chimp BDD library

Latest version **2.3.0** (published 2017-06-06) · 0 weekly downloads

## Install

```sh
npm install grunt-chimp
pnpm add grunt-chimp
yarn add grunt-chimp
bun add grunt-chimp
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.3.0 |
| Published | 2017-06-06 |
| First published | 2016-01-29 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 5.0.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Tyler Burton |
| Maintainers | btburton |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-chimp
- Repository: https://github.com/btburton42/grunt-chimp
- Issues: https://github.com/btburton42/grunt-chimp/issues
- npm.io page: https://npm.io/package/grunt-chimp

## Dependencies (1)

- [chimp](https://npm.io/package/chimp.md) <= 1.0.0

## Recent versions

- 2.3.0 (latest) — 2017-06-06
- 2.1.1 — 2016-07-20
- 2.0.2 — 2016-02-06
- 2.0.1 — 2016-02-01
- 2.0.0 — 2016-02-01
- 0.1.0 — 2016-01-29

## README

## NOTE: BREAKING CHANGES for v2

Due to node changing how it's dependencies are managed, there is a breaking change in the grunt task needed to access the binary. In short, if you are using a `<3.0` version of npm you will want to stick with `v1.0`. If you are using node's rewritten flat-dependency installer that's been upstreamed as of `v5.0` of node, you'll want to use `v2.0`. 

# grunt-chimp

> A grunt plugin for interacting with the Chimp BDD library

## 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-chimp --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-chimp');
```

## The "chimp" task

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

```js
grunt.initConfig({
  chimp: {
    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({
  chimp: {
    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({
  chimp: {
    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

`v1` - supports npm `<=v3`

`v2` - supports npm `>=v3`

---
_Source: https://npm.io/package/grunt-chimp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._