@coldfrontlabs/gulp-templates

@coldfrontlabs/gulp-templates

Templates for quick gulp task set-up.

This project assumes users have a basic understanding of how Gulp works. If you require more information on the basics of Gulp, please read the official documentation.

Installation

# latest stable
npm install -D gulp
npm install -D @coldfrontlabs/gulp-templates

Features

CSS

• Lint
• Fix
• Compile
• Minify

JavaScript

• Lint
• Fix
• Compile
• Minify

Libraries/Dependencies

• Fetch

Sass/SCSS

• Lint
• Fix
• Compile

Upgrading from version 1.x?

Check out the upgrade guide!

Sample gulpfile.js

This file will give you a basic example of how to use the templates.

const { series } = require("gulp");
const { js } = require("@coldfrontlabs/gulp-templates");

/**
 * Compiles all JS files using Babel.
 *
 * @returns {object} - Gulp stream.
 */
const compile = () =>
  js.compile({
    source: "src/js/**/*.js",
    destination: "dist/js",
  });

/**
 * Minifies all JS files.
 *
 * @returns {object} - Gulp stream.
 */
const minify = () =>
  js.minify({
    source: ["dist/js/*.js", `!dist/js/*.min.js`],
    destination: "dist/js",
  });

const build = series(compile, minify);
build.description = "Compiles, and minifies all JS files.";

exports.default = build;

Using the latest JavaScript version

If you want to use the latest greatest JavaScript, follow the setup instructions for Gulp on the official package.

Here is the example from above written in ES2015.

import { series } from "gulp";
import { js } from "@coldfrontlabs/gulp-templates";

/**
 * Compiles all JS files using Babel.
 *
 * @returns {object} - Gulp stream.
 */
const compile = () =>
  js.compile({
    source: "src/js/**/*.js",
    destination: "dist/js",
  });

/**
 * Minifies all JS files.
 *
 * @returns {object} - Gulp stream.
 */
const minify = () =>
  js.minify({
    source: ["dist/js/*.js", `!dist/js/*.min.js`],
    destination: "dist/js",
  });

const build = series(compile, minify);
build.description = "Compiles, and minifies all JS files.";

export default build;

More examples can be found here.

Versioning

This project uses Semantic Versioning 2.0.0 to keep track of releases.

For more detailed information about SemVer, please see the official documentation.

Contributing

If you're interested in contributing to the project, please read the Contribution Guidelines. Any and all contributions must follow these guidelines or they will not be accepted.

Changelog

6.0.0 (2022-03-15)

⚠ BREAKING CHANGES

• lib: lib.fetch will run a default rename function to change all @ symbols to _ in the directory path

Features

• lib: add rename, default rename function, and rename customization to fetch (dfc682a)

Documentation

• add security policy (1634412)

Build System

• add proper jsdoc config (d580459)
• bump eslint-plugin-jsdoc from 37.9.7 to 38.0.3 (a8b3398)
• github: add CodeQL workflow (f019b1e)
• github: add dependabot (00bfaba)