Skip to content

Commit 0343114

Browse files
sindresorhussindresorhus
committed
Require Node.js 18 and move to ESM
Fixes #35 Fixes #41
1 parent fe9ae08 commit 0343114

File tree

9 files changed

+150
-192
lines changed

9 files changed

+150
-192
lines changed

‎.editorconfig‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ charset = utf-8
77
trim_trailing_whitespace = true
88
insert_final_newline = true
99

10-
[*.{json,yml}]
11-
indent_size = 2
10+
[*.yml]
1211
indent_style = space
12+
indent_size = 2

‎.gitattributes‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
* text=auto
2-
*.js text eol=lf
1+
* text=auto eol=lf

‎.github/workflows/main.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: CI
2+
on:
3+
- push
4+
- pull_request
5+
jobs:
6+
test:
7+
name: Node.js ${{ matrix.node-version }}
8+
runs-on: ubuntu-latest
9+
strategy:
10+
fail-fast: false
11+
matrix:
12+
node-version:
13+
- 22
14+
- 20
15+
- 18
16+
steps:
17+
- uses: actions/checkout@v4
18+
- uses: actions/setup-node@v4
19+
with:
20+
node-version: ${{ matrix.node-version }}
21+
- run: npm install
22+
- run: npm test

‎.github/workflows/test.yml‎

Lines changed: 0 additions & 64 deletions
This file was deleted.

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
node_modules
2+
yarn.lock

‎index.js‎

Lines changed: 55 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,55 @@
1-
'use strict';
2-
const execBuffer = require('exec-buffer');
3-
const isJpg = require('is-jpg');
4-
const jpegtran = require('jpegtran-bin');
5-
6-
module.exports = options => buf => {
7-
options = {...options};
8-
9-
if (!Buffer.isBuffer(buf)) {
10-
return Promise.reject(new TypeError('Expected a buffer'));
11-
}
12-
13-
if (!isJpg(buf)) {
14-
return Promise.resolve(buf);
15-
}
16-
17-
const args = ['-copy', 'none'];
18-
19-
if (options.progressive) {
20-
args.push('-progressive');
21-
}
22-
23-
if (options.arithmetic) {
24-
args.push('-arithmetic');
25-
} else {
26-
args.push('-optimize');
27-
}
28-
29-
args.push('-outfile', execBuffer.output, execBuffer.input);
30-
31-
return execBuffer({
32-
input: buf,
33-
bin: jpegtran,
34-
args
35-
}).catch(error => {
36-
error.message = error.stderr || error.message;
37-
throw error;
38-
});
39-
};
1+
import fs from 'node:fs/promises';
2+
import {randomUUID} from 'node:crypto';
3+
import {tmpdir} from 'node:os';
4+
import path from 'node:path';
5+
import {execa} from 'execa';
6+
import jpegtran from 'jpegtran-bin';
7+
import {fileTypeFromBuffer} from 'file-type';
8+
import {imageDimensionsFromData} from 'image-dimensions';
9+
import {assertUint8Array} from 'uint8array-extras';
10+
11+
export default function imageminJpegtran(options = {}) {
12+
return async function (data) {
13+
assertUint8Array(data);
14+
15+
const fileType = await fileTypeFromBuffer(data);
16+
if (!fileType || fileType.mime !== 'image/jpeg') {
17+
return data;
18+
}
19+
20+
const dimensions = imageDimensionsFromData(data);
21+
if (dimensions?.width === 0 && dimensions?.height === 0) {
22+
return data;
23+
}
24+
25+
const arguments_ = ['-copy', 'none'];
26+
27+
if (options.progressive) {
28+
arguments_.push('-progressive');
29+
}
30+
31+
if (options.arithmetic) {
32+
arguments_.push('-arithmetic');
33+
} else {
34+
arguments_.push('-optimize');
35+
}
36+
37+
const inputPath = path.join(tmpdir(), `input-${randomUUID()}.jpg`);
38+
const outputPath = path.join(tmpdir(), `output-${randomUUID()}.jpg`);
39+
40+
arguments_.push('-outfile', outputPath, inputPath);
41+
42+
await fs.writeFile(inputPath, data);
43+
44+
try {
45+
await execa(jpegtran, arguments_);
46+
return await fs.readFile(outputPath);
47+
} finally {
48+
// Clean up temporary files
49+
await Promise.all([
50+
fs.unlink(inputPath).catch(() => {}),
51+
fs.unlink(outputPath).catch(() => {}),
52+
]);
53+
}
54+
};
55+
}

‎license‎

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,9 @@
1-
The MIT License (MIT)
1+
MIT License
22

33
Copyright (c) imagemin
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
116

12-
The above copyright notice and this permission notice shall be included in
13-
all copies or substantial portions of the Software.
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
148

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21-
THE SOFTWARE.
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎package.json‎

Lines changed: 44 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,46 @@
11
{
2-
"name": "imagemin-jpegtran",
3-
"version": "7.0.0",
4-
"description": "jpegtran imagemin plugin",
5-
"license": "MIT",
6-
"repository": "imagemin/imagemin-jpegtran",
7-
"author": {
8-
"name": "Kevin Mårtensson",
9-
"email": "[email protected]",
10-
"url": "github.com/kevva"
11-
},
12-
"maintainers": [
13-
{
14-
"name": "Sindre Sorhus",
15-
"email": "[email protected]",
16-
"url": "sindresorhus.com"
17-
},
18-
{
19-
"name": "Shinnosuke Watanabe",
20-
"url": "github.com/shinnn"
21-
}
22-
],
23-
"engines": {
24-
"node": ">=10"
25-
},
26-
"scripts": {
27-
"test": "xo && ava"
28-
},
29-
"files": [
30-
"index.js"
31-
],
32-
"keywords": [
33-
"compress",
34-
"image",
35-
"imageminplugin",
36-
"img",
37-
"jpeg",
38-
"jpegtran",
39-
"jpg",
40-
"minify",
41-
"optimize"
42-
],
43-
"dependencies": {
44-
"exec-buffer": "^3.0.0",
45-
"is-jpg": "^2.0.0",
46-
"jpegtran-bin": "^5.0.0"
47-
},
48-
"devDependencies": {
49-
"ava": "^3.8.0",
50-
"is-progressive": "^3.0.0",
51-
"xo": "^0.30.0"
52-
}
2+
"name": "imagemin-jpegtran",
3+
"version": "7.0.0",
4+
"description": "jpegtran imagemin plugin",
5+
"license": "MIT",
6+
"repository": "imagemin/imagemin-jpegtran",
7+
"type": "module",
8+
"exports": {
9+
"types": "./index.d.ts",
10+
"default": "./index.js"
11+
},
12+
"sideEffects": false,
13+
"engines": {
14+
"node": ">=18"
15+
},
16+
"scripts": {
17+
"test": "xo && ava"
18+
},
19+
"files": [
20+
"index.js"
21+
],
22+
"keywords": [
23+
"compress",
24+
"image",
25+
"imageminplugin",
26+
"img",
27+
"jpeg",
28+
"jpegtran",
29+
"jpg",
30+
"minify",
31+
"optimize"
32+
],
33+
"dependencies": {
34+
"execa": "^9.4.0",
35+
"file-type": "^19.5.0",
36+
"image-dimensions": "^2.3.0",
37+
"jpegtran-bin": "^7.0.0",
38+
"uint8array-extras": "^1.4.0"
39+
},
40+
"devDependencies": {
41+
"ava": "^6.1.3",
42+
"is-jpg": "^3.0.0",
43+
"is-progressive": "^5.0.1",
44+
"xo": "^0.59.3"
45+
}
5346
}

‎test.js‎

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,32 @@
1-
const {promisify} = require('util');
2-
const fs = require('fs');
3-
const path = require('path');
4-
const isJpg = require('is-jpg');
5-
const isProgressive = require('is-progressive');
6-
const test = require('ava');
7-
const m = require('.');
1+
import fs from 'node:fs/promises';
2+
import path from 'node:path';
3+
import {fileURLToPath} from 'node:url';
4+
import isJpg from 'is-jpg';
5+
import isProgressive from 'is-progressive';
6+
import test from 'ava';
7+
import imageminJpegtran from './index.js';
88

9-
const readFile = promisify(fs.readFile);
9+
const __dirname = fileURLToPath(new URL('.', import.meta.url));
1010

1111
test('optimize a JPG', async t => {
12-
const buf = await readFile(path.join(__dirname, 'fixture.jpg'));
13-
const data = await m()(buf);
14-
t.true(data.length < buf.length);
15-
t.true(isJpg(data));
12+
const data = await fs.readFile(path.join(__dirname, 'fixture.jpg'));
13+
const resultData = await imageminJpegtran()(data);
14+
t.true(resultData.length < data.length);
15+
t.true(isJpg(resultData));
1616
});
1717

1818
test('throw error when a JPG is corrupt', async t => {
19-
const buf = await readFile(path.join(__dirname, 'fixture-corrupt.jpg'));
19+
const data = await fs.readFile(path.join(__dirname, 'fixture-corrupt.jpg'));
20+
2021
await t.throwsAsync(async () => {
21-
await m()(buf);
22-
}, {message: /Corrupt JPEG data/});
22+
await imageminJpegtran()(data);
23+
}, {
24+
message: /Corrupt JPEG data/,
25+
});
2326
});
2427

2528
test('progressive option', async t => {
26-
const buf = await readFile(path.join(__dirname, 'fixture.jpg'));
27-
const data = await m({progressive: true})(buf);
28-
t.true(isProgressive.buffer(data));
29+
const data = await fs.readFile(path.join(__dirname, 'fixture.jpg'));
30+
const resultData = await imageminJpegtran({progressive: true})(data);
31+
t.true(isProgressive.buffer(resultData));
2932
});

0 commit comments

Comments
 (0)