Require Node.js 12 and move to ESM

.github/workflows/main.yml

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

example.js

@@ -1,7 +1,6 @@
-'use strict';
-const termImg = require('.');
+import terminalImage from './index.js';
 
-console.log(termImg('fixture.jpg', {
+console.log(terminalImage('fixture.jpg', {
 	width: 50,
 	fallback: () => 'Not supported here, sorry...'
 }));

index.d.ts

@@ -1,48 +1,37 @@
-/// <reference types="node"/>
 import {ImageOptions} from 'ansi-escapes';
 
-declare class UnsupportedTerminalErrorClass extends Error {
+export class UnsupportedTerminalError extends Error {
 	readonly name: 'UnsupportedTerminalError';
 
 	constructor();
 }
 
-declare namespace termImg {
-	interface Options<FallbackType = unknown> extends ImageOptions {
-		/**
-		Enables you to do something else when the terminal doesn't support images.
-
-		@default () => throw new UnsupportedTerminalError()
-		*/
-		readonly fallback?: () => FallbackType;
-	}
+export interface Options<FallbackType = unknown> extends ImageOptions {
+	/**
+	Enables you to do something else when the terminal doesn't support images.
 
-	type UnsupportedTerminalError = UnsupportedTerminalErrorClass;
+	@default () => throw new UnsupportedTerminalError()
+	*/
+	readonly fallback?: () => FallbackType;
 }
 
-declare const termImg: {
-	UnsupportedTerminalError: typeof UnsupportedTerminalErrorClass;
-
-	/**
-	Get the image as a `string` that you can log manually.
-
-	@param image - Filepath to an image or an image as a buffer.
+/**
+Get the image as a `string` that you can log manually.
 
-	@example
-	```
-	import termImg = require('term-img');
+@param image - File path to an image or an image as a buffer.
 
-	function fallback() {
-		// Do something else when not supported
-	}
+@example
+```
+import terminalImage from 'term-img';
 
-	termImg('unicorn.jpg', {fallback});
-	```
-	*/
-	<FallbackType>(
-		image: string | Buffer,
-		options?: termImg.Options<FallbackType>
-	): string | FallbackType;
-};
+function fallback() {
+	// Do something else when not supported
+}
 
-export = termImg;
+terminalImage('unicorn.jpg', {fallback});
+```
+*/
+export default function terminalImage<FallbackType>(
+	image: string | Buffer,
+	options?: Options<FallbackType>
+): string | FallbackType;

index.js

@@ -1,9 +1,8 @@
-'use strict';
-const fs = require('fs');
-const iterm2Version = require('iterm2-version');
-const ansiEscapes = require('ansi-escapes');
+import fs from 'node:fs';
+import iterm2Version from 'iterm2-version';
+import ansiEscapes from 'ansi-escapes';
 
-class UnsupportedTerminalError extends Error {
+export class UnsupportedTerminalError extends Error {
 	constructor() {
 		super('iTerm >=3 required');
 		this.name = 'UnsupportedTerminalError';
@@ -14,7 +13,7 @@ function unsupported() {
 	throw new UnsupportedTerminalError();
 }
 
-module.exports = (image, options = {}) => {
+export default function terminalImage(image, options = {}) {
 	const fallback = typeof options.fallback === 'function' ? options.fallback : unsupported;
 
 	if (!(image && image.length > 0)) {
@@ -36,6 +35,4 @@ module.exports = (image, options = {}) => {
 	}
 
 	return ansiEscapes.image(image, options);
-};
-
-module.exports.UnsupportedTerminalError = UnsupportedTerminalError;
+}

index.test-d.ts

@@ -1,12 +1,11 @@
 import {expectType} from 'tsd';
-import termImg = require('.');
-import {UnsupportedTerminalError} from '.';
+import terminalImage, {UnsupportedTerminalError} from './index.js';
 
-expectType<string>(termImg('/foo/bar.jpg'));
-expectType<string>(termImg(Buffer.alloc(1)));
-expectType<string>(termImg('/foo/bar.jpg', {width: 1}));
+expectType<string>(terminalImage('/foo/bar.jpg'));
+expectType<string>(terminalImage(Buffer.alloc(1)));
+expectType<string>(terminalImage('/foo/bar.jpg', {width: 1}));
 expectType<string | false>(
-	termImg('/foo/bar.jpg', {fallback: () => false})
+	terminalImage('/foo/bar.jpg', {fallback: () => false})
 );
 
 const unsupportedTerminalError = new UnsupportedTerminalError();

package.json

@@ -10,8 +10,10 @@
 		"email": "sindresorhus@gmail.com",
 		"url": "https://sindresorhus.com"
 	},
+	"type": "module",
+	"exports": "./index.js",
 	"engines": {
-		"node": ">=10"
+		"node": ">=12"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -43,13 +45,13 @@
 		"jpeg"
 	],
 	"dependencies": {
-		"ansi-escapes": "^4.1.0",
-		"iterm2-version": "^4.1.0"
+		"ansi-escapes": "^5.0.0",
+		"iterm2-version": "^5.0.0"
 	},
 	"devDependencies": {
-		"@types/node": "^14.0.4",
-		"ava": "^2.0.0",
-		"tsd": "^0.11.0",
-		"xo": "^0.30.0"
+		"@types/node": "^15.0.1",
+		"ava": "^3.15.0",
+		"tsd": "^0.14.0",
+		"xo": "^0.39.1"
 	}
 }

readme.md

@@ -19,26 +19,26 @@ $ npm install term-img
 ## Usage
 
 ```js
-const termImg = require('term-img');
+import terminalImage from 'term-img';
 
 function fallback() {
 	// Return something else when not supported
 }
 
-console.log(termImg('unicorn.jpg', {fallback}));
+console.log(terminalImage('unicorn.jpg', {fallback}));
 ```
 
 ## API
 
-### termImg(image, options?)
+### terminalImage(image, options?)
 
 Get the image as a `string` that you can log manually.
 
 #### image
 
 Type: `string | Buffer`
 
-Filepath to an image or an image as a buffer.
+File path to an image or an image as a buffer.
 
 #### options
 

test.js

@@ -1,8 +1,8 @@
 import test from 'ava';
-import termImg from '.';
+import terminalImage from './index.js';
 
 test('main', t => {
 	process.env.TERM_PROGRAM = 'iTerm.app';
 	process.env.TERM_PROGRAM_VERSION = '3.3.7';
-	t.snapshot(termImg('fixture.jpg'));
+	t.snapshot(terminalImage('fixture.jpg'));
 });