Grunt plugin that reads java properties files.
npm install grunt-properties-reader> Grunt plugin that reads java properties files.
~0.4.1If 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:
``shell`
npm install grunt-properties-reader --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-properties-reader');
to the data object passed into grunt.initConfig().`js
grunt.initConfig({
properties: {
props: 'configFile.properties'
}
});
`$3
Options are passed directly into the second argument of the
operation. See grunt.file$3
#### Basic
In this example, a properties file is used to read a server deployment location. The
deployDir property is then used in a clean task.The example
application.properties file:`properties
deployDir=C:\server\deployment
`And example
:`js
grunt.initConfig({
properties: {
app: 'application.properties'
},
clean: {
deployDir: '<%= app.deployDir %>'
}
})grunt.loadNpmTasks('grunt-contrib-clean');
grunt.loadNpmTasks('grunt-properties-reader');
grunt.registerTask('cleanDeploy', ['properties', 'clean:deployDir'])
`Running
from the command line will delete the directory.#### Multiple Files
In this example, multiple properties files are read in the order specified. Values from subsequent files are merged with those from the proceeding. Therefore, values from proceeding files will overwrite those from the preceeding files. Consider the following properties files:
`default.properties
deployDir=C:\server\deployment
`
overrides.properties
deployDir=/opt/server
debug=true
`js
grunt.initConfig({
properties: {
app: [ 'default.properties', 'overrides.properties' ]
},
clean: {
deployDir: '<%= app.deployDir %>'
}
})grunt.loadNpmTasks('grunt-contrib-clean');
grunt.loadNpmTasks('grunt-properties-reader');
grunt.registerTask('cleanDeploy', ['properties', 'clean:deployDir'])
`When executed, the app variable will contain the following values:
js
{
deployDir=/opt/server
debug=true
}
``Finally, when using multiple files, the first file in the list must be present. All subsequent files are optional, and will not cause the task to fail if they are not present.