chore: improve jsdoc types and match most files (#2108)

Author: SethFalco

lib/svgo-node.js

@@ -1,5 +1,5 @@
 import os from 'os';
-import fs from 'fs';
+import fs from 'fs/promises';
 import path from 'path';
 import {
   VERSION,
@@ -35,7 +35,7 @@ const importConfig = async (configFile) => {
  */
 const isFile = async (file) => {
   try {
-    const stats = await fs.promises.stat(file);
+    const stats = await fs.stat(file);
     return stats.isFile();
   } catch {
     return false;

package.json

@@ -115,7 +115,7 @@
     "sax": "^1.4.1"
   },
   "devDependencies": {
-    "@eslint/js": "^9.3.0",
+    "@eslint/js": "^9.25.1",
     "@jest/globals": "^29.7.0",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-node-resolve": "^15.2.3",
@@ -125,8 +125,9 @@
     "@types/jest": "^29.5.12",
     "@types/node": "^20.12.11",
     "@types/sax": "^1.2.7",
+    "@types/tar-stream": "^3.1.3",
     "cross-env": "^7.0.3",
-    "eslint": "^9.3.0",
+    "eslint": "^9.25.1",
     "globals": "^14.0.0",
     "jest": "^29.7.0",
     "pixelmatch": "^7.1.0",

rollup.config.js

@@ -41,7 +41,13 @@ export default [
       format: 'cjs',
       exports: 'named',
     },
-    external: ['os', 'fs', 'url', 'path', ...Object.keys(PKG.dependencies)],
+    external: [
+      'os',
+      'fs/promises',
+      'url',
+      'path',
+      ...Object.keys(PKG.dependencies),
+    ],
     onwarn(warning) {
       throw Error(warning.toString());
     },

test/coa/_index.test.js

@@ -13,15 +13,18 @@ const svgFiles = [
   path.resolve(__dirname, 'testSvg/test.1.svg'),
 ];
 const tempFolder = 'temp';
-const noop = () => {};
 
+/**
+ * @param {string[]} args
+ * @returns {Promise<Command>}
+ */
 function runProgram(args) {
   const program = new Command();
   svgo(program);
   // prevent running process.exit
   program.exitOverride(() => {});
   // parser skips first two arguments
-  return program.parseAsync([0, 1, ...args]);
+  return program.parseAsync(['', '', ...args]);
 }
 
 describe('coa', function () {
@@ -34,18 +37,10 @@ describe('coa', function () {
     await fs.promises.rm(tempFolder, { force: true, recursive: true });
   });
 
-  const initialConsoleError = global.console.error;
-  const initialProcessExit = global.process.exit;
-
-  function replaceConsoleError() {
-    global.process.exit = noop;
-  }
-
-  function restoreConsoleError() {
-    global.console.error = initialConsoleError;
-    global.process.exit = initialProcessExit;
-  }
-
+  /**
+   * @param {string} folderPath
+   * @returns {number}
+   */
   function calcFolderSvgWeight(folderPath) {
     return fs
       .readdirSync(folderPath)
@@ -120,14 +115,9 @@ describe('coa', function () {
   });
 
   it('should throw error when stated in input folder does not exist', async () => {
-    replaceConsoleError();
-    try {
-      await expect(
-        runProgram(['--input', svgFolderPath + 'temp', '--output', tempFolder]),
-      ).rejects.toThrow(/no such file or directory/);
-    } finally {
-      restoreConsoleError();
-    }
+    await expect(
+      runProgram(['--input', svgFolderPath + 'temp', '--output', tempFolder]),
+    ).rejects.toThrow(/no such file or directory/);
   });
 
   describe('stdout', () => {

test/fixtures/config-loader/invalid-runtime.js

@@ -1,2 +1,3 @@
 /* eslint-disable no-undef */
+// @ts-expect-error Testing malformed configuration.
 export default { plugins };

test/fixtures/config-loader/invalid-runtime.mjs

@@ -1 +1,3 @@
-export default { plugins }; // eslint-disable-line no-undef
+/* eslint-disable no-undef */
+// @ts-expect-error Testing malformed configuration.
+export default { plugins };

test/plugins/_index.test.js

@@ -1,32 +1,39 @@
-import FS from 'fs';
-import PATH from 'path';
+import fs from 'fs/promises';
+import path from 'path';
 import { EOL } from 'os';
 import { fileURLToPath } from 'url';
 import { optimize } from '../../lib/svgo.js';
 
-const regEOL = new RegExp(EOL, 'g');
+/**
+ * @typedef {import('../../lib/svgo.js').PluginConfig} PluginConfig
+ * @typedef {import('../../lib/svgo.js').CustomPlugin} CustomPlugin
+ */
+
 const regFilename = /^(.*)\.(\d+)\.svg\.txt$/;
-const __dirname = PATH.dirname(fileURLToPath(import.meta.url));
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const files = await fs.readdir(__dirname);
 
 describe('plugins tests', function () {
-  FS.readdirSync(__dirname).forEach(function (file) {
-    var match = file.match(regFilename),
-      index,
-      name;
+  for (let file of files) {
+    const match = file.match(regFilename);
+    let index;
+    /** @type {any} */
+    let name;
 
     if (match) {
       name = match[1];
       index = match[2];
 
-      file = PATH.resolve(__dirname, file);
+      file = path.resolve(__dirname, file);
 
-      it(name + '.' + index, function () {
+      it(name + '.' + index, () => {
         return readFile(file).then(function (data) {
           // remove description
           const items = normalize(data).split(/\s*===\s*/);
           const test = items.length === 2 ? items[1] : items[0];
           // extract test case
           const [original, should, params] = test.split(/\s*@@@\s*/);
+          /** @type {Exclude<PluginConfig, CustomPlugin>} */
           const plugin = {
             name,
             params: params ? JSON.parse(params) : {},
@@ -48,18 +55,21 @@ describe('plugins tests', function () {
         });
       });
     }
-  });
+  }
 });
 
+/**
+ * @param {string} file
+ * @returns {string}
+ */
 function normalize(file) {
-  return file.trim().replace(regEOL, '\n');
+  return file.trim().replaceAll(EOL, '\n');
 }
 
+/**
+ * @param {string} file
+ * @returns {Promise<string>}
+ */
 function readFile(file) {
-  return new Promise(function (resolve, reject) {
-    FS.readFile(file, 'utf8', function (err, data) {
-      if (err) return reject(err);
-      resolve(data);
-    });
-  });
+  return fs.readFile(file, 'utf-8');
 }

test/plugins/_transforms.test.js

@@ -1,7 +1,7 @@
 import { matrixToTransform } from '../../plugins/_transforms.js';
 
 /**
- * @typedef {import('../../plugins/_transforms').TransformParams} TransformParams
+ * @typedef {import('../../plugins/_transforms.js').TransformParams} TransformParams
  */
 
 /** @type {TransformParams} */

test/regression-extract.js

@@ -200,8 +200,13 @@ const extractTarGz = async (url, baseDir) => {
     stream.resume();
     next();
   });
-  const response = await fetch(url);
-  await pipeline(response.body, zlib.createGunzip(), extract);
+  const { body } = await fetch(url);
+
+  if (!body) {
+    throw Error('No body returned when fetching SVGO Test Suite.');
+  }
+
+  await pipeline(body, zlib.createGunzip(), extract);
 };
 
 (async () => {

test/svg2js/_index.test.js

@@ -1,17 +1,18 @@
-import FS from 'fs';
-import PATH from 'path';
+import fs from 'fs';
+import path from 'path';
 import { fileURLToPath } from 'url';
 import { parseSvg } from '../../lib/parser.js';
 
-const __dirname = PATH.dirname(fileURLToPath(import.meta.url));
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
-describe('svg2js', function () {
-  describe('working svg', function () {
-    var filepath = PATH.resolve(__dirname, './test.svg'),
-      root;
+describe('svg2js', () => {
+  describe('working svg', () => {
+    const filepath = path.resolve(__dirname, './test.svg');
+    /** @type {any} */
+    let root;
 
-    beforeAll(function (done) {
-      FS.readFile(filepath, 'utf8', function (err, data) {
+    beforeAll((done) => {
+      fs.readFile(filepath, 'utf8', (err, data) => {
         if (err) {
           throw err;
         }
@@ -21,26 +22,26 @@ describe('svg2js', function () {
       });
     });
 
-    describe('root', function () {
-      it('should exist', function () {
+    describe('root', () => {
+      it('should exist', () => {
         expect(root).toStrictEqual(expect.anything());
       });
 
-      it('should be an instance of Object', function () {
+      it('should be an instance of Object', () => {
         expect(root).toBeInstanceOf(Object);
       });
 
-      it('should have property "children"', function () {
+      it('should have property "children"', () => {
         expect(root).toHaveProperty('children');
       });
     });
 
-    describe('root.children', function () {
-      it('should be an instance of Array', function () {
+    describe('root.children', () => {
+      it('should be an instance of Array', () => {
         expect(root.children).toBeInstanceOf(Array);
       });
 
-      it('should have length 4', function () {
+      it('should have length 4', () => {
         expect(root.children).toHaveLength(4);
       });
     });
@@ -72,7 +73,7 @@ describe('svg2js', function () {
       });
     });
 
-    describe('name', function () {
+    describe('name', () => {
       it('should have property name: "svg"', function () {
         expect(root.children[3]).toStrictEqual(
           expect.objectContaining({
@@ -82,22 +83,22 @@ describe('svg2js', function () {
       });
     });
 
-    describe('children', function () {
-      it('should exist', function () {
+    describe('children', () => {
+      it('should exist', () => {
         expect(root.children[3].children).toStrictEqual(expect.anything());
       });
 
-      it('should be an instance of Array', function () {
+      it('should be an instance of Array', () => {
         expect(root.children[3].children).toBeInstanceOf(Array);
       });
 
-      it('should eventually have length 3', function () {
+      it('should eventually have length 3', () => {
         expect(root.children[3].children).toHaveLength(3);
       });
     });
 
-    describe('text nodes', function () {
-      it('should contain preserved whitespace', function () {
+    describe('text nodes', () => {
+      it('should contain preserved whitespace', () => {
         const textNode = root.children[3].children[1].children[0].children[1];
         expect(textNode.children[0].value).toBe('  test  ');
       });