gulp-tasks-collection

Gulp-tasks

This is a group of common gulp tasks that i use in my projects. If you have other tasks or know how to improve this, let me know.

My twitter profile is @LinkStrifer

Installation

Type npm install gulp-tasks-collectionin the console

Then create a gulpfile.js with this:

require('gulp-tasks-collection');

and create a gulp folder with config.js:

var nib = require('nib');
var config = {
	paths: {
		base: './site/',
		sass: './site/static/sass/',
		stylus: './site/static/stylus/',
		styles: './site/static/css/'
	},
	server: {
		dev: {
            server: {
            	// Array with all the static folders to serve
                baseDir: [
                    './site/'
                ],
                // List with the url and folders to serve, like node_modules or bower folder
                // i.e: route /node_modules url to node_modules folder
                routes: {
                    '/node_modules': 'node_modules'
                }
            },
            port: 3002,
            logLevel: 'info', // Three options, debug, info or silent
            logFileChanges: true, // Log if a file change
        }
	},
	sass: {
		// Array with all the folders with sass dependencies, like node_modules or bower
        includePaths: []
    },
    stylus: {
		use: nib,
		compress: true
    },
    unusedCss: {
        globals: [],
        ignore: []
    }
};

module.exports = config;

Task list

• Default task
• Autoreload-gulp task
• Browser-sync task
• Dev task
• Sass task
• Stylus task
• HTML task
• JS task
• JSHint task

Default task

For convienience, the default task runs autoreload-gulp. For more details check Autoreload-gulp task documentation.

Autoreload-gulp

This task will autoreload gulp on every change in the tasks files. It accepts one parameter, the task name that you want to run with the flag -t or --task

i.e:

If you want to run the dev task, you can do it typing this in the console:

gulp autoreload-gulp -t dev

Or:

gulp autoreload-gulp --task dev

Browser-sync

I'm a frontend developer, so i spend a lot of time testing in the browser, i have to reload the page every time i change a file (html, js or css) to test the new changes, @LeonidasEsteban showed me LiveReload and my life changed.

A while ago i found browser-sync, a library that does all that LiveReload does and more, its really amazing, especially for test on multiple devices.

Here is a list of Features that i love:

• Reload files in the browser after changing them, it is really usefull for develop a site without having to reload everytime, you will love it.
• Create a external url to access from other devices.
• Has ghost mode, you can open as many site tabs you want, if you do something in one, the others also do, scroll, clicks, submit formsor change inputs, everything will ghost.
• It also has remote debugging.
• And a UI with all these options, for default is in the port 3001, so run the task and check it out.

You can run the task by typing this in the console:

gulp browser-sync:dev

And the magic happens. This would open localhost:3002 with the default browser.

Config

browser-sync has some config, here is the basic that is in gulp/config.js, you can check the documentation of browser-sync for more information.

Dev

This is the task that i use when i'm developing a site.

You can run this task alone or using autoreload-gulp.

If you only want to run once, type this in the console

gulp dev

If you want to use autoreload-gulp, just type this

gulp -t dev

Or

gulp --task dev

Here is a list of the running tasks when you run dev:

• Browser-sync
• Sass

Then, watch some files and run an appropiate task:

• Run sass task if the changed file extension is .scss in the folder paths.base in gulp/config.js.
• Run html task if the changed file extension is .html in the folder paths.base in gulp/config.js.

Sass

If you use sass, this is for you, it get all the .scss files and compile using sass, then reload the browser with the new .css.

Config

The sass config is in the gulp/config.js file.

The source files are in paths.sass in gulp/config.js and the destination folder is in paths.styles in gulp/config/js.

Stylus

This does the same as Sass task, i use a base.styl to import a lot of .styl files and only compile base.styl, so my task does that, if you want you can change the task.

Config

The stylus config is in the gulp/config.js file.

The source files are in paths.stylus in gulp/config.js and the destination folder is in paths.styles in gulp/config/js.

HTML

This does not do much. Only reload the browser if a .html file has changed.

JS

A task for the js files, basically is a group o task.

Here is the list:

• JSHint

JSHint

This task runs JSHint on all the .js files, a tool that helps to detect errors and potential problems in your JavaScript code. If you are not familiar with JSHint, check the website jshint.com.

TODO list

Add these tasks:

• autoprefixer
• sassdoc