JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8102
  • Score
    100M100P100Q121734F
  • License MIT

A gulp plugin for wrapping files with custom strings. Access to filename is given through interpolation.

Package Exports

  • gulp-wrapper

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-wrapper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gulp-wrapper

Build Status NPM version

A Gulp plugin for wrapping files with custom strings. Basically gulp-header & gulp-footer together. With the addition that the filename is revealed to the user ( with ${filename} ).

##Usage For example, on build I can wrap an HTML file with <script> template tags and specify the filename id. ( angular templates are a good use case )

sample template file

<div>
  <span>my template HTML is here</span>
</div>

so in my gulpfile.js I can do

var gulp    = require('gulp'),
    wrapper = require('gulp-wrapper');

// ...
gulp.src('template.html')
    .pipe(wrapper({
       header: '<script type="text/ng-template" id="${filename}">\n',
       footer: '</script>\n'
    }))
    .pipe(gulp.dest('out'));

the result is :

<script type="text/ng-template" id="template.html">
<div>
  <span>my template HTML is here</span>
</div>
</script>

##API

###wrapper(options)

####options.header Type: String

The string you want to prepend to the file. The file name is available through interpolation ${filename}

//...
gulp.src('script/*.js')
    .pipe(wrapper({ header: '/* ${filename} MyCompany 2014 */'}))

####options.footer Type: String

The string you want to append to the file. The file name is available through interpolation ${filename}

//...
gulp.src('script/*.js')
    .pipe(wrapper({ footer: '/* ${filename} MyCompany 2014 */'}))