# gulp-jade-globbing

> Globbing Jade includes & extends the easy way.

Latest version **0.1.9** (published 2015-10-12) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install gulp-jade-globbing
pnpm add gulp-jade-globbing
yarn add gulp-jade-globbing
bun add gulp-jade-globbing
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.9 |
| Published | 2015-10-12 |
| First published | 2015-03-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Thomas Creeten |
| Maintainers | creeation |
| Keywords | gulp, gulpplugin, jade, glob, globbing |

## Links

- npm: https://www.npmjs.com/package/gulp-jade-globbing
- Repository: https://github.com/CREEATION/gulp-jade-globbing
- Issues: https://github.com/CREEATION/gulp-jade-globbing/issues
- npm.io page: https://npm.io/package/gulp-jade-globbing

## Dependencies (3)

- [glob](https://npm.io/package/glob.md) ^4.0.5
- [colors](https://npm.io/package/colors.md) ^1.0.3
- [vinyl-map](https://npm.io/package/vinyl-map.md) ^1.0.1

## Recent versions

- 0.1.9 (latest) — 2015-10-12
- 0.1.8 — 2015-08-29
- 0.1.7 — 2015-06-16
- 0.1.6 — 2015-03-05
- 0.1.5 — 2015-03-04
- 0.1.4 — 2015-03-04
- 0.1.3 — 2015-03-04
- 0.1.2 — 2015-03-04

## README

# gulp-jade-globbing
> Globbing with Jade the easy way.

Expands Jade `include` and `extends` statements to allow globbing and placeholders.

Based on [`gulp-css-globbing`](https://github.com/jsahlen/gulp-css-globbing).

## Install

Install `gulp-jade-globbing` as a development dependency using npm:

```shell
npm install --save-dev gulp-jade-globbing
```

## Usage without options

### gulpfile
```javascript
var jade          = require('gulp-jade');
var jadeGlobbing  = require('gulp-jade-globbing');

gulp.task('jade', function(){
  gulp.src(['src/index.jade'])
    .pipe(jadeGlobbing())
    .pipe(jade())
    .pipe(gulp.dest('build'));
});
```

### src/index.jade
```jade
//- ...
include ../foo/bar/**/*.jade
//- ...
```

## Advanced example

### gulp task
```javascript
gulp.task('jade', function(){
  gulp.src(['src/views/**/*.jade'])
    .pipe(jadeGlobbing({
      placeholder: {
        'modules': 'src/modules/**/*.jade',
        'layout': 'src/layout/**/*',
        'default-template': 'src/layout/templates/default.jade',
      }
      ignore: [
        'src/views',
        'src/layout/templates'
      ]
    }))
    .pipe(jade())
    .pipe(gulp.dest('build'));
});
```

### page
```jade
extends {default-template}

block includes
  include ../../utilities/**/*.jade
  include ../../base/*.jade
  include {modules}
  include {layout}

block container
  h1 Hello World!
```

### template to extend
```jade
block includes
doctype html
html
  head
    meta(charset='utf-8')
    title Hello?

  body
    block container
```

## Options

`gulp-jade-globbing` can be called with an options object:

```javascript
gulp.task('jade', function(){
  gulp.src(['src/index.jade'])
    .pipe(jadeGlobbing({
      placeholder: {
        'base': 'src/jade/base/*.jade',
        'modules': 'src/jade/modules/**/*.jade',
        'layout': 'src/jade/layout/**/*',
        'default-template': 'src/jade/layout/templates/default.jade',
      }
      ignore: ['src/jade/layout/templates']
    }))
    .pipe(jade())
    .pipe(gulp.dest('build'));
});
```

### ignore
Type: `String` or `Array`

Folders gulp-jade-globbing should ignore.

Default: `[]`

### placeholder
Type: `Object`

Placeholders to use within jade files, e.g. `{modules}`.

Default: `{}`

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