Absolute path support about gulp-file-include

[haoxins]

sure. I use path.resolve to get full path.
so

var path = require('path');
path.resolve('/a/b', './c.html');
// '/a/b/c.html'
path.resolve('/a/b', '/c.html');
// '/c.html'

[euro]

What I have so far:

HTML template files that are named with .tmpl extension in many different folder levels all over the site
HTML partial files are named with *.inc extension and are all stored in the following location (/snippets/.inc)

What I want to do is not have to keep track of all my host templates' location in the site - messing with (../.inc) (../../../.inc)

The following code works but is relative based:

HTML files currently have this in them:

    @@include('../../snippets/_head.inc')

I'd like all the HTML files to have the same include statement regardless of where its located in the file structure inside the site
@@include('/snippets/_head.inc')

This is the gulp file that runs it...

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

    gulp.task('include', function() {
        gulp.src(['**/*.tmpl'])
        .pipe(include({prefix: '@@',basepath: '@file'}))
        .pipe(rename({extname: ""}))
        .pipe(rename({extname: ".html"}))
        .pipe(chmod(444))
        .pipe(gulp.dest('./'))
    });

so I guess I need to add the following into my gulp file somewhere:

 var path = require('path');
 path.resolve('/a/b', './c.html');
 // '/a/b/c.html'
 path.resolve('/a/b', '/c.html');
 // '/c.html'

I tried this but it's not working:

    var gulp = require('gulp'),
        include = require('gulp-file-include'),
        rename = require('gulp-rename'),
        chmod = require('gulp-chmod');
        path = require('path');  // DO I HAVE TO INSTALL THIS OR IS IT ALREADY IN NODE.JS? I' can't find gulp-path?

    gulp.task('include', function() {

        path.resolve('/snippets', './*.inc');
        // '/snippets/*.inc'
        path.resolve('/snippets', '/*.inc');
        // '/*.inc'

    gulp.src(['**/*.tmpl'])
        .pipe(include({prefix: '@@',basepath: '@file'}))
        .pipe(rename({extname: ""}))
        .pipe(rename({extname: ".html"}))
        .pipe(chmod(444))
        .pipe(gulp.dest('./'))
        .pipe(notify({ message: 'include task complete' }));
    });

[haoxins]

so I guess I need to add the following into my gulp file somewhere:

no, you needn't.

path = require('path'); // DO I HAVE TO INSTALL THIS OR IS IT ALREADY IN NODE.JS

path is in node, see doc

You just need absolute path in include expression, such as

@@include('/Users/hx/a.html')

give a demo here.

/Users/hx/gulpfile.js

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

gulp.task('include', function() {
  gulp.src(['a.html'])
    .pipe(fileinclude({
      prefix: '@@'
    }))
    .pipe(gulp.dest('./result/'));
});

/Users/hx/a.html

@@include('/Users/hx/b.html')

/Users/hx/b.html

test file: b.html

[euro]

So if I have to go all the way back to the root of the hard drive that probably won't work since Im in a collaborative environment and other folks on my team are even on (gasp) windows machines. When they check out of svn they will have my file paths in all the HTML templates. Maybe I can use a variable that they can manage in their local gulpfile?

[haoxins]

yes, it's hard to work with others by absolute path.

[euro]

It would be awesome if I could use a variable in the include path thats in the HTML template and store the variable in the gulp file.

HTML template
@@include('%fullpath%/b.html')

Gulpfile.js
var.fullpath: '/something/something/'

[haoxins]

just try

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

gulp.task('include', function() {
  gulp.src(['a.html'])
    .pipe(fileinclude({
      prefix: '@@',
      basepath: '/something/something/'
    }))
    .pipe(gulp.dest('./result/'));
});

see readme

options.basepath - type: string, it could be
your-basepath include file relative to the basepath you give

[euro]

That works!, now each @@include just references the actual filename. I only have to manage the full path to the folder where the included files live in the gulp file. Thats easy to manage in a collaborative environment.

1. Pull each *.tmpl file no matter where it is in my nested folders
2. strip the extension
3. name the extension.html
4. save it in the same directory

(I'm also doing some other stuff in my gulp task that I stripped out of this response like locking the *.html files with chmod to 444 to prevent someone from forgetting and editing a *.html file.)

    gulp.task('include', function() {
        return gulp.src('**/*.tmpl')
        .pipe(include({prefix: '@@',basepath: '/Users/euro/WebServer/sitexxx/snippets/'}))
        .pipe(rename({extname: ""}))
        .pipe(rename({extname: ".html"}))
        .pipe(gulp.dest('./'))
        .pipe(notify({ message: 'include task complete' }));
    });