https://github.com/opentable/grunt-ot-auto2dot
Grunt task to generate Graphviz files from async.auto calls
https://github.com/opentable/grunt-ot-auto2dot
Last synced: 3 months ago
JSON representation
Grunt task to generate Graphviz files from async.auto calls
- Host: GitHub
- URL: https://github.com/opentable/grunt-ot-auto2dot
- Owner: opentable
- License: mit
- Created: 2016-09-19T23:49:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-09-19T23:54:43.000Z (over 8 years ago)
- Last Synced: 2025-01-28T23:09:50.913Z (5 months ago)
- Language: JavaScript
- Size: 9.77 KB
- Stars: 0
- Watchers: 21
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-ot-auto2dot
> Generate Graphviz files from async.auto calls
## 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-ot-auto2dot --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-ot-auto2dot');
```
## The "auto2dot" task
### Overview
In your project's Gruntfile, add a section named `auto2dot` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
auto2dot: {
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
```
### Usage Examples
#### Default Options
```js
grunt.initConfig({
auto2dot: {
files: {
'dest/basic.dot': 'src/basic.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/).
## Release History
* 0.1.0 Initial Release
* 0.1.1 Documentation Update
* 0.1.2 More Docs
* 0.1.3 Prettier Docs