unjs / jimp-compact

✏️ Lightweight version of Jimp -- An image processing library written entirely in JavaScript for Node.js

✏️ Jimp Compact

Lightweight version of Jimp compiled with vercel/ncc

Why?

This package has 27x smaller install size with all features of original jimp (Jimp install size is ~33.8MB) by bundling all node_modules and removing extra files.

Usage

Install and import/require jimp-compact instead of jimp npm package.

# npm
npm i jimp-compact

# yarn
yarn add jimp-compact

// ESM
import Jimp from 'jimp-compact'

// CJS
const Jimp = require('jimp-compact')

See jimp docs for full usage.

Known Issues

In order to make typescript working, you need to (also) install jimp in devDependencies! Track issue via #39 and #42.

License

MIT - Based on Jimp

jimp-compact's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update all non-major dependencies (@vercel/ncc, jimp, jiti, typescript)
• chore(deps): update devdependency fs-extra to v11 (fs-extra, @types/fs-extra)
• chore(deps): update devdependency typescript to v5
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

circleci

.circleci/config.yml

npm

package.json

• @types/fs-extra ^9.0.13
• @types/jimp ^0.2.28
• @vercel/ncc ^0.34.0
• fs-extra ^10.1.0
• jimp ^0.16.2
• jiti ^1.16.0
• typescript ^4.9.3

---

• Check this box to trigger a request for Renovate to run again on this repository

How to get TS support for this package?

I want to use jimp-compact instead of jimp, but I also want to use the type support provided by @types/jimp. How do I do it?

What good is this package if it is not up-to-date?

Describe the feature

See above

Additional information

• Would you be willing to help implement this feature?

Written file is many times larger than the original?

Hi, I have a problem, namely that the image written by Jimp-compact is many times larger than the original.
Here is my original file, which is slightly larger than 1MB.

The buffer length is also OK so far:

Now, however, as soon as I read in the file using Jimp, very questionable buffer sizes are coming up:

Thus, the written file then has a size of over 7MB, which is pretty much 7x the size of the original:

I am now wondering how this can be, unfortunately the documentation of jimp is not really informative in terms of options and customization of processes, so I hope someone here can help me.

Thanks in advance!

Use github actions for automated release

Missing bundled fonts

// file.js
const {existsSync} = require('fs')
const Jimp = require('jimp');
const JimpCompact = require('jimp-compact');

console.log(existsSync(Jimp.FONT_SANS_16_BLACK))
console.log(existsSync(JimpCompact.FONT_SANS_16_BLACK))

prints

$ node file.js
true
false

specifically, this fails for Jimp.loadFont

benchmark?

This library looks promising and a good alternative to the very heavy jimp; however, will desirable to have some benchmark for comparison to see if the switch is worth for a perf point of view 🙂