A Gulp 4 használata a Sass és JS fájlok munkafolyamatában

Ezt a bejegyzést eredetileg a Coder-Coder.com oldalon tették közzé.

Ez az oktatóanyag lépésről lépésre elmagyarázza, hogyan kell beállítani a Gulp 4-et a munkafolyamatban, valamint hogyan kell áttérni a Gulp 3-ról a Gulp 4 szintaxisára.

Csak gyorsan kell megszereznie a Gulp 3 gulpfile.js-t a Gulp 4-gyel? Kattintson ide, hogy jobbra lépjen a bejegyzés adott részére.
  1. Futtatással telepítse a gulp-cli parancsot a parancssorba npm install gulp-cli -g.
  2. Telepítse a Gulp futtatásával npm install gulp.
  3. Telepítsen más npm csomagokat a Gulp munkafolyamatához.
  4. Hozzon létre egy gulpfile.jsfájlt a projekt gyökérkönyvtárában.
  5. Importálja npm csomagjait modulokként a gulpfile-ba.
  6. Adja hozzá feladatait a gulpfile-hez az SCSS / JS fájlok fordításához és egy figyelő feladat futtatásához.
  7. Futtassa a gulpparancsot az összes feladat futtatásához.

Mi az a Gulp és mit csinál?

A Gulp egy olyan eszköz, amely különféle feladatokat futtat az Ön számára a webfejlesztési munkafolyamatban. Lehet, hogy csomagnak, build eszköznek vagy feladat futónak hívják. Nagyjából ugyanazt jelentik.

Hasonló eszközök a Webpack és a Grunt (bár a Grunt gyorsan elavul).

Íme, mit fognak tenni Gulp helyettünk:

  1. Fordítsa le Sass fájljainkat CSS-be
  2. Adjon hozzá szállító előtagokat a CSS-hez
  3. Csökkentse a végső CSS fájlunkat
  4. Összekapcsoljuk (azaz egyesítjük) a JS fájljainkat
  5. Uglify a végleges JS fájlunkat
  6. Helyezze át a végleges CSS / JS fájlokat a /distmappánkba.

Nagyon klassz, nem ?!

Tehát úgy működik, hogy az összes beállítás és feladat gulpfile.jsfájlba kerül. És a parancssorán futtatja a Gulp-ot.

Ennek nagy része az, hogy ha az összes fájl elkészült, könnyen újra felhasználhatja más projektekhez. Szóval óriási időmegtakarítás!

Térjünk át a Gulp telepítésére és beállítására a számítógépen.

A Gulp telepítése működő demo projekt használatával

A Gulp futtatása előtt telepítenie kell néhány dolgot:

  • Telepítse a Node.js fájlt, ha még nem rendelkezik vele.
  • Telepítse a Gulp parancssori segédprogramot futtatással npm install --global gulp-cli.

Ha már működik a Gulp, nézzen meg egy demóprojektet, amelyet én építettem és amely Gulpot használja! Ez egy front-end kazán projekt, amelynek célja, hogy gyors módot kínáljak bármilyen egyszerű front-end webhely megkezdésére.

(Az oktatóanyag további részében rengeteg kódrészletem van, így csak ezekre is hivatkozhatsz!)

Az elülső kazán projektjének beállítása:

  • Klónozza vagy töltse le a projekt Git repóját a számítógépére.
  • Nyissa meg a projektet, és a root projekt mappában lépjen a parancssorba, és futtassa npm install. Ez telepíti a package.jsonfájlban felsorolt ​​npm csomagokat , különösen a Gulp 4-et.

Most be kell állítania a projektfájlokat, és telepítenie kell az összes npm csomagot, amelyet a Gulp feladatok futtatásához fogunk használni.

Mivel a repóból származó fájlok készen állnak a indulásra, ha beírja gulpa parancssort, akkor egy ilyen kimenetet kell látnia:

> 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'...

És te futtattad Gulp-ot!

Mi történik a projektben, amikor a Gulp-ot futtatja?

Rendben, sikeresen működik a projekt! Most térjünk ki részletesebben arra, hogy mi van a projektben és hogyan működik.

Először íme a projekt fájlstruktúrájának gyors áttekintése:

  • index.html - a fő HTML fájl
  • package.json - az összes futtatásakor telepítendő npm csomagot tartalmazza npm install.
  • gulpfile.js - tartalmazza a konfigurációt és futtatja az összes Gulp feladatot
  • / app - működő mappa, itt szerkesztheti az SCSS / JS fájlokat
  • / dist - A Gulp itt fogja kinyomtatni a fájlokat, ne szerkessze ezeket a fájlokat

Munkafolyamatában szerkesztheti a HTML, SCSS és JS fájlokat. A Gulp ekkor észleli az esetleges változásokat és mindent összeállít. Ezután betölti a végső CSS / JS fájlokat /dista index.htmlfájl mappájába .

Most, hogy fut a Gulp, nézzük meg közelebbről a Gulp működését.

Mi található pontosan a gulpfile.js fájlban?

Itt van egy részletes magyarázat a gulpfile egyes szakaszairól és azok működéséről:

1. lépés: Inicializálja az npm modulokat

A legtetején gulpfile.jsegy csomó állandó áll rendelkezésünkre, amelyek a require()függvény segítségével importálják a korábban telepített npm csomagokat .

Csomagjaink a következőket teszik:

Gulp csomag:

  • gulp- mindent lefuttat a gulpfile.js fájlban. Mi exportáló csak a megadott korty funkciókat, hogy mi lesz a hasonlóan src, dest, watchés mások. Ez lehetővé teszi számunkra, hogy közvetlenül meghívjuk ezeket a függvényeket anélkül gulp, hogy például beírnánk a src()helyett gulp.src().

CSS csomagok:

  • gulp-sourcemaps - a CSS stílusokat visszaképezi az eredeti SCSS fájlba a böngésző fejlesztői eszközein
  • gulp-sass - összeállítja az SCSS-t CSS-be
  • gulp-postcss - fut az autoprefixer és a cssnano (lásd alább)
  • autoprefixer - szállító előtagokat ad hozzá a CSS-hez
  • cssnano - minimalizálja a CSS-t
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.