stimulant-gulpfile

The powerful gulpfile used by stimulant, now available as a standalone NPM package.

Usage no npm install needed!

<script type="module">
  import stimulantGulpfile from 'https://cdn.skypack.dev/stimulant-gulpfile';
</script>

README

stimulant-gulpfile NPM version Build status

The powerful gulpfile used by stimulant, now available as a standalone NPM package that you can utilize for your own purposes.

Installation

Install the package with NPM:

$ npm install stimulant-gulpfile --save-dev

Usage

Inside your gulpfile.js, import the package:

require("stimulant-gulpfile");

Or alternatively, create a symlink:

$ ln -s node_modules/stimulant-gulpfile/dist/index.js gulpfile.js

This will automatically enable the following runnable gulp tasks:

  • watch — spawn a daemon that performs automatic rebuilds whenever files change.
  • build — build everything.
  • build-index — build main index.html file.
  • build-scripts — build script files.
  • build-styles — build stylesheet files.
  • build-images — build image files.
  • build-fonts — build font files.
  • build-audio — build audio files.
  • build-videos — build video files.
  • build-misc — build miscellaneous files.
  • check-dependencies — confirm that all NPM dependencies are installed.
  • clean — destroy the most recent build.

In other words, it effectively turns your gulpfile into a simple (and powerful) one-liner — no further configuration required!

Environment Injection

Any code in scripts that matches the #env{SOME_ENV} pattern is a candidate for environment injection. The injection process takes place during the build-scripts task and effectively replaces the entire contents of the pattern with the value of process.env.SOME_ENV if not undefined.

Other

Specifying the environment variable GULP_PORT will enable you to run on a custom port number.