README
generator-gulp-taskbook
Gulp-taskbook installs Gulp and a few useful plugins, so you can quickly start your new project.
Installation
Make sure you have Node and npm installed. Then install Yeoman and generator:
npm install -g yo
npm install -g generator-gulp-taskbook
Create a new directory for your project:
mkdir my-new-project
cd my-new-project
Now you can install and configure Gulp with:
yo gulp-taskbook
Usage and tasks
Warning
Make sure that you know how UnCss and MQPacker plugins work. Without proper consideration they may break your CSS. Remember that you can easily remove them from gulpfile.js, if you don't need them or you aren't sure how to use them.
All Gulp tasks
- watch - Task to start Browsersync, watch files and run other tasks when file change.
- js - Task to handle transpilation (with babel), concatenation and minification.
- jsLint - Task to lint javascript with ESLint.
- css - Task to compile SCSS files.
- cssLint - Task to lint SCSS files with stylelint.
- image - Task to handle images optimization.
- html - HTML minification.
- htmlLint - Task to lint HTML with htmllint.
- reloadHtml - Task to force Browsersync to reload the page.
Tools used in the tasks
- Browsersync;
- Postcss (autoprefixer, cssnano, MQPacker, UnCss);
- Babel (with babel-preset-env);
- ESLint;
- HTMLMinifier and HTMLLint;
- Cached, Remember, Uglify, Sourcemaps and Concat;
- StyleLint with stylelint-config-standard;
- imagemin;
- Sass;
Code quality
You can check code with ESLint:
npm run eslint
License
MIT © Paweł Halczuk