diff options
Diffstat (limited to 'build/basic-gulp-build-for-sass')
| -rw-r--r-- | build/basic-gulp-build-for-sass/index.html | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/build/basic-gulp-build-for-sass/index.html b/build/basic-gulp-build-for-sass/index.html new file mode 100644 index 0000000..623dde2 --- /dev/null +++ b/build/basic-gulp-build-for-sass/index.html @@ -0,0 +1,122 @@ +<!doctype html> +<html lang="en" id="top"> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="icon" href="data:,"> + <title>Basic Gulp Build for Sass</title> + <link href="https://bt.ht/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}table{text-align:left;width:100%;}</style> +</head> + +<nav> + <a href="#menu">Menu ↓</a> +</nav> + +<main> +<h1>Basic Gulp Build for Sass</h1> +<p>2019-01-15</p> +<p>Some designers might shy away from build tools when first starting out and I can understand the reasoning - task runners like <code>gulp</code> and <code>grunt</code> can seem daunting at first. So, I've decided to showcase my go-to setup for <code>gulp</code> and explain what the heck it does step-by-step. </p> +<p>Here is the final <code>gulp.js</code> file in all it's glory:</p> +<pre><code>var gulp = require('gulp'); +var shell = require('gulp-shell'); +var sass = require('gulp-sass'); + +/* Build and watch Jekyll (change this task to whatever you need) */ +gulp.task('generate', shell.task('jekyll serve')); + +/* Compile SCSS files to CSS */ +gulp.task('styles', function () { + return gulp.src('_includes/assets/sass/styles.scss') + .pipe(sass({ + outputStyle: 'compressed' + }).on('error', sass.logError)) + .pipe(gulp.dest('_includes/assets/css/')); +}); + +/* Compile the assets */ +gulp.task('assets', gulp.parallel( + 'styles' +)); + +/* Build */ +gulp.task('build', gulp.series( + 'assets', + 'generate' +)); +</code></pre> +<p>Trust me, it's not complicated at all.</p> +<h2>Grabbing what we need</h2> +<p>For our basic build file we are going to need only three modules: <code>gulp</code>, <code>gulp-shell</code> and <code>gulp-sass</code>.</p> +<pre><code>var gulp = require('gulp'); +var shell = require('gulp-shell'); +var sass = require('gulp-sass'); +</code></pre> +<h4>gulp</h4> +<p>This is the streaming build system, without it we can't do anything else.</p> +<h4>gulp-shell</h4> +<p>A gulp command line interface for us to interact with our terminal.</p> +<h4>gulp-sass</h4> +<p>Required for gulp to compile Sass into vanilla CSS.</p> +<h4>Bonus tasks</h4> +<p><p>You can also toss in <code>gulp-minify</code> to clean-up any JavaScript you might be using, but for this example we're just going to keep things simple and focus on Sass only.</p></p> +<p><p class="no-margin">Maybe I'll write about my <code>js</code> build workflow in a future article.</p></p> +<h2>Generating the build</h2> +<p>Our first step is to create the default task that will generate our build. In this example we are making the assumption that we're building a Jekyll website (but you can place any build command here):</p> +<pre><code>gulp.task('generate', shell.task('jekyll serve')); +</code></pre> +<p>Don't worry if this <code>generate</code> isn't clear, we come back to that later.</p> +<h2>Processing our pre-processor</h2> +<p>We will name this next task <code>styles</code> since that's what it outputs - our styling. We start by telling gulp where our main <code>scss</code> directory is:</p> +<pre><code>/* Change this directory to match yours */ +return gulp.src('_includes/assets/sass/styles.scss') +</code></pre> +<p>This next piece tells the plugin to compress our final compiled CSS, log any errors if there are issues with the build and then export it to our destination directory:</p> +<pre><code>.pipe(sass({ + outputStyle: 'compressed' +}).on('error', sass.logError)) +</code></pre> +<pre><code>/* Change this to your destination directory */ +.pipe(gulp.dest('_includes/assets/css/')); +</code></pre> +<h2>Building our assets</h2> +<p>This step isn't 100% needed, but I like to include it for when more assets need to be added (minifying JavaScript, compressing images, etc)</p> +<pre><code>/* +Compile the assets +*/ +gulp.task('assets', gulp.parallel( + 'styles' +)); +</code></pre> +<h2>Altogether now!</h2> +<p>Now we add a task that runs all other tasks in our gulp file (in this case it will run both <code>assets</code> and <code>generate</code>)</p> +<pre><code>/* +Build +*/ +gulp.task('build', gulp.series( + 'assets', + 'generate' +)); +</code></pre> +<p>And that's it - we're done! A very basic <code>gulp</code> build for compiling Sass.</p> +<footer role="contentinfo"> + <h2>Menu Navigation</h2> + <ul id="menu"> + <li><a href="/">Home</a></li> + <li><a href="/projects">Projects</a></li> + <li><a href="/uses">Uses</a></li> + <li><a href="/wiki">Wiki</a></li> + <li><a href="/resume">Resume</a></li> + <li><a href="/colophon">Colophon</a></li> + <li><a href="/now">Now</a></li> + <li><a href="/donate">Donate</a></li> + <li><a href="/atom.xml">RSS</a></li> + <li><a href="#top">↑ Top of the page</a></li> + </ul> + <small> + Built with <a href="https://git.sr.ht/~bt/barf">barf</a>. <br> + Maintained with ♥ for the web. <br> + Proud supporter of <a href="https://usefathom.com/ref/DKHJVX">Fathom</a> & <a href="https://nextdns.io/?from=74d3p3h8">NextDNS</a>. <br> + The content for this site is <a href="https://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA</a>.<br> The <a href="https://git.sr.ht/~bt/bt.ht">code for this site</a> is <a href="https://git.sr.ht/~bt/bt.ht/tree/master/item/LICENSE">MIT</a>. + </small> +</footer>
\ No newline at end of file |