Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevoree/grunt-kevoree-genmodel
A grunt task that automates kevoree-js project model creation
https://github.com/kevoree/grunt-kevoree-genmodel
Last synced: about 1 month ago
JSON representation
A grunt task that automates kevoree-js project model creation
- Host: GitHub
- URL: https://github.com/kevoree/grunt-kevoree-genmodel
- Owner: kevoree
- License: lgpl-3.0
- Created: 2015-03-26T13:31:35.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-05-23T16:08:05.000Z (over 7 years ago)
- Last Synced: 2024-11-17T07:48:44.301Z (about 2 months ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grunt-kevoree-genmodel
> Generates a Kevoree model by parsing current Kevoree-entity module project
## Getting Started
This plugin requires Grunt `~0.4.4`
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-kevoree-genmodel --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-kevoree-genmodel');
```
## The "kevoree_genmodel" task
### Overview
In your project's Gruntfile, add a section named `kevoree_genmodel` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
kevoree_genmodel: {
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({
kevoree_genmodel: {
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({
kevoree_genmodel: {
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)_