Require Node.js 18

Author: sindresorhus

.github/workflows/main.yml

@@ -10,12 +10,12 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
-          - 16
-          - 14
-          - 12
+          - 22
+          - 20
+          - 18
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install

example.js

@@ -1,5 +1,3 @@
 import terminalImage from './index.js';
 
-(async () => {
-	console.log(await terminalImage.file('fixture.jpg'));
-})();
+console.log(await terminalImage.file('fixture.jpg'));

index.d.ts

@@ -47,7 +47,7 @@ declare const terminalImage: {
 	console.log(await terminalImage.buffer(body, {width: 70, height: 50, preserveAspectRatio: false}));
 	```
 	*/
-	buffer: (imageBuffer: Readonly<Buffer>, options?: Readonly<{
+	buffer: (imageBuffer: Readonly<Uint8Array>, options?: Readonly<{
 		width?: string | number;
 		height?: string | number;
 		preserveAspectRatio?: boolean;
@@ -124,7 +124,7 @@ declare const terminalImage: {
 	stopAnimation();
 	```
 	*/
-	gifBuffer: (imageBuffer: Readonly<Buffer>, options?: Readonly<{
+	gifBuffer: (imageBuffer: Readonly<Uint8Array>, options?: Readonly<{
 		width?: string | number;
 		height?: string | number;
 		maximumFrameRate?: number;

index.js

@@ -1,9 +1,12 @@
-import fs, {promises as fsPromises} from 'node:fs';
+import process from 'node:process';
+import fs from 'node:fs';
+import fsPromises from 'node:fs/promises';
 import chalk from 'chalk';
 import Jimp from 'jimp';
 import termImg from 'term-img';
 import renderGif from 'render-gif';
 import logUpdate from 'log-update';
+import {imageDimensionsFromData} from 'image-dimensions';
 
 // `log-update` adds an extra newline so the generated frames need to be 2 pixels shorter.
 const ROW_OFFSET = 2;
@@ -68,7 +71,7 @@ function calculateWidthHeight(imageWidth, imageHeight, inputWidth, inputHeight,
 }
 
 async function render(buffer, {width: inputWidth, height: inputHeight, preserveAspectRatio}) {
-	const image = await Jimp.read(buffer);
+	const image = await Jimp.read(Buffer.from(buffer));
 	const {bitmap} = image;
 
 	const {width, height} = calculateWidthHeight(bitmap.width, bitmap.height, inputWidth, inputHeight, preserveAspectRatio);
@@ -91,13 +94,11 @@ async function render(buffer, {width: inputWidth, height: inputHeight, preserveA
 
 const terminalImage = {};
 
-terminalImage.buffer = async (buffer, {width = '100%', height = '100%', preserveAspectRatio = true} = {}) => {
-	return termImg(buffer, {
-		width,
-		height,
-		fallback: () => render(buffer, {height, width, preserveAspectRatio})
-	});
-};
+terminalImage.buffer = async (buffer, {width = '100%', height = '100%', preserveAspectRatio = true} = {}) => termImg(buffer, {
+	width,
+	height,
+	fallback: () => render(buffer, {height, width, preserveAspectRatio}),
+});
 
 terminalImage.file = async (filePath, options = {}) =>
 	terminalImage.buffer(await fsPromises.readFile(filePath), options);
@@ -106,19 +107,22 @@ terminalImage.gifBuffer = (buffer, options = {}) => {
 	options = {
 		renderFrame: logUpdate,
 		maximumFrameRate: 30,
-		...options
+		...options,
 	};
 
 	const finalize = () => {
-		if (options.renderFrame.done) {
-			options.renderFrame.done();
-		}
+		options.renderFrame.done?.();
 	};
 
+	const dimensions = imageDimensionsFromData(buffer);
+	if (dimensions?.width < 2 || dimensions?.width < 2) {
+		throw new Error('The image is too small to be rendered.');
+	}
+
 	const result = termImg(buffer, {
 		width: options.width,
 		height: options.height,
-		fallback: () => false
+		fallback: () => false,
 	});
 
 	if (result) {
@@ -127,7 +131,7 @@ terminalImage.gifBuffer = (buffer, options = {}) => {
 	}
 
 	const animation = renderGif(buffer, async frameData => {
-		options.renderFrame(await terminalImage.buffer(Buffer.from(frameData), options));
+		options.renderFrame(await terminalImage.buffer(frameData, options));
 	}, options);
 
 	return () => {

package.json

@@ -11,9 +11,13 @@
 		"url": "https://sindresorhus.com"
 	},
 	"type": "module",
-	"exports": "./index.js",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
+	"sideEffects": false,
 	"engines": {
-		"node": ">=12"
+		"node": ">=18"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -46,16 +50,17 @@
 		"sequence"
 	],
 	"dependencies": {
-		"chalk": "^4.1.1",
-		"jimp": "^0.16.1",
-		"log-update": "^4.0.0",
+		"chalk": "^5.3.0",
+		"image-dimensions": "^2.3.0",
+		"jimp": "^0.22.12",
+		"log-update": "^6.1.0",
 		"render-gif": "^2.0.4",
-		"term-img": "^6.0.0"
+		"term-img": "^7.0.0"
 	},
 	"devDependencies": {
-		"@types/node": "^15.0.1",
-		"ava": "^3.15.0",
-		"tsd": "^0.14.0",
-		"xo": "^0.39.1"
+		"@types/node": "^20.14.12",
+		"ava": "^6.1.3",
+		"tsd": "^0.31.1",
+		"xo": "^0.59.2"
 	}
 }

readme.md

@@ -10,8 +10,8 @@ Works in any terminal that supports colors.
 
 ## Install
 
-```
-$ npm install terminal-image
+```sh
+npm install terminal-image
 ```
 
 ## Usage

test.js

@@ -16,9 +16,9 @@ test('.file()', async t => {
 test('.gifBuffer()', async t => {
 	let result = '';
 	const stopAnimation = terminalImage.gifBuffer(fs.readFileSync('fixture.gif'), {
-		renderFrame: text => {
+		renderFrame(text) {
 			result += text;
-		}
+		},
 	});
 	await delay(500);
 	stopAnimation();
@@ -28,9 +28,9 @@ test('.gifBuffer()', async t => {
 test('.gifFile()', async t => {
 	let result = '';
 	const stopAnimation = terminalImage.gifFile('fixture.gif', {
-		renderFrame: text => {
+		renderFrame(text) {
 			result += text;
-		}
+		},
 	});
 	await delay(500);
 	stopAnimation();