vinyl-contents

vinyl-contents

Utility to read the contents of a vinyl file.

Usage

/*
  WARNING: This is a very naive plugin implementation
  It is only meant for demonstation purposes.
  For a more complete implementation, see: https://github.com/gulp-community/gulp-pug
*/
var through = require('through2');
var pug = require('pug');
var vinylContents = require('vinyl-contents');

function gulpPug(options) {
  return through.obj(function(file, _enc, cb) {
    vinylContents(file, function(err, contents) {
      if (err) {
        return cb(err);
      }

      if (!contents) {
        return cb();
      }

      file.contents = pug.compile(contents.toString(), options)();
      cb(null, file);
    });
  });
}

API

vinylContents(file, callback)

Warning: Only use this if interacting with a library that can only receive strings or buffers. This loads all streaming contents into memory which can cause unexpected results for your end-users.

Takes a Vinyl file and an error-first callback. Calls the callback with an error if one occur (or if the first argument is not a Vinyl file), or the file contents if no error occurs.

If the Vinyl contents are:

• A Buffer, will be returned directly.
• A Stream, will be buffered into a BufferList and returned.
• Empty, will be undefined.

License

MIT

Changelog

2.0.0 (2022-10-08)

⚠ BREAKING CHANGES

• Upgrade bl
• Update vinyl dependency
• Drop readable-stream & use bl directly (#8)
• Normalize repository, dropping node <10.13 support

Features

• Drop readable-stream & use bl directly (#8) (be2c3c0)
• Update vinyl dependency (be2c3c0)
• Upgrade bl (be2c3c0)

Miscellaneous Chores

• Normalize repository, dropping node <10.13 support (d40d2b8)