gulp-dashboard
Generates a static dashboard based on data parsed within specified files.
Install
$ npm install --save-dev gulp-dashboard
Usage Examples
Default Options
In this example, the default options are used to parse JSON data from within a *.dash.json
. So when the task below runs, it will create a index.html
file within the dashboard
directory built from all the scanned JSON files within the index
directory.
index/index.dash.json
:
gulpfile.js
var gulp = ;var dashboard = ; gulp;
Custom Compiler Options
In this example, you can see that the options.compiler
property is used to control which compiler to use for rendering module templates.
So when the task below runs, it will create a index.html
file within the dashboard
directory built from all the scanned Jade files within the index
directory.
Notice the index/index.dash.jade
example: This will build out an HTML partial file using the markup within that file using the jade compiler.
It's compiled source will then be rendered out to the handlebars template specified with options.moduleTemplate
.
index/index.dash.json
:
index/index.dash.jade
div h1 Testing p This is just a simple test
gulpfile.js
var gulp = ;var dashboard = ; gulp;
API
Options
options.compiler
Type: Object
Default value: undefined
Compiler you would like to use for rendering templates. The compiler you use must have a render
method in order to work (ex. Jade, Swig, etc)
NOTE: You will need to install your desired template compiler and require it as the value of the compile key
Example:
options: compiler:
options.compilerOptions
Type: Object
Default value: {}
Compiler options you would like to pass into your desired compiler.
Example:
options: compiler: compilerOptions: pretty: true filename: true
options.generatedDir
Type: String
Default value: dashboard/generated
A string value that is used to determine where the dashboard html file will be generated.
options.dashTemplate
Type: String
Default value: node_modules/gulp-dashboard/dashboard/dashboard-template.hbs
A string value that is used to determine what handlebars template should be used for generating the dashboard.
options.name
Type: String
Default value: dashboard
A string value that is used to determine what the filename will be for the generated dashboard HTML.
options.moduleTemplate
Type: String
Default value: node_modules/gulp-dashboard/dashboard/module-template.hbs
A string value that is used to determine what handlebars template should be used for generating components and other HTML partials.
options.logo
Type: String
Default value: ''
A string value that is used to determine what image should be used in a template as a logo.
options.data
Type: Object
Default value: {}
An object of custom variables that will be passed to the Handlebars template. Useful if you want to pass things like version information or other custom variables from your Gulp build process.
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 Gulp.
Release History
v1.0.2 - Added options.name
to allow user to change the filename output
v1.0.1 - Fixed output pathing errors
v1.0.0 - Initial release
License
MIT © Jake Larson