grunt-angular-json v1.1.2
grunt-angular-json
Merge and convert JSON files into angular modules
Getting Started
This plugin requires Grunt ~0.4.5
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-angular-json --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-angular-json');
Expample
Input
//first.json
{
"field1": "value1",
"field2": true,
"field-3": 10
}
//second.json
{
"field1": "value2"
}
Output
angular.module('angular_json', []).value('first', {
field1: 'value1',
field2: true,
'field-3': 10
}).value('second', {
field1: 'value2'
});
The "angular_json" task
Overview
In your project's Gruntfile, add a section named angular_json
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
angular_json: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
Options
options.indent
Type: String
Default value: ' '
What characters to use as indentation in the generated javascript files, default 4 spaces.
options.module
Type: String
Default value: 'angular_json'
A string value that will be used as the name for the angular module generated.
options.merge
Type: Boolean
Default value: false
A boolean value indicating if the task should merge the json objects when multiple source files are provided for the same destination.
options.generateName
Type Function
Default value: filename
A function that will be called with the filename as first parameter and full path as second parameter. Should return a name that will be used as the value name in angular.
For merge: false
this is called with the src files
For merge: true
this is called with teh destination file.
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.
Release History
(Nothing yet)