Update preset-default and docs. (#21)

svg-utils · Sep 30, 2024 · ef80308 · ef80308
1 parent 2ce7882
commit ef80308
Show file tree

Hide file tree

Showing 9 changed files with 53 additions and 106 deletions.
diff --git a/docs/04-plugins/cleanupIds.mdx b/docs/04-plugins/cleanupIds.mdx
diff --git a/docs/04-plugins/inlineStyles.mdx b/docs/04-plugins/inlineStyles.mdx
diff --git a/docs/plugins/cleanupIds.md 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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,