| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128 |
- var path = require('path');
- var cloneStats = require('clone-stats');
- var isBuffer = require('./lib/isBuffer');
- var isStream = require('./lib/isStream');
- var isNull = require('./lib/isNull');
- var inspectStream = require('./lib/inspectStream');
- var cloneBuffer = require('./lib/cloneBuffer');
- function File(file) {
- if (!file) file = {};
- // TODO: should this be moved to vinyl-fs?
- this.cwd = file.cwd || process.cwd();
- this.base = file.base || this.cwd;
- this.path = file.path || null;
- // stat = fs stats object
- // TODO: should this be moved to vinyl-fs?
- this.stat = file.stat || null;
- // contents = stream, buffer, or null if not read
- this.contents = file.contents || null;
- }
- File.prototype.isBuffer = function() {
- return isBuffer(this.contents);
- };
- File.prototype.isStream = function() {
- return isStream(this.contents);
- };
- File.prototype.isNull = function() {
- return isNull(this.contents);
- };
- // TODO: should this be moved to vinyl-fs?
- File.prototype.isDirectory = function() {
- return this.isNull() && this.stat && this.stat.isDirectory();
- };
- File.prototype.clone = function() {
- var clonedContents = this.isBuffer() ? cloneBuffer(this.contents) : this.contents;
- var clonedStat = this.stat ? cloneStats(this.stat) : null;
- return new File({
- cwd: this.cwd,
- base: this.base,
- path: this.path,
- stat: clonedStat,
- contents: clonedContents
- });
- };
- File.prototype.pipe = function(stream, opt) {
- if (!opt) opt = {};
- if (typeof opt.end === 'undefined') opt.end = true;
- if (this.isStream()) {
- return this.contents.pipe(stream, opt);
- }
- if (this.isBuffer()) {
- if (opt.end) {
- stream.end(this.contents);
- } else {
- stream.write(this.contents);
- }
- return stream;
- }
- if (this.isNull()) {
- if (opt.end) stream.end();
- return stream;
- }
- return stream;
- };
- File.prototype.inspect = function() {
- var inspect = [];
- // use relative path if possible
- var filePath = (this.base && this.path) ? this.relative : this.path;
- if (filePath) {
- inspect.push('"'+filePath+'"');
- }
- if (this.isBuffer()) {
- inspect.push(this.contents.inspect());
- }
- if (this.isStream()) {
- inspect.push(inspectStream(this.contents));
- }
- return '<File '+inspect.join(' ')+'>';
- };
- // virtual attributes
- // or stuff with extra logic
- Object.defineProperty(File.prototype, 'contents', {
- get: function() {
- return this._contents;
- },
- set: function(val) {
- if (!isBuffer(val) && !isStream(val) && !isNull(val)) {
- throw new Error("File.contents can only be a Buffer, a Stream, or null.");
- }
- this._contents = val;
- }
- });
- // TODO: should this be moved to vinyl-fs?
- Object.defineProperty(File.prototype, 'relative', {
- get: function() {
- if (!this.base) throw new Error('No base specified! Can not get relative.');
- if (!this.path) throw new Error('No path specified! Can not get relative.');
- return path.relative(this.base, this.path);
- },
- set: function() {
- throw new Error('File.relative is generated from the base and path attributes. Do not modify it.');
- }
- });
- module.exports = File;
|