jimp-dev/jimp

Documentation! Why none of the examples in plugins-* mention about writing the processed image back to the file-system?

Open

#897 opened on May 28, 2020

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (13,218 stars) (785 forks)batch import
documentationhelp wantedsolution in issue

Description

I stumbled upon this library when I was looking for an image manipulation lib on the server side. When I copy pasted the examples mentioned in plugins-resize, plugins-blur, it just executes! And the original image remains as it is! I was puzzled for a while and I even passed a callback with a console statement which worked fine but the input image just didn't change!

All the code examples in default plugins only shows how to read and how to apply it.

It would save a lot of beginners time if those examples had one more line that saves the output to filesystem: image.write('output.jpg');

Contributor guide

Tech stack
javascriptnodejs
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Examine the example code in the plugins * directories (e.g., plugins resize, plugins blur) within the repository. For each example, after applying the image processing operation, add a line to write the processed image to the filesystem using `image.write('output.jpg')`. Update the corresponding documentation files accordingly. Ensure consistency across all plugins.