svg-path-simplify 0.3.6 → 0.4.1

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## [0.4.1] - 2026-03-16
+### Fixed
+- null transform removal matrix(1 0 0 1 0 0)
+
+
+## [0.4.0] - 2026-03-16
+### Added
+- convert transforms to hard coded geometry 
+- new style-to-attribute conversion
+- options to specify which shapes should be converted to paths
+- path to shape conversion
+- ungroup paths
+- webapp refined option grouping
+- arc radii minification
+- minify RGB color values
+- move defs to top of markup
+- remove futile clip-paths
+- remove SVG comments
+
+### Changed
+- improved extreme detection for simplification
+- stricter shorthand thresholds

package/README.md

@@ -15,26 +15,58 @@ While this library reduces SVG markup sizes significantly by removing commands i
 Unlike most existing approaches (e.g in graphic applications), it checks where simplifications are suitable and stops simplification at the right »point« (literally).
 
 ![simplification](./demo/img/splash.png)    
-*Fira Sans (based on truetype/glyph quadratic commands) converted to cubic Bèziers. Right:Original; Left:optimized*
+*Fira Sans (based on truetype/glyph quadratic commands) converted to cubic Béziers. Right:Original; Left:optimized*
 
-## Features – what it does
-* reduces the number of SVG commands (both Bèziers and lines) by converting/combining adjacent:  
+## Features 
+### Path simplification
+* reduces the number of SVG commands (both Béziers and lines) by converting/combining adjacent:  
   * Béziers (`C`, `Q`)
   * flat Béziers to Linetos
   * colinear lines (`L`)
+  * converts cubic Béziers which can be expressed as more compact quadratic
 
 * reorders path starting points to replace unnecessary closing linetos by `Z` commands
 * optimizes SVG file size by contextually converting to:  
   * shorthand commands (`C` => `S`, `Q` => `T`, `L`=>`H` or `V`)
   * cubics to quadratic Béziers  (only 1 control point)
-  * cubic arc-like segments to `A` (elliptic arc)
+  * cubic arc-like segments to `A` (elliptic arc) and `rx`, `ry` radii optimization for semi-circle segments
 
+### Coordinate rounding
 * adaptive coordinate rounding: small or large details can be auto-detected to find a suitable floating point accuracy without guessing the decimal value (3 decimals may not be the silver bullet=)
+
+### SVG optimization
+Cleanup for:  
+* meta data
+* namespaced attributes or elements 
+* convert `xlink:href` to `href` and vice-versa 
+* move `defs` to the top 
+* remove futile `<clipPath>` defs spanning across the entire viewBox
+* convert styles to presentation attributes
+
+### Shape conversions
+* convert shapes such as `<circle>`, `<ellipse>`, `<rect>` etc. to `<path>` – supports relative `%` or physical units like `mm`
+* convert paths to shapes – if applicable
+
+### Polygons
+* convert paths to polygons
+* reduce poly vertices
+* convert/smooth polygons to curved path data
+
+### Transforms
+* convert transforms to hard-coded path data
+* scale SVGs to desired output size
+
+### Path directions
+* reverse path drawing directions
+* auto-fix compound path directions to comply with non-zero fill rules
+
+### Additional features
 * split segments at extremes – only useful for manual editing
 * optimize either path data strings or SVG markup code
 * create curves from polylines (curve-fitting)
 
 
+
 ## TOC
 * [Usage](#usage)
   + [Browser](#browser)
@@ -44,12 +76,6 @@ Unlike most existing approaches (e.g in graphic applications), it checks where s
     - [Example 2: Apply options](#example-2-apply-options)
   + [Web worker](#web-worker)
 * [API](#api)
-  + [Simplification parameters](#simplification-parameters)
-  + [Advanced simplifications](#advanced-simplifications)
-  + [Output options](#output-options)
-  + [SVG scaling](#svg-scaling)
-  + [SVG output optimizations](#svg-output-optimizations)
-  + [SVG input normalization](#svg-input-normalization)
 * [Lite version](#lite-version--only-path-data)
 * [Demos](#demos)
   + [Web app](#web-app)
@@ -227,82 +253,9 @@ The first parameter is the SVG input:
 * a polygon string – as used in SVG `<polygon>` element's  `points` attribute
 * an entire `<svg>` markup
 
-While svg-path-simplify aims at a convenient config-free usage you can tweak the simplification and output via these options passed as an object.    
-
-### Simplification parameters
-These params control shich simplifications are applied. The default settings aim at a safe or balanced performance-to-minification ratio. However if your main goal is to get the most compact result you can enable additional options which also require more processing time.
-| parameter | effect | type | default |
-| -- | -- | -- | -- |
-| simplifyBezier | main Bézier simplification. When disabled you get the common optimization similar to SVGO (rounding, to all relative and shorthand conversions)  | Boolean | true |
-| tolerance | increase or decrease tolerance: higher values allow more distortions, lower ones more shape fidelity | Number | 1 |
-| optimizeOrder | reorders commands to get more adjacent simplification candidates. Improves optimization efficiency | Boolean | true |
-| removeColinear | removes unnecessary zero-length or colinear lineto commands | Boolean | true |
-| flatBezierToLinetos | replaces flat Béziers with linetos which also can be stripped via previous colinear removal | Boolean | true |
-| revertToQuadratics | replaces cubic Béziers with quadratic (more compact) ones when applicable | Boolean | true |
-| keepExtremes | skips simplification accross x/y extrema – improves shape fidelity | Boolean | true |
-| keepCorners | skips simplification corners – improves shape fidelity | Boolean | true |
-| keepInflections | retains commands introducing direction changes – adds complexity but may help for editing in a graphic application | Boolean | false |
-
-### Advanced simplifications
-| parameter | effect | type | default |
-| -- | -- | -- | -- |
-| refineExtremes | tries to combine commands close to an adjacent x/y extreme segment | Boolean | false |
-| addExtremes | adds commands at x/y extrema – adds complexity but may help for editing in a graphic application – when using this option enable `refineExtremes` as well to avoid tiny adjacent segments | Boolean | false |
-| simplifyCorners | replaces Bézier segments enclosed by linetos with single quadratic commands – handy to reduce overly complex tiny corner roundings. See example in [webapp](https://herrstrietzel.github.io/svg-path-simplify?samples=fontawesome_gears&refineExtremes=true&simplifyCorners=true) | Boolean | false |
-| cubicToArc | replaces Bézier segments by elliptic arc `A` commands where applicable – can reduce complexity for semi- or full circles | Boolean | false |
-| simplifyRound | replaces small round segments encloses by linetos – helps to simplify shapes like gears/cogs | Boolean | false |
-
-
-### Path direction
-| parameter | effect | type | default |
-| -- | -- | -- | -- |
-| fixDirections | alternates sub path directions to fulfill non-zero. Makes fill-rule attribute obsolete and render correct in other environments e.g when converting to fonts | Boolean | false |
-| reversePath | simply reverses drawing direction - sometimes needed for line animations | Boolean | false |
-
-
-
-### Polygon options
-| parameter | effect | type | default |
-| -- | -- | -- | -- |
-| smoothPoly | Curve-fitting: Converts polylines to cubic beziers | Boolean | false |
-
-
-
-### Output options
-
-| parameter | effect | type | default |
-| -- | -- | -- | -- |
-| getObject | whether to return the SVG/pathdata markup directly or a detailed object (containing more info)  | Boolean | true |
-
-
-### SVG output optimizations
-| parameter | effect | type | default |
-| -- | -- | -- | -- |
-| autoAccuracy | calculates a suitable floating point precision for coordinate rounding. Usually rather conservative – decreasing by one decimal should work without significant distortions | Boolean | true |
-| decimals | manual floating point rounding precision – overriden when `autoAccuracy` is enabled | Number | 3 |
-| minifyD | path data microoptimization: removes recurring command type tokens, whitespace and leading zeroes: 0: maximum optimization; 1: "verbose" dont't omit command type tokes; 2: "beautify" separate each command with new lines (e.g for educational purposes) | Number | 0 |
-| toRelative | converts all commands to relative – reduces file size | Boolean | true |
-| toShorthands | converts all commands to shorthand when applicable – reduces file size | Boolean | true |
-
-
-### SVG scaling
-Scaling only indirectly affects file size analogous to rounding. Use it only for very large or small SVGs. Finding the »sweet spot« where all coordinates can be expressed in integers can reduce file size as no decimal separators are required. 
-
-| parameter | effect | type | default |
-| -- | -- | -- | -- |
-| scale | scales all pathdata, `viewBox`, `width` and `height` attributes | Boolean | true |
-| scaleTo | scales to a specified max width | Boolean | false |
-
+While svg-path-simplify aims at a convenient usage with effective and safe defaults you can tweak the simplification and output via these options passed as an object.    
 
-### SVG input normalization
-| parameter | effect | type | default |
-| -- | -- | -- | -- |
-| quadraticToCubic | converts all quadratic Béziers to cubics – recommended for efficiency | Boolean | true |
-| arcToCubic | converts elliptic arc `A` commands to cubic approximations – not recommended | Boolean | false |
-| removeHidden | removes hidden elements for SVG inputs | Boolean | true |
-| mergePaths | concatenates paths into single one – does not respect individual styles! | Boolean | false |
-| shapesToPaths | converts shapes to paths - usually not recommended as shapes are most often more compact. But useful for path concatenation | Boolean | false |
-| stylesToAttributes | consolidates styles and set them to attributes. Also removes invalid attributes (e.g `font-family` for paths) | Boolean | false |
+See [documentation for complete list of parameters](docs/api.md)
 
 
 ## Lite version – only path data