New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →

gulp-file-include

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

gulp-file-include

a gulp plugin for file include

0.6.0
Source
npm

Version published: 10 years ago

Weekly downloads: 9.8K; decreased by-2.73%

Maintainers: 1

Weekly downloads

Created: 11 years ago

Source

gulp-file-include

a plugin of gulp for file include

install

npm install gulp-file-include

options

options - type: string, just as prefix, default @@, and basepath is default @file

fileinclude('@@')

options - type: object
- prefix: string, default @@
- basepath: string, default @file, it could be @root, @file, your-basepath
- filters: object, filters of include content
- context: object, context of if statement
options.basepath - type: string, it could be
- @root, include file relative to the dir where gulp running in
- @file, include file relative to the dir where file in example
- your-basepath include file relative to the basepath you give

fileinclude({
  prefix: '@@',
  basepath: '@file'
})

important: @file is relative to the file pass to gulp, not the file include expression in, see example

fileinclude({
  prefix: '@@',
  basepath: '/home/'
})

example

index.html

<!DOCTYPE html>
<html>
  <body>
  @@include('./view.html')
  @@include('./var.html', {
    "name": "haoxin",
    "age": 12345
  })
  </body>
</html>

view.html

<h1>view</h1>

var.html

<label>@@name</label>
<label>@@age</label>

gulpfile.js

var fileinclude = require('gulp-file-include'),
  gulp = require('gulp');

gulp.task('fileinclude', function() {
  gulp.src(['index.html'])
    .pipe(fileinclude({
      prefix: '@@',
      basepath: '@file'
    }))
    .pipe(gulp.dest('./'));
});

and the result is:

<!DOCTYPE html>
<html>
  <body>
  <h1>view</h1>
  <label>haoxin</label>
<label>12345</label>
  </body>
</html>

filters

<!DOCTYPE html>
<html>
  <body>
  @@include(markdown('view.md'))
  @@include('./var.html', {
    "name": "haoxin",
    "age": 12345
  })
  </body>
</html>

view.md

view
====

var fileinclude = require('gulp-file-include'),
  markdown = require('markdown'),
  gulp = require('gulp');

gulp.task('fileinclude', function() {
  gulp.src(['index.html'])
    .pipe(fileinclude({
      filters: {
        markdown: markdown.parse
      }
    }))
    .pipe(gulp.dest('./'));
});

`if` statement

fileinclude({
  context: {
    name: 'test'
  }
});

@if (context.name === 'test') {
  @@include('test.html')
}

License

MIT

Keywords

FAQs

What is gulp-file-include?

Is gulp-file-include popular?

Is gulp-file-include well maintained?

Package last updated on 25 Nov 2014

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install