Registry / web-framework / gulp-underscore-template

gulp-underscore-template

library1.0.0jsnpmunverified

Gulp plugin that compiles Underscore template (`.html`) files into a single CommonJS module. Version 1.0.0 (latest, 2014) – no updates since. Differentiates by providing a Gulp-stream-friendly API for precompiling templates, enabling minification before compilation, and outputting a require-able module. Alternatives exist in more maintained gulp- template plugins (e.g., gulp-template-compile).

web-framework serialization

npm install gulp-underscore-template

package ↗

INSTALL

IMPORT

SIG · GULP-UNDERSCORE-TE

gulp-underscore-template

web-frameworkjavascriptv1.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import template from 'gulp-underscore-template'

✗ const template = require('gulp-underscore-template');

ESM default import; CommonJS require also works with default export. Plugin is a function.

require('./lib/templates')

✓ const templates = require('./lib/templates');

✗ import templates from './lib/templates'

Output module uses CommonJS; ESM import requires default interop (module has no default export).

templates['some-page']

✓ const tpl = templates['some-page'];

✗ const tpl = templates.somePage;

Template keys match filenames (with extension removed), but hyphens require bracket notation.

Compiles all HTML templates into a single CommonJS module using gulp pipeline.

var gulp = require('gulp'); var concat = require('gulp-concat'); var htmlmin = require('gulp-htmlmin'); var template = require('gulp-underscore-template'); gulp.task('templates', function() { return gulp.src('./templates/*.html') .pipe(htmlmin({ collapseWhitespace: true, conservativeCollapse: true })) .pipe(template()) .pipe(concat('templates.js')) .pipe(gulp.dest('./lib/')); });

Debug

Known issues

deprecatedPackage has not been updated since 2014 and is effectively unmaintained.

fix

Consider using actively maintained alternatives like gulp-template-compile or gulp-angular-templatecache for newer projects.

affects: >=1.0.0

gotchaTemplate filenames are used as keys with extension removed; hyphens are preserved, requiring bracket notation for access.

fix

Use bracket notation: templates['file-name'] instead of templates.fileName.

affects: >=1.0.0

gotchaOutput module uses CommonJS `module.exports`, so ESM consumers need a default import interop or enable esModuleInterop.

fix

In TypeScript, set esModuleInterop: true; otherwise use `const templates = require(...)`.

affects: >=1.0.0

gotchaPlugin does not minify HTML; user must pipe through htmlmin separately.

fix

Add .pipe(htmlmin({...})) before .pipe(template()).

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: _.template is not a function

Missing underscore peer dependency or version mismatch.

fix

Install underscore: npm install underscore --save (must be a runtime dependency in consuming project).

Cannot find module 'gulp-underscore-template'

Package not installed.

fix

Run: npm install gulp-underscore-template --save-dev (requires gulp as well).

SyntaxError: Unexpected token import

Output file uses CommonJS; importing it via ESM without transpilation fails.

fix

Use require() or transpile the output file with Babel/TypeScript.

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

underscorerequiredPeer runtime dependency for compiled template execution

Agent activity

6 hits · last 30 days

node

Resources

packagehttps://www.npmjs.com/package/gulp-underscore-template ↗