# gulp-fluid

> gulp integration of node-fluid

Latest version **1.0.0** (published 2018-06-22) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install gulp-fluid
pnpm add gulp-fluid
yarn add gulp-fluid
bun add gulp-fluid
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-06-22 |
| First published | 2018-06-22 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 18.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Georg Großberger |
| Maintainers | garfieldius |

## Links

- npm: https://www.npmjs.com/package/gulp-fluid
- Repository: https://github.com/garfieldius/gulp-fluid
- Homepage: https://github.com/garfieldius/gulp-fluid#readme
- Issues: https://github.com/garfieldius/gulp-fluid/issues
- npm.io page: https://npm.io/package/gulp-fluid

## Dependencies (4)

- [merge](https://npm.io/package/merge.md) ^1.2.0
- [through2](https://npm.io/package/through2.md) ^2.0.3
- [node-fluid](https://npm.io/package/node-fluid.md) ^1.0.0
- [plugin-error](https://npm.io/package/plugin-error.md) ^1.0.1

## Recent versions

- 1.0.0 (latest) — 2018-06-22

## README

# Fluid template engine for gulp

This module allows to use the [fluid](https://github.com/TYPO3/Fluid) template engine with gulp.

## Installation

Use your favourite package manager to add to your project:

```bash
# NPM
npm install --save gulp-fluid

# Yarn
yarn add gulp-fluid
```

## Usage

Use the module like any other gulp plugin:

```js

const gulp = require("gulp")
const fluid = require("gulp-fluid")
const vars = require("./data.json")

gulp.task("templates", () => {
  return gulp.src("./src/templates/*.html")
    .pipe(fluid({variables: vars}))
    .pipe(gulp.dest("./build/html"))
})
```

The function takes a simple object for configuration. It can have the following properties:

| Property     | Description                                                          |
|--------------|----------------------------------------------------------------------|
| php          | Path to php executeable, defaults to "php"                           |
| variables    | Any object that can be JSON serialized, passed as variables to fluid |
| layoutPaths  | Array of strings, containing path(s) to layout files                 |
| partialPaths | Array of strings, containing path(s) to partial files                |

## License

Apache License 2.0

Please see the file LICENSE, which is part of this package, or visit <https://www.apache.org/licenses/LICENSE-2.0>

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