gulp-config-dev
gulp-config-dev is a shareable configuration package for gulp.
Usage
Add gulp-config-dev to your project:
npm install --save-dev gulp-config-dev
Then, add this script to your package.json
:
That’s it. Now you can launch a web server to host your projects, build files, and watch for changes.
npm start
-
You can also build files and watch for changes, but not host it.
npm start live -
Or, you could just build files.
npm start dist
Configuration
Customize functionality of gulp-config-dev from your package.json
:
html
: Path of your primary HTML file. Usefalse
to omit HTML. Default is${package.name}.html
.js
: Path of your primary JS file. Usefalse
to omit JS. Default is${package.name}.js
.css
: Path of your primary CSS file. Usefalse
to omit CSS. Default is${package.name}.css
.files
: Directory of any additional files used by your project. Default isplaceholders
.use-postcss
: Whether to use PostCSS or not. Default istrue
.use-sass
: Whether to use Sass or not. Default istrue
.watch-css
: Array of paths to watch for CSS changes.watch-js
: Array of paths to watch for JS changes.watch-html
: Array of paths to watch for HTML changes.compress-js
: Whether to compress JS or not.compress-css
: Whether to compress CSS or not.server
: Advanced options for gulp-connect.
Advanced Configuration
server-root
: Destintation of your compiled files. Default isdist
.server-host
: Name of the server host. Default islocalhost
.server-name
: Name of the server for logging purposes. Default is package name.server-port
: Port to use for the web server. Default is8080
.server-browser
: Whether to launch the browser. Default istrue
.server-livereload
: Whether to inject livereload. Default istrue
.html-dest
: Destination of your compiled HTML file relative toserver-root
. Default isindex.html
.js-dest
: Destination of your compiled JS file relative toserver-root
. Default isindex.js
.js-module-name
: Name of the JS export, if required. Default isfalse
.js-module-format
: Format of the compiled JS. Default isiife
.css-dest
: Destination of your compiled CSS file relative toserver-root
. Default isindex.css
.css-syntax
: Syntax to use in CSS. Default isscss
.