# gulpfile-boilerplate

> A Gulp boilerplate that can be customized & extended for your projects.

Latest version **0.0.1** (published 2019-04-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulpfile-boilerplate
pnpm add gulpfile-boilerplate
yarn add gulpfile-boilerplate
bun add gulpfile-boilerplate
```

Provides the command `gulpfile-boilerplate`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2019-04-18 |
| First published | 2019-04-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12.0 |
| Dependencies | 2 |
| Unpacked size | 438.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Bruce Bentley |
| Maintainers | brucebentley |
| Keywords | boilerplate, browser-sync, cli, gulp, node.js |

## Links

- npm: https://www.npmjs.com/package/gulpfile-boilerplate
- Repository: https://github.com/brucebentley/gulpfile-boilerplate
- Homepage: https://github.com/brucebentley/gulpfile-boilerplate#readme
- Issues: https://github.com/brucebentley/gulpfile-boilerplate/issues
- npm.io page: https://npm.io/package/gulpfile-boilerplate

## Dependencies (2)

- [cli-list](https://npm.io/package/cli-list.md) 0.2.0
- [inquirer](https://npm.io/package/inquirer.md) 6.3.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2019-04-18

## README

# gulpfile-boilerplate [![Build Status](https://travis-ci.org/brucebentley/gulpfile-boilerplate.svg?branch=master)](https://travis-ci.org/brucebentley/gulpfile-boilerplate) [![codecov](https://codecov.io/gh/brucebentley/gulpfile-boilerplate/branch/master/graph/badge.svg)](https://codecov.io/gh/brucebentley/gulpfile-boilerplate)

Are you tired of always having to manually set up a `gulpfile.js` for every new project? Me too, that's why I've written this small tool that will generate the `gulpfile.js` for you, based on your needs.  

`gulpfile-boilerplate` is an interactive tool to help your create your custom `gulpfile.js`. `gulpfile-boilerplate` is run as an CLI where you will be asked for what tasks you want in your `gulpfile.js`. When it is done it will generate a `gulpfile.js` in the same folder as you are standing in. You can then optionally let it generate a file containing the exact `npm` command to install the dependencies you need for your `gulpfile.js`.

## Installation

Since you probably want to use this tool for multiple projects, it makes sense to let it live in your global `node_modules` folder _(hence the `g` flag)_.

```bash
npx gulpfile-boilerplate
```

## Usage

```bash
npx gulpfile-boilerplate
```
This will start up an interactive interface where you should follow the instructions.

## Supports

* **Development server** using [browser-sync](https://github.com/BrowserSync/browser-sync)
* JavaScript
  * **Minification** using [gulp-uglify](https://github.com/terinjokes/gulp-uglify)
  * **Concatenation** using [gulp-concat](https://github.com/contra/gulp-concat)
  * **JSHint** using [gulp-jshint](https://github.com/spalger/gulp-jshint)
  * **Compiling CoffeeScript** using [gulp-coffee](https://github.com/contra/gulp-coffee)
  * **Converting ES6 to ES5** using [gulp-babel](https://github.com/babel/gulp-babel)
* CSS
  * **LESS** using [gulp-less](https://github.com/plus3network/gulp-less)
  * **Sass** using [gulp-sass](https://github.com/dlmanning/gulp-sass)
  * **Stylus** using [gulp-stylus](https://github.com/stevelacy/gulp-stylus)
  * **Lint** using [gulp-csslint](https://github.com/lazd/gulp-csslint)
  * **Autoprefixer** using [gulp-autoprefixer](https://github.com/sindresorhus/gulp-autoprefixer)
  * **Minification** using _gulp-minify-css_ (will be replaced by [gulp-clean-css](https://github.com/scniro/gulp-clean-css))
* Images
  * **Minification** using [gulp-imagemin](https://github.com/sindresorhus/gulp-imagemin)

## Development

1. Install dependencies and make CLI available in root:

   ```bash
   make install link`
   ```

2. Do code changes.
3. Run boilerplate with:

   ```bash
   ./gulpfile-boilerplate
   ```

4. Run linter and tests:

   ```bash
   make lint test
   ```

---
_Source: https://npm.io/package/gulpfile-boilerplate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._