derhuerst/gulp-scale-images

Gulp v5 needs encoding: false

Open

#35 opened on Jun 11, 2024

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (5 forks)github user discovery
docshelp wanted

Repository metrics

Stars
 (13 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Updating to gulp v5 all my worflows with gulp-scale-images were broken: "Error: Input buffer contains unsupported image format"

There was only one result in google for this error, but this pointed towards a problem with svgs and sharp.

Gulp v5 changed the default encoding of all of their streams to UTF-8. gulp-scale-images does not seem aware of this and expects a binary stream?

What you have to do is set encoding to false on your streams.

return gulp
  // Load file
  .src(data.source, {encoding: false})
  
  // We want to have multiple sizes per source image
  .pipe(flatMap.default(variantsPerFile))
  
  // Scale the images
  .pipe(scaleImages(computeFileName))
  
  // Write result file
  .pipe(gulp.dest(application.destinationPath + '/' + key));

With this change my workflow are once again working correctly.

Can you either add this to the README or somehow fix this in code?

Contributor guide

Research direction
Add the `encoding: false` option to the `gulp.src` call in the plugin to fix compatibility with Gulp v5.
Tech stack
javascriptnodejs
Domain
build system
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptNode.jsGulp
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70