Merge pull request #65 from funbox/improve-config

Remove import of patched SVGO plugin from default config

Author: igoradamenko

.optimiztrc.js

@@ -1,5 +1,3 @@
-import removeUnknownsAndDefaults from './svgo/removeUnknownsAndDefaults.cjs';
-
 export default {
   optimize: {
     jpeg: {
@@ -75,11 +73,7 @@ export default {
           We want to remove useless parts of SVG, but to leave `stroke="none"`.
           For this purpose we use here a custom version of `removeUnknownsAndDefaults`.
          */
-        {
-          name: 'removeUnknownsAndDefaults',
-          ...removeUnknownsAndDefaults,
-        },
-
+        'removeUnknownsAndDefaultsPATCHED',
         'cleanupAttrs',
         'mergeStyles',
         'inlineStyles',

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 5.0.0 (19.05.2023)
+
+Removed `removeOffCanvasPaths` plugin from SVGO config due to known bugs: [svg/svgo#1732](https://github.com/svg/svgo/issues/1732), [svg/svgo#1646](https://github.com/svg/svgo/issues/1646).
+
+Removed import of `removeUnknownsAndDefaults` plugin from the default config to make it easy to redefine the config on the user side.
+
+Check out [migration guide](./MIGRATION.md).
+
+
 ## 4.1.1 (27.02.2023)
 
 Fixed installation and included the configuration file to the package. 

MIGRATION.md

@@ -1,5 +1,14 @@
 # Migration
 
+## 4.1.1 → 5.0.0
+
+First, `removeOffCanvasPaths` SVGO plugin has been removed, so make sure that all your SVG files are optimized correctly by Optimizt v5. 
+It's possible that you encounter structure changes in the SVGs code, but there should not be any visual changes.
+
+Last, if you were using your own config file and monkey-patched import of `removeUnknownsAndDefaults` plugin, now you should not do it.
+Instead use string literal `'removeUnknownsAndDefaultsPATCHED'` in `optimize.svg.plugin` array of the config. Check out the default config to make sure that you're doing everything right.
+
+
 ## 3.1.2 → 4.0.0
 
 Drop Node.js v12 support.

index.js

@@ -3,12 +3,14 @@ import convert from './lib/convert.js';
 import findConfig from './lib/findConfig.js';
 import { enableVerbose } from './lib/log.js';
 import optimize from './lib/optimize.js';
+import prepareConfig from './lib/prepareConfig.js';
 import prepareFilePaths from './lib/prepareFilePaths.js';
 import prepareOutputPath from './lib/prepareOutputPath.js';
 
 export default async function optimizt({ paths, avif, webp, force, lossless, verbose, output, config }) {
   const configFilepath = config ? checkConfigPath(config) : findConfig();
   const configData = await import(configFilepath);
+  const preparedConfig = prepareConfig(configData);
 
   if (verbose) enableVerbose();
 
@@ -20,14 +22,14 @@ export default async function optimizt({ paths, avif, webp, force, lossless, ver
       webp,
       force,
       output: prepareOutputPath(output),
-      config: configData.default.convert,
+      config: preparedConfig.convert,
     });
   } else {
     await optimize({
       paths: prepareFilePaths(paths, ['gif', 'jpeg', 'jpg', 'png', 'svg']),
       lossless,
       output: prepareOutputPath(output),
-      config: configData.default.optimize,
+      config: preparedConfig.optimize,
     });
   }
 }

lib/prepareConfig.js

@@ -0,0 +1,18 @@
+import removeUnknownsAndDefaults from '../svgo/removeUnknownsAndDefaults.cjs';
+
+export default function prepareConfig(configData) {
+  const svgoPlugins = configData.default.optimize?.svg?.plugins;
+
+  if (svgoPlugins) {
+    const indexOfRemoveUnknownsAndDefaults = svgoPlugins.indexOf('removeUnknownsAndDefaultsPATCHED');
+
+    if (indexOfRemoveUnknownsAndDefaults !== -1) {
+      svgoPlugins[indexOfRemoveUnknownsAndDefaults] = {
+        name: 'removeUnknownsAndDefaults',
+        ...removeUnknownsAndDefaults,
+      };
+    }
+  }
+
+  return configData.default;
+}

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@funboxteam/optimizt",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "CLI image optimization tool",
   "license": "MIT",
   "author": "Andrey Warkentin (https://github.com/343dev)",