From ef8030870896cea20497bdfa13382adec5b620c2 Mon Sep 17 00:00:00 2001
From: johnkenny54 <45182853+johnkenny54@users.noreply.github.com>
Date: Mon, 30 Sep 2024 13:59:47 -0700
Subject: [PATCH] Update preset-default and docs. (#21)

---
 docs/04-plugins/cleanupIds.mdx   | 42 -------------------------------
 docs/04-plugins/inlineStyles.mdx | 19 --------------
 docs/plugins/cleanupIds.md       | 15 +++++++++++
 docs/plugins/inlineStyles.md     | 17 +++++++++++++
 docs/plugins/minifyPathData.md   | 11 ++++++++
 docs/preset-default.md           |  7 +++---
 docs/preset-next.md              | 43 +++-----------------------------
 plugins/plugins-types.d.ts       |  3 ---
 plugins/preset-default.js        |  2 ++
 9 files changed, 53 insertions(+), 106 deletions(-)
 delete mode 100644 docs/04-plugins/cleanupIds.mdx
 delete mode 100644 docs/04-plugins/inlineStyles.mdx
 create mode 100644 docs/plugins/cleanupIds.md
 create mode 100644 docs/plugins/inlineStyles.md
 create mode 100644 docs/plugins/minifyPathData.md

diff --git a/docs/04-plugins/cleanupIds.mdx b/docs/04-plugins/cleanupIds.mdx
deleted file mode 100644
index 31264dc..0000000
--- a/docs/04-plugins/cleanupIds.mdx
+++ /dev/null
@@ -1,42 +0,0 @@
----
-title: cleanupIds
-svgo:
-  pluginId: cleanupIds
-  parameters:
-    remove:
-      description: If to remove all unreferenced IDs.
-      default: true
-    minify:
-      description: If to minify referenced IDs.
-      default: true
-    preserve:
-      description: Elements with one of these IDs will be ignored.
-      default: []
-    preservePrefixes:
-      description: Elements with an ID that starts with one of these prefixes will be ignored.
-      default: []
-    force:
-      description: This plugin normally does nothing if a `<script>` or `<style>` element is found. Setting this to true will bypass that behaviour, which may result in destructive changes.
-      default: false
-  defaultPlugin: true
----
-
-Removes unused IDs, and minifys IDs that are referenced by other elements.
-
-By default, we back off from removing and minifying IDs if a `<script>` or `<style>` element is present in the document. You can bypass this behavior by setting the `force` parameter to `true`.
-
-:::info
-
-Between v2 and v3, the plugin was renamed from `cleanupIDs` to `cleanupIds`, if you've recently migrated and having issues, please double-check the capitalization!
-
-:::
-
-:::caution
-
-This plugin has been known to cause problems when inlining multiple SVGs in the same parent document. Due to the predictable algorithm used to minify IDs, separate documents that are run though SVGO may end up with clashing IDs.
-
-You can work around this by enabling the [prefixIds](/docs/plugins/prefixIds/) plugin. Alternatively, you can set the `minify` parameter to `false`, however this will not resolve the issue if your SVGs already had clashing IDs to start with.
-
-See [facebook/docusaurus#8297](https://github.com/facebook/docusaurus/issues/8297) for more context.
-
-:::
diff --git a/docs/04-plugins/inlineStyles.mdx b/docs/04-plugins/inlineStyles.mdx
deleted file mode 100644
index 9ee411b..0000000
--- a/docs/04-plugins/inlineStyles.mdx
+++ /dev/null
@@ -1,19 +0,0 @@
----
-title: inlineStyles
-svgo:
-  pluginId: inlineStyles
-  defaultPlugin: true
-  parameters:
-    onlyMatchedOnce:
-      description: If to only inline styles if the selector matches one element.
-      default: true
-    removeMatchedSelectors:
-      description: If to remove the selector and styles from the stylesheet while inlining the styles. This does not remove selectors that did not match any elements.
-      default: true
-    useMqs:
-      description: An array of media query conditions to use, such as `screen`. An empty string signifies all selectors outside of a media query.
-    usePseudos:
-      description: What pseudo-classes and pseudo-elements to use. An empty string signifies all non-pseudo-classes and non-pseudo-elements.
----
-
-Merges styles from `<style>` elements to the `style` attribute of matching elements.
diff --git a/docs/plugins/cleanupIds.md b/docs/plugins/cleanupIds.md
new file mode 100644
index 0000000..1beb449
--- /dev/null
+++ b/docs/plugins/cleanupIds.md
@@ -0,0 +1,15 @@
+# cleanupIds
+
+Removes unreferenced `id` attributes, and minifies id values that remain.
+
+## Options
+
+- `preserve`: **string[]** - a list of id values that will not be removed or minified
+- `preservePrefixes`: **string[]** - a list of prefixes; any id values that begin with one of these prefixes will not be removed or minified
+
+## Details
+
+The plugin has no effect if:
+
+- The document has scripts.
+- The document has `<style>` elements with CSS which **svgo-ll** is not able to process.
diff --git a/docs/plugins/inlineStyles.md b/docs/plugins/inlineStyles.md
new file mode 100644
index 0000000..6cf7bcc
--- /dev/null
+++ b/docs/plugins/inlineStyles.md
@@ -0,0 +1,17 @@
+# inlineStyles
+
+Moves style properties from `<style>` elements to the `style` attribute of matching elements.
+
+The plugin has no effect if:
+
+- The document has scripts.
+- The document has `<style>` elements with CSS which **svgo-ll** is not able to process.
+
+Style properties are only moved if all of the following are true:
+
+- The rule only matches a single element.
+- The matched element does not already have a `style` attribute.
+- The matching rule is not in a media query.
+- The matching selector does not have pseudo-classes or pseudo-elements.
+
+Any rules which are no longer necessary are removed from the `<style>` element.
diff --git a/docs/plugins/minifyPathData.md b/docs/plugins/minifyPathData.md
new file mode 100644
index 0000000..e51b721
--- /dev/null
+++ b/docs/plugins/minifyPathData.md
@@ -0,0 +1,11 @@
+# minifyPathData
+
+Rewrites the `d` attribute of `path` elements in a more compact form.
+
+## Details
+
+The plugin has no effect if:
+
+- The document has scripts.
+- The document has `<style>` elements with CSS which **svgo-ll** is not able to process.
+- The `<style>` element has rules with an attribute selector on the `d` attribute.
diff --git a/docs/preset-default.md b/docs/preset-default.md
index ab28213..9db865b 100644
--- a/docs/preset-default.md
+++ b/docs/preset-default.md
@@ -11,11 +11,12 @@ The following plugins are included in `preset-default`, in the order that they'r
 - removeEditorsNSData
 - removeDesc
 - cleanupAttrs
+- [cleanupXlink](./plugins/cleanupXlink.md)
 - cleanupStyleAttributes
 - combineStyleElements
-- inlineStyles
+- [inlineStyles](./plugins/inlineStyles.md)
 - minifyStyles
-- cleanupIds
+- [cleanupIds](./plugins/cleanupIds.md)
 - removeUselessDefs
 - convertColors
 - [removeUnknownsAndDefaults](./plugins/removeUnknownsAndDefaults.md)
@@ -30,7 +31,7 @@ The following plugins are included in `preset-default`, in the order that they'r
 - collapseGroups
 - convertShapeToPath
 - combinePaths
-- minifyPathData
+- [minifyPathData](./plugins/minifyPathData.md)
 - removeEmptyAttrs
 - removeEmptyContainers
 - removeUnusedNS
diff --git a/docs/preset-next.md b/docs/preset-next.md
index 7958bcc..32b5230 100644
--- a/docs/preset-next.md
+++ b/docs/preset-next.md
@@ -1,5 +1,5 @@
 `preset-next` is the set of plugins that will become the [defaults](./preset-default.md) in version 6. To enable these plugins, use the
-`--preset=next` option on the command line.
+`--preset=next` option on the [command line](./command-line-options.md).
 
 ## Plugins List
 
@@ -15,9 +15,9 @@ The following plugins are included in `preset-next`, in the order that they're e
 - [cleanupXlink](./plugins/cleanupXlink.md)
 - cleanupStyleAttributes
 - combineStyleElements
-- inlineStyles
+- [inlineStyles](./plugins/inlineStyles.md)
 - minifyStyles
-- cleanupIds
+- [cleanupIds](./plugins/cleanupIds.md)
 - removeUselessDefs
 - convertColors
 - [removeUnknownsAndDefaults](./plugins/removeUnknownsAndDefaults.md)
@@ -32,42 +32,7 @@ The following plugins are included in `preset-next`, in the order that they're e
 - collapseGroups
 - convertShapeToPath
 - combinePaths
-- minifyPathData
+- [minifyPathData](./plugins/minifyPathData.md)
 - removeEmptyAttrs
 - removeEmptyContainers
 - removeUnusedNS
-
-## Disable a Plugin
-
-Sometimes a specific plugin might not be appropriate for your workflow. You can continue using `preset-default` while disabling any plugin by using the `overrides` parameter.
-
-In `overrides`, reference the plugin ID and set it to `false` to disable it:
-
-```js
-module.exports = {
-  plugins: [
-    {
-      name: 'preset-default',
-      params: {
-        overrides: {
-          cleanupIds: false,
-        },
-      },
-    },
-  ],
-};
-```
-
-Alternatively, you can drop `preset-default` entirely, and configure your own plugin pipeline from scratch, with only the desirable plugins:
-
-```js
-module.exports = {
-  plugins: [
-    'removeDoctype',
-    'removeXMLProcInst',
-    'minifyStyles',
-    'sortAttrs',
-    'sortDefsChildren',
-  ],
-};
-```
diff --git a/plugins/plugins-types.d.ts b/plugins/plugins-types.d.ts
index e358d3a..f7acddd 100644
--- a/plugins/plugins-types.d.ts
+++ b/plugins/plugins-types.d.ts
@@ -12,11 +12,8 @@ type DefaultPlugins = {
   };
   cleanupEnableBackground: void;
   cleanupIds: {
-    remove?: boolean;
-    minify?: boolean;
     preserve?: string[];
     preservePrefixes?: string[];
-    force?: boolean;
   };
   cleanupNumericValues: {
     floatPrecision?: number;
diff --git a/plugins/preset-default.js b/plugins/preset-default.js
index 82275c3..b7ba366 100644
--- a/plugins/preset-default.js
+++ b/plugins/preset-default.js
@@ -2,6 +2,7 @@ import { createPreset } from '../lib/svgo/plugins.js';
 import * as cleanupAttrs from './cleanupAttrs.js';
 import * as cleanupIds from './cleanupIds.js';
 import * as cleanupStyleAttributes from './cleanupStyleAttributes.js';
+import * as cleanupXlink from './cleanupXlink.js';
 import * as collapseGroups from './collapseGroups.js';
 import * as combinePaths from './combinePaths.js';
 import * as combineStyleElements from './combineStyleElements.js';
@@ -40,6 +41,7 @@ const presetDefault = createPreset({
     removeEditorsNSData,
     removeDesc,
     cleanupAttrs,
+    cleanupXlink,
     cleanupStyleAttributes,
     combineStyleElements,
     inlineStyles,