Usando Gulp 4 en su flujo de trabajo para archivos Sass y JS

Esta publicación se publicó originalmente en Coder-Coder.com.

Este tutorial explicará, paso a paso, cómo configurar Gulp 4 en su flujo de trabajo, así como cómo migrar de la sintaxis de Gulp 3 a Gulp 4.

¿Necesita que su Gulp 3 gulpfile.js funcione rápidamente con Gulp 4? Haga clic aquí para ir directamente a esa parte de la publicación.
  1. Instale gulp-cli en su línea de comando ejecutando npm install gulp-cli -g.
  2. Instale Gulp ejecutando npm install gulp.
  3. Instale otros paquetes npm para su flujo de trabajo de Gulp.
  4. Crea un gulpfile.jsarchivo en la raíz de tu proyecto.
  5. Importe sus paquetes npm como módulos en su archivo gulp.
  6. Agregue sus tareas al gulpfile para compilar sus archivos SCSS / JS y ejecutar una tarea de observación.
  7. Ejecute el gulpcomando para ejecutar todas sus tareas.

¿Qué es Gulp y qué hace?

Gulp es una herramienta que ejecutará varias tareas para usted en su flujo de trabajo de desarrollo web. Podría llamarse agrupador, herramienta de compilación o ejecutor de tareas. Todos significan aproximadamente lo mismo.

Herramientas similares son Webpack y Grunt (aunque Grunt se está volviendo obsoleto rápidamente).

Esto es lo que vamos a hacer que Gulp haga por nosotros:

  1. Compila nuestros archivos Sass en CSS
  2. Agregue prefijos de proveedores a nuestro CSS
  3. Minifica nuestro archivo CSS final
  4. Concatenar (es decir, combinar) nuestros archivos JS
  5. Uglify nuestro archivo JS final
  6. Mueva los archivos CSS / JS finales a nuestra /distcarpeta.

Bastante genial, ¿verdad?

Entonces, la forma en que funciona es que todas sus configuraciones y tareas se almacenan en un gulpfile.jsarchivo. Y ejecuta Gulp en su línea de comando.

La gran parte de eso es que una vez que tengas tu gulpfile todo configurado, puedes reutilizarlo fácilmente para otros proyectos. ¡Es un gran ahorro de tiempo!

Pasemos a la instalación y configuración de Gulp en su computadora.

Instalando Gulp, usando un proyecto de demostración funcional

Antes de poder ejecutar Gulp, deberá instalar un par de cosas:

  • Instale Node.js si aún no lo tiene.
  • Instale la utilidad de línea de comandos de Gulp ejecutando npm install --global gulp-cli.

Una vez que tenga Gulp funcionando, consulte un proyecto de demostración que construí que usa Gulp. Es un proyecto repetitivo de front-end que está destinado a ser una forma rápida de comenzar con cualquier sitio web simple de front-end.

(También tengo muchos fragmentos de código en el resto de este tutorial, ¡así que también puedes consultarlos!)

Para configurar el proyecto repetitivo de front-end:

  • Clona o descarga el repositorio de Git de este proyecto en tu computadora.
  • Abra el proyecto y, en la carpeta raíz del proyecto, vaya a la línea de comandos y ejecute npm install. Esto instalará los paquetes npm enumerados en el package.jsonarchivo, particularmente Gulp 4.

Ahora debería tener configurados los archivos del proyecto y todos los paquetes npm instalados que usaremos para ejecutar las tareas de Gulp.

Dado que los archivos del repositorio están listos para funcionar, si escribe gulpen la línea de comando, debería ver un resultado como este:

> gulp [22:29:48] Using gulpfile ~\Documents\GitHub\frontend-boilerplate\gulpfile.js [22:29:48] Starting 'default'... [22:29:48] Starting 'scssTask'... [22:29:48] Starting 'jsTask'... [22:29:48] Finished 'jsTask' after 340 ms [22:29:48] Finished 'scssTask' after 347 ms [22:29:48] Starting 'watchTask'...

¡Y has ejecutado Gulp!

¿Qué sucede en el proyecto cuando ejecuta Gulp?

Muy bien, ¡tienes el proyecto funcionando correctamente! Ahora veamos con más detalle qué hay en el proyecto y cómo funciona.

Primero, aquí hay un resumen rápido de la estructura de archivos de nuestro proyecto:

  • index.html - su archivo HTML principal
  • package.json : contiene todos los paquetes npm para instalar cuando ejecuta npm install.
  • gulpfile.js : contiene la configuración y ejecuta todas las tareas de Gulp
  • / app - carpeta de trabajo, editará archivos SCSS / JS aquí
  • / dist : Gulp generará archivos aquí, no edite estos archivos

En su flujo de trabajo, editará los archivos HTML, SCSS y JS. Gulp luego detectará cualquier cambio y compilará todo. Luego, cargará sus archivos CSS / JS finales de la /distcarpeta en su index.htmlarchivo.

Ahora que tenemos a Gulp en ejecución, echemos un vistazo más de cerca a cómo funciona Gulp.

¿Qué hay exactamente en gulpfile.js?

Aquí hay una explicación detallada de cada sección del archivo gulpfile y lo que hacen:

Paso 1: inicializar módulos npm

En la parte superior de gulpfile.js, tenemos un montón de constantes que importan los paquetes npm que instalamos anteriormente, usando la require()función.

Esto es lo que hacen nuestros paquetes:

Paquete Gulp:

  • gulp- ejecuta todo en gulpfile.js. Estamos exportando sólo las funciones específicas trago que vamos a utilizar, como src, dest, watch, y otros. Esto nos permite llamar a esas funciones directamente sin el gulp, por ejemplo, podemos simplemente escribir en src()lugar de gulp.src().

Paquetes CSS:

  • gulp-sourcemaps - asigna los estilos CSS al archivo SCSS original en las herramientas de desarrollo de su navegador
  • gulp-sass - compila SCSS a CSS
  • gulp-postcss - ejecuta autoprefixer y cssnano (ver más abajo)
  • autoprefixer - agrega prefijos de proveedores a CSS
  • cssnano - minimiza CSS
If you’ve used Gulp before, you might be wondering why I’m using straight-up autoprefixer and cssnano, instead of gulp-autoprefixer and gulp-cssnano. For some reason, using them will work, but will prevent sourcemaps from working. Read more about that issue here.

JS packages:

  • gulp-concat — concatenates multiple JS files into one file
  • gulp-uglify — minifies JS

Now that we have our modules added, let’s put them to work!

Step 2: Use the modules to run your tasks

A “task” in Gulp is basically a function that performs a specific purpose.

We’re creating a few utility tasks to compile our SCSS and JS files, and also to watch those files for any changes. Then those utility tasks will be run in our default Gulp task when we type gulpon the command line.

Creating constants for file paths

Before writing our tasks, though, we have a few lines of code that save our file paths as constants. This is optional, but I like using path variables so that we don’t have to manually retype them each time:

This code creates scssPath and jsPath constants that we will use to tell Gulp where files are found.

Sass task

Here’s the code for our Sass task:

function scssTask(){ return src(files.scssPath) .pipe(sourcemaps.init()) .pipe(sass()) .pipe(postcss([ autoprefixer(), cssnano() ])) .pipe(sourcemaps.write('.')) .pipe(dest('dist') );}

Our Sass task, called scssTask(), is doing several things. In Gulp, you can chain multiple functions by using the Gulp function pipe() after the first function.

In our task, Gulp is first running src() to load the source directory of the SCSS files. It’s using the constant we created earlier, files.scssPath.

Then after src() we’re piping everything else into the build process. You can think about it like adding more and more sections of pipe onto an existing pipe.

The functions it’s running are:

  • sourcemaps.init() — sourcemaps needs to be added first after src()
  • sass() does the compiling of all the SCSS files to one CSS file
  • postcss() runs two other plugins:
  • - autoprefixer() to add vendor prefixes to the CSS
  • - cssnano() to minify the CSS file
  • sourcemaps.write() creates the sourcemaps file in the same directory.
  • dest() tells Gulp to put the final CSS file and CSS sourcemaps file in the /dist folder.

JS task

Here’s the code for our JavaScript task:

function jsTask(){ return src([files.jsPath]) .pipe(concat('all.js')) .pipe(uglify()) .pipe(dest('dist') );}

Our JavaScript task, called jsTask(), is also running multiple functions:

  • src() to load the JS files from files.jsPath.
  • concat() to concatenate all the JS files into one JS file.
  • uglify() to uglify/minify the JS file.
  • dest() to move the final JS file into the /dist folder.

Watch task

The watch() function is a super handy part of Gulp. When you run it, it will run continuously, waiting to detect any changes to the files you tell it to watch. When it detects changes, it will run any number of tasks you tell it to.

This is great because then you don’t have to keep manually running gulp after every code change.

Here’s the code for our watch task:

function watchTask(){ watch( [files.scssPath, files.jsPath], parallel(scssTask, jsTask) );}

The watch() function takes three parameters, but we’re just using two:

  • globs, meaning the file path strings,
  • options (not used), and
  • tasks, meaning which tasks we want to run.

What we’re having our watch task do is watch the files in our scssPath and jsPath directories. Then if any changes are made in either, run the scssTask and jsTask tasks simultaneously.

Now that we’ve gotten our utility tasks set up, we need to set up our main Gulp task.

Default task

This is the main Gulp task, which will automatically run if you type in gulp on the command line.

exports.default = series( parallel(scssTask, jsTask), watchTask);

Gulp will automatically search for a default task in your gulpfile.js when you use the gulpcommand. So you must export the default task in order for it to work.

Our default task will do the following:

  • Run the scssTask and jsTask simultaneously using parallel()
  • Then run the watchTask

You’ll also notice that we are putting all those tasks inside the series() function.

This is one of the major new changes in Gulp 4 for how it handles tasks– you are required to wrap all tasks (even single ones) either in series() or parallel().

A note on registering tasks: what’s changed in Gulp 4

If you’ve been using the tasks() function to run everything, you may have noticed that there’s a difference now.

Instead of using gulp.task() to contain all your task functions, we’re creating actual functions like scssTask() and watchTask().

This is to follow Gulp’s official guidelines for creating tasks.

The Gulp team recommends using exports rather than tasks():

“In the past, task() was used to register your functions as tasks. While that API is still available, exporting should be the primary registration mechanism, except in edge cases where exports won’t work.” [Gulp Documentation]

So, while they still let you use the task() function, it’s more current to create JS functions for each task and then export them.

If you can, I’d recommend updating your syntax to reflect this, as it’s possible that Gulp will deprecate task() at some point.

Problems Migrating from Gulp 3?

If you’ve been using Gulp 3 and all you want is to get the dang thing working with Gulp 4, you’re in luck!

Before, in Gulp 3, you could simply list a single function or multiple functions in an array. However, in Gulp 4, doing so without wrapping them in either series() or parallel() will throw an error now.

Something like:

AssertionError [ERR_ASSERTION]: Task function must be specified

Gulp 4 introduces two new functions to run tasks: series() and parallel(). It gives you the option of running multiple tasks concurrently, or one after the other.

So to quickly fix the error, put all your tasks into either a series() or parallel()function.

Tasks in (old) Gulp 3 syntax

In Gulp 3, you might have run tasks this way:

gulp.task('default', ['sass', 'js', 'watch']);

gulp.watch('app/scss/*.scss', ['sass']);

Tasks in Gulp 4 syntax

Put those tasks into a series() function like this:

gulp.task('default', gulp.series('sass', 'js', 'watch'));

gulp.watch('app/scss/*.scss', gulp.series('sass'));

And that will fix the task function error with the smallest change possible! ?

Project files download

All the code I’ve displayed here is from a GitHub repository I have for front-end boilerplate. It’s meant as a quick starter kit for any simple front-end website project.

You’re welcome to check it out, customize, and use it for your own projects!

Check out the GitHub repository here.

In closing

I hope that you’ve found this walk-through of how to get Gulp 4 running helpful!

If you enjoyed this post or have a question, feel free to leave a comment below! ?

Want more?

? Read more tutorials on my blog, coder-coder.com.

? Sign up here to get emails about new articles.

? Join 24,000+ others — Follow @thecodercoder on Instagram.

? Check out coding tutorials on my YouTube channel.