perf: remove the dependency on imagemin

BREAKING CHANGE: the dependency on imagemin is changed to be imported from outside

Author: iChengbo

package.json

@@ -32,20 +32,11 @@
     "url": "https://github.com/iChengbo/react-native-imagemin-asset-plugin/issues"
   },
   "homepage": "https://github.com/iChengbo/react-native-imagemin-asset-plugin#readme",
-  "dependencies": {
-    "imagemin": "^7.0.1"
-  },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@types/imagemin": "^8.0.1",
-    "@types/imagemin-gifsicle": "^7.0.4",
-    "@types/imagemin-jpegtran": "^5.0.2",
-    "@types/imagemin-mozjpeg": "^8.0.2",
-    "@types/imagemin-optipng": "^5.2.2",
-    "@types/imagemin-pngquant": "^8.0.0",
-    "@types/imagemin-svgo": "^10.0.5",
-    "@types/imagemin-webp": "^7.0.1",
+    "imagemin": "^7.0.1",
     "imagemin-gifsicle": "^7.0.0",
     "imagemin-jpegtran": "^7.0.0",
     "imagemin-mozjpeg": "^9.0.0",
@@ -55,7 +46,7 @@
     "imagemin-webp": "^6.1.0",
     "metro": "^0.80.2",
     "rimraf": "^5.0.5",
-    "semantic-release": "^22.0.5",
-    "typescript": "^5.2.2"
+    "semantic-release": "^22.0.12",
+    "typescript": "^5.3.3"
   }
 }

src/index.ts

@@ -1,11 +1,10 @@
 import path from 'path';
 
 import type { AssetData } from 'metro';
-import imagemin from 'imagemin';
 
 import type { IConfig, ImageminMinimizer } from './config';
 import { buildConfig } from './config';
-import { generateGitignoreFile, imageminNormalizeConfig } from './utils';
+import { generateGitignoreFile, imageminGenerate } from './utils';
 
 let _config: IConfig
 
@@ -32,23 +31,14 @@ const _imageminAssetPlugin = async (assetData: AssetData): Promise<AssetData> =>
     const excludeRegexp = new RegExp(exclude)
 
     if (!excludeRegexp.test(assetData.fileSystemLocation)) {
-      const outputDirectory = path.join(process.cwd(), cacheDir);
+      const outputDirPath = path.join(process.cwd(), cacheDir);
 
       if (test.test(assetData.files[0])) {
         const { implementation = 'imagemin', options = [] } = minimizer ?? {}
 
         if (implementation === 'imagemin') {
-          // TODO: refactor and remove it to utils.ts
-          const plugins = await imageminNormalizeConfig(options as ImageminMinimizer['options'])
-          const tmpFiles = await imagemin(assetData.files, {
-            destination: outputDirectory,
-            plugins,
-          });
-          const outFiles = tmpFiles.map(file => file.destinationPath);
-          return {
-            ...assetData,
-            files: outFiles,
-          };
+          const _assetData = await imageminGenerate(assetData, outputDirPath, options as ImageminMinimizer['options']);
+          return _assetData
         }
         // TODO: handle sharp implementation
       }

src/utils.ts

@@ -1,6 +1,7 @@
 import path from 'path';
 import fs from 'fs/promises';
 import type { Plugin } from 'imagemin';
+import { AssetData } from 'metro';
 
 import { ImageminMinimizer } from './config';
 
@@ -19,6 +20,36 @@ export const generateGitignoreFile = async (dir: string) => {
   }
 }
 
+/**
+ * Runs imagemin on the given asset data and generates optimized image files.
+ * 
+ * @param assetData - The asset data containing the files to be optimized.
+ * @param outputDirPath - The output directory path where the optimized files will be saved.
+ * @param minimizerOptions - The options for the imagemin minimizer.
+ * @returns The modified asset data with the optimized files.
+ */
+export const imageminGenerate = async (assetData: AssetData, outputDirPath: string, minimizerOptions: ImageminMinimizer['options']) => {
+  const plugins = await imageminNormalizeConfig(minimizerOptions || {});
+
+  let outFiles = assetData.files;
+  try {
+    const imagemin = (await import("imagemin")).default;
+    const tmpFiles = await imagemin(assetData.files, {
+      destination: outputDirPath,
+      plugins,
+    });
+    outFiles = tmpFiles.map(file => file.destinationPath);
+  } catch (error) {
+    // FIXME: Error [ERR_REQUIRE_ESM]: require() of ES Module ...
+    logError(error)
+  }
+
+  return {
+    ...assetData,
+    files: outFiles
+  }
+}
+
 /**
  * Normalize the imagemin configuration by importing the required plugins and their options.
  * @param imageminConfig - The imagemin configuration.
@@ -45,27 +76,15 @@ export const imageminNormalizeConfig = async (imageminConfig: ImageminMinimizer[
       const pluginOptions = isPluginArray ? plugin[1] : undefined;
 
       let requiredPlugin = null;
-      let requiredPluginName = `imagemin-${pluginName}`;
+      let requiredPluginName = pluginName.startsWith('imagemin-') ? pluginName : `imagemin-${pluginName}`;
 
       try {
         requiredPlugin = (await import(requiredPluginName)).default(
           pluginOptions
         );
       } catch {
-        requiredPluginName = pluginName;
-
-        try {
-          requiredPlugin = (await import(requiredPluginName)).default(
-            pluginOptions
-          );
-        } catch {
-          const pluginNameForError = pluginName.startsWith("imagemin")
-            ? pluginName
-            : `imagemin-${pluginName}`;
-
-          const message = `Unknown plugin: ${pluginNameForError}\n\nDid you forget to install the plugin?\nYou can install it with:\n\n$ npm install ${pluginNameForError} --save-dev\n$ yarn add ${pluginNameForError} --dev`
-          logError(message)
-        }
+        const message = `Unknown plugin: ${requiredPluginName}\n\nDid you forget to install the plugin?\nYou can install it with:\n\n$ npm install ${requiredPluginName} --save-dev\n$ yarn add ${requiredPluginName} --dev`
+        logError(message)
       }
       plugins.push(requiredPlugin);
     } else {