gulp-caddy v0.0.12-alpha

Requireable task runners. Get up and running with building files a little quicker.

Minimal config, but fairly opinionated. Uses Gulp v4.x

Gulp Caddy

How it works

Gulp Caddy aims to speed up your time-to-actually-writing-code by using pre-authored gulp tasks taken from Chris Ferdinandi's excellent Gulp Boilerplate.

On first install, two files will be copied to your project folder.

1. caddy.config.js - adjust settings and directories
2. gulpfile.js - import Gulp Caddy

As a bonus, your package.json will be much tidier by leaving all the core gulp tasks inside the /node_modules/ directory.

Using Gulp Caddy in your projects

You will need Node.js and Gulp CLI installed globally.

Dependencies

Note: if you've previously installed Gulp globally, run npm rm --global gulp to remove it. Details here.

Make sure these are installed first:

• Node.js
• Gulp Command Line Utility npm install --global gulp-cli

Starting a new project

npm init --yes npm install gulp gulp-caddy --save

Run gulp or gulp watch as per Gulp Boilerplate quick start guide

🃏 Running the tests

Tests are written using Jest, and can be found in /tests/index.test.js when cloning the repo. New tests would be welcome contributions!

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Michael Gale - First draft + maintainer - miclgael
• Luke Martin - Maintainer - iamlukem

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENCE file for details

Acknowledgments

• Travis Maynard
• Chris Ferdinandi

ROADMAP

• ultimately, it would be nice to npm install, then require as a dependency to use.
• get all of those dependencies out of the root project's package.json
• gulp-caddy.config file to alter options from the root of the project
• modularize all the pieces of the gulp file.
• create a process to "eject" from using caddy, and pull all tasks and dependencies back to package.json - for when the project scope gets bigger.