This repository was archived by the owner on Feb 21, 2025. It is now read-only.

haoxins/gulp-file-includePublic archive

NotificationsYou must be signed in to change notification settings
Fork94
Star679

MAINTAINER WANTED ~ [gulp-file-include] a gulp plugin for file include

License

MIT license

679 stars 94 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 125 Commits
example		example
lib		lib
test		test
.editorconfig		.editorconfig
.gitignore		.gitignore
.npmrc		.npmrc
.travis.yml		.travis.yml
LICENSE		LICENSE
Readme.md		Readme.md
package.json		package.json

Repository files navigation

gulp-file-include

agulp plugin for file includes

Installation

npm install --save-dev gulp-file-include

API

constfileinclude=require('gulp-file-include');

fileinclude([prefix])

prefix

Type:string
Default:'@@'

fileinclude([options])

options

Type:object

options.prefix

Type:string
Default:'@@'

options.suffix

Type:string
Default:''

options.basepath

Type:string
Default:'@file'

Possible values:

'@file': include file relative to the dir in whichfile resides (example)
'@root': include file relative to the dir in whichgulp is running
path/to/dir: include file relative to the basepath you provide

options.filters

Type:object
Default:false

Filters of include content.

options.context

Type:objectDefault:{}

Context ofif statement.

options.indent

Type:booleanDefault:false

Examples

@@include options - type:`JSON`

index.html

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

view.html

<h1>view</h1>

var.html

<label>@@name</label><label>@@age</label><strong>@@socials.fb</strong><strong>@@socials.tw</strong>

gulpfile.js

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

result:

<!DOCTYPE html><html><body><h1>view</h1><label>haoxin</label><label>12345</label><strong>facebook.com/include</strong><strong>twitter.com/include</strong></body></html>

@@include_once options - type:`JSON`

index.html

<!DOCTYPE html><html><body>  @@include_once('./view.html')  @@include_once('./var.html', {    "name": "haoxin",    "age": 12345,    "socials": {      "fb": "facebook.com/include",      "tw": "twitter.com/include"    }  })  @@include_once('./var.html', {    "name": "haoxin",    "age": 12345,    "socials": {      "fb": "facebook.com/include",      "tw": "twitter.com/include"    }  })</body></html>

view.html

<h1>view</h1>

var.html

<label>@@name</label><label>@@age</label><strong>@@socials.fb</strong><strong>@@socials.tw</strong>

gulpfile.js

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

result:

<!DOCTYPE html><html><body><h1>view</h1><label>haoxin</label><label>12345</label><strong>facebook.com/include</strong><strong>twitter.com/include</strong></body></html>

filters

index.html

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

view.md

view====

gulpfile.js

constfileinclude=require('gulp-file-include');constmarkdown=require('markdown');constgulp=require('gulp');gulp.task('fileinclude',function(){gulp.src(['index.html']).pipe(fileinclude({filters:{markdown:markdown.parse}})).pipe(gulp.dest('./'));});

`if` statement

index.html

@@include('some.html', { "nav": true })@@if (name === 'test' && nav === true) {  @@include('test.html')}

gulpfile.js

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

`for` statement

index.html

<ul>@@for (var i = 0; i<arr.length;i++){<li>`+arr[i]+`</li>}</ul>

gulpfile.js

fileinclude({context:{arr:['test1','test2']}});

`loop` statement

index.html

<body>  @@loop('loop-article.html', [    { "title": "My post title", "text": "<p>lorem ipsum...</p>" },    { "title": "Another post", "text": "<p>lorem ipsum...</p>" },    { "title": "One more post", "text": "<p>lorem ipsum...</p>" }  ])</body>

loop-article.html

<article><h1>@@title</h1>  @@text</article>

`loop` statement +`data.json`

data.json

[{"title":"My post title","text":"<p>lorem ipsum...</p>"},{"title":"Another post","text":"<p>lorem ipsum...</p>"},{"title":"One more post","text":"<p>lorem ipsum...</p>"}]

loop-article.html

<body>  @@loop("loop-article.html", "data.json")</body>

`webRoot` built-in context variable

ThewebRoot field of the context contains the relative path from the source document tothe source root (unless the value is already set in the context options).

support/contact/index.html

<!DOCTYPE html><html><head><linktype=stylesheetsrc=@@webRoot/css/style.css></head><body><h1>Support Contact Info</h1><footer><ahref=@@webRoot>Home</a></footer></body></body></html>

result:

<!DOCTYPE html><html><head><linktype=stylesheetsrc=../../css/style.css></head><body><h1>Support Contact Info</h1><footer><ahref=../..>Home</a></footer></body></body></html>

License

MIT

About

MAINTAINER WANTED ~ [gulp-file-include] a gulp plugin for file include

Releases

29tags

Packages

No packages published

Contributors23

+ 9 contributors

Movatterモバイル変換

License

haoxins/gulp-file-include

Folders and files

Latest commit

History

Repository files navigation

gulp-file-include

Installation

API

fileinclude([prefix])

prefix

fileinclude([options])

options

options.prefix

options.suffix

options.basepath

options.filters

options.context

options.indent

Examples

@@include options - type:JSON

@@include_once options - type:JSON

filters

if statement

for statement

loop statement

loop statement +data.json

webRoot built-in context variable

License

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages0

Uh oh!

Contributors23

Uh oh!

Languages

@@include options - type:`JSON`

@@include_once options - type:`JSON`

`if` statement

`for` statement

`loop` statement

`loop` statement +`data.json`

`webRoot` built-in context variable

Packages