Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goliatone/grunt-gconfig
Grunt task for generating HTML metadata configuration options for GConfig from JSON files.
https://github.com/goliatone/grunt-gconfig
Last synced: 11 days ago
JSON representation
Grunt task for generating HTML metadata configuration options for GConfig from JSON files.
- Host: GitHub
- URL: https://github.com/goliatone/grunt-gconfig
- Owner: goliatone
- License: mit
- Created: 2014-02-17T03:40:36.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-02-20T23:01:58.000Z (over 8 years ago)
- Last Synced: 2024-10-11T09:08:51.141Z (27 days ago)
- Language: JavaScript
- Size: 324 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
[](https://travis-ci.org/goliatone/grunt-gconfig)
# grunt-gconfig
> Grunt task for generating HTML metadata configuration options for gconfig
## GConfig
[GConfig][1] is a simple configuration management library.
[1]:(https://github.com/goliatone/gconfig)
## Getting Started
This plugin requires Grunt `~0.4.1`
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-gconfig --save-dev
```
One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-gconfig');
```
## The "gconfig" task
### Overview
In your project's Gruntfile, add a section named `gconfig` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
gconfig: {
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({
gconfig: {
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({
gconfig: {
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)_