Issues with libraries using an outdated vinyl version

I don’t really know if it belongs here, but I’m getting errors when upgrading to vinyl-fs version 3.x.

Several libraries (the ones are found are gulp-watch and vinyl-source-stream) are using an outdated vinyl version, which causes errors using vfs.dest.

See

https://github.com/floatdrop/gulp-watch/issues/295 https://github.com/hughsk/vinyl-source-stream/issues/23

For now I’ve solved it internally by wrapping the outdated vinyl object in a new one:

import through = require('through2');
import File = require('vinyl');

/**
 * gulp-watch/vinyl-source-stream uses an outdated vinyl, which doesn't have some functions which vinyl-fs expects.
 * Can be removed when gulp-watch updates it to vinyl 2.x.
 * @returns {NodeJS.ReadWriteStream}
 */
export function upgrade(): NodeJS.ReadWriteStream {
  return through.obj(function(file: any, encoding: string, cb: through.TransformCallback): void {
    const upgradedFile = new File(file);
    cb(null, upgradedFile);
  });
}

[carlosvillademor]

Thanks @erikkemperman, upgrading to vinyl-source-stream to 2.0.0 has fixed the issue.

[phated]

I want to note that you must have vinyl-buffer version 1.0.1 when upgrading to vinyl-source-stream 2.0.0 because it required a patch to make everything work. (It looks like @carlosvillademor already had that version).

So it looks like the situation here is that we can now wrap most old vinyls but not all of them (or rather we refuse because we don’t get past the isVinyl() test in dest/prepare). Is it intentional to refuse vinyls < 0.5.3 in this way?

@erikkemperman yes, it was intentional because those versions are missing critical parts to the ecosystem. Vinyl 0.5.3 came with gulp-util, so that’s what most people would be using. I might have been able to slip a 0.4.6 -> 0.5.3 change into vinyl-source-stream but I want people to upgrade to 2.0.0 so I don’t really care to do that now.