https://github.com/pandao/gulp-x-includer
Gulp plugin for include js/css/html... any file.
https://github.com/pandao/gulp-x-includer
Last synced: 3 months ago
JSON representation
Gulp plugin for include js/css/html... any file.
- Host: GitHub
- URL: https://github.com/pandao/gulp-x-includer
- Owner: pandao
- License: mit
- Created: 2015-10-17T04:56:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-10-17T06:20:39.000Z (over 9 years ago)
- Last Synced: 2025-02-09T05:48:21.009Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 145 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-x-includer
Gulp plugin for include js/css/html... any file.
### Install
```shell
$ npm install gulp-x-includer --save-dev
```
### Syntax
Default supported 4 comment syntax.
```
'' or ""
// include "path/to/xxx.js"
/* include "path/to/xxx.css" */
# include "./include/test.txt"
```
HTML :
```html
```
JavaScript :
```javascript
// include "path/to/xxx.js"
```
CSS :
```css
/* include "path/to/xxx.css" */
```
Other file (e.g. markdown .md, configure .conf, .ini ...) :
```markdown
# include "./include/test.txt"
```
### Examples
`test.html` :
```html
Test HTML Document
/* include "./css/test.css" */
/* fasdfadsfsadf */
div {color: red;}
/* fasdfadsfsadf */
/* include "./css/test1.css" */
p {color: green;}
/* fasdfadsfsadf */
strong {color: yellow;}
/* fasdfadsfsadf */
/* include "./css/test2.css" */
TEST
TEST
// include './js/test.js'
var a = 234567890, b, c;
// fadsfasdfdsafsdfsd
// fadsfasdfdsafsdfsd
// fadsfasdfdsafsdfsd
// fadsfasdfdsafsdfsd
// include './js/functions.js'
$(function(){
alert(345678);
});
```
`Gulpfile.js` :
```javascript
var gulp = require('gulp');
var includer = require("gulp-x-includer");
gulp.task("include", function(){
gulp.src(["./*.html", "./*.css", "./*.js"])
.pipe(includer())
.pipe(gulp.dest("./dist"));
});
```
Build :
```shell
$ gulp include
```
### Options
```javascript
{
debug : true | false, // print file includes for console.log(), default false.
debugOptions : true | false, // print options object for console.log(), default false.
regexs : {}, // define you include regex
transform : function(content) {} // transform include file content
}
```
### Changes
[Change logs](https://github.com/pandao/gulp-x-includer/blob/master/CHANGE.md)
### License
The [MIT](https://github.com/pandao/gulp-x-includer/blob/master/LICENSE) License.
Copyright (c) 2015 Pandao