grunt-wc-build
v0.1.0
Published
Runtime view builder for web components based on a specific folder structure
Downloads
7
Readme
wc-build
Runtime view builder for web components based on a specific folder structure It flattens the folder from the source to the build view Example : MyFrameWork_ar-comp.mod/src/index.html, MyFrameWork_ar-comp.mod/src/style.css, MyFrameWork_ar-comp.mod/src/main.js would be flattened to the specified path as buildpath/index.html, buildpath/style.css, buildpath/main.js
Getting Started
This plugin requires Grunt.
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 wc-build --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('wc-build');
The "wc_build" task
Overview
In your project's Gruntfile, add a section named wc_build
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
build: {
dev: {
rtv: 'C:/Users/zb8/Desktop/run/build',
publish: {
frameworks: ['TRGCrocMyComponents', 'DRGMspStdoUI']
},
moduleExtension: /\.o.*/,
serve: true,
port: 8081,
open: 'TRGCroc_ar-app/ar-app.html'
},
},
})
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.
grunt.initConfig({
wc_build: {
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 !!!
grunt.initConfig({
wc_build: {
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.
Release History
Initial beta release
License
Copyright (c) 2014 Aravind Mohan. Licensed under the MIT license.