Merge remote-tracking branch 'upstream/main' into patch-optimize-order

svg · Dec 20, 2023 · 9ca4e56 · 9ca4e56
1 parent b50a6e7
commit 9ca4e56
Show file tree

Hide file tree

Showing 128 changed files with 1,843 additions and 1,361 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,30 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 2021
+  },
+  "env": {
+    "node": true,
+    "es2021": true
+  },
+  "extends": ["eslint:recommended"],
+  "overrides": [
+    {
+      "files": ["rollup.config.js", "**/*.mjs"],
+      "parserOptions": {
+        "sourceType": "module"
+      }
+    },
+    {
+      "files": ["**/*.cjs"],
+      "parserOptions": {
+        "sourceType": "commonjs"
+      }
+    },
+    {
+      "files": ["**/*.test.js"],
+      "env": {
+        "jest": true
+      }
+    }
+  ]
+}
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -4,14 +4,14 @@ about: Create a report to help us improve
 title: ''
 labels: bug
 assignees: ''
-
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,9 +24,10 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - SVGO Version [e.g. 2.0.3]
- - NodeJs Version [e.g 14.0.4]
- - OS: [e.g. iOS]
-
+
+- SVGO Version [e.g. 2.0.3]
+- NodeJs Version [e.g 14.0.4]
+- OS: [e.g. iOS]
+
 **Additional context**
 Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -4,7 +4,6 @@ about: Suggest an idea for this project
 title: ''
 labels: enhancement
 assignees: ''
-
 ---
 
 **Is your feature request related to a problem? Please describe.**

diff --git a/.github/ISSUE_TEMPLATE/plugin_request.md b/.github/ISSUE_TEMPLATE/plugin_request.md
@@ -4,7 +4,6 @@ about: Suggest a plugin for this project
 title: ''
 labels: 'New plugin'
 assignees: ''
-
 ---
 
 **Is your plugin request related to a problem? Please describe.**
@@ -19,4 +18,5 @@ A clear and concise description of what you want to happen.
 Include any links pointing to relevant specs or general knowledge that may validate your plugin idea.
 
 **Implementation**
+
 - [ ] Are you volunteering to work on this plugin?
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: monthly
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE }}
           cache: yarn
@@ -31,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE }}
           cache: yarn
@@ -53,7 +53,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: yarn

diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -2,6 +2,6 @@ nodeLinker: node-modules
 
 plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
-    spec: "@yarnpkg/plugin-interactive-tools"
+    spec: '@yarnpkg/plugin-interactive-tools'
 
 yarnPath: .yarn/releases/yarn-3.2.3.cjs
diff --git a/CHANGELOG-old.md b/CHANGELOG-old.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,9 +6,9 @@ If you've found a bug with SVGO, [create an issue](https://github.com/svg/svgo/i
 
 Your issue should ideally contain:
 
-* A concise description of the bug.
-* How you were using SVGO, the version of the tool, and any configuration or command-line options.
-* The SVG that was effected, or a [Minimal, Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example).
+- A concise description of the bug.
+- How you were using SVGO, the version of the tool, and any configuration or command-line options.
+- The SVG that was effected, or a [Minimal, Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example).
 
 If you haven't found a bug, but need help using SVGO in your project, please consider asking on [Stack Overflow](https://stackoverflow.com/questions/tagged/svgo) with the `[svgo]` tag, you may get help faster there. You can still create an issue if the confusion stemmed from a lack of documentation.
 
@@ -20,8 +20,8 @@ See: [SECURITY.md](./SECURITY.md)
 
 ### Requirements
 
-* [Git](https://git-scm.com/)
-* [Node.js 14](https://nodejs.org/) or later
+- [Git](https://git-scm.com/)
+- [Node.js 14](https://nodejs.org/) or later
 
 ### Getting Started
 

diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ SVG files, especially those exported from vector editors, usually contain a lot
 
 ## Installation
 
-You can install SVGO globablly through npm, yarn, or pnpm. Alternatively, drop the global flag (`global`/`-g`) to use it in your Node.js project.
+You can install SVGO globally through npm, yarn, or pnpm. Alternatively, drop the global flag (`global`/`-g`) to use it in your Node.js project.
 
 ```sh
 # npm
@@ -32,6 +32,7 @@ Process single files:
 ```sh
 svgo one.svg two.svg -o one.min.svg two.min.svg
 ```
+
 Process a directory of files recursively with `-f`/`--folder`:
 
 ```sh
@@ -51,13 +52,14 @@ SVGO has a plugin architecture. You can read more about all plugins in [Plugins
 SVGO reads the configuration from `svgo.config.js` or the `--config path/to/config.js` command-line option. Some other parameters can be configured though command-line options too.
 
 **`svgo.config.js`**
+
 ```js
 module.exports = {
   multipass: false, // boolean
   datauri: 'base64', // 'base64'|'enc'|'unenc'
   js2svg: {
     indent: 4, // number
-    pretty: false // boolean
+    pretty: false, // boolean
   },
   plugins: [
     'preset-default', // built-in plugins enabled by default
@@ -67,17 +69,19 @@ module.exports = {
     {
       name: 'prefixIds',
       params: {
-        prefix: 'uwu'
-      }
-    }
-  ]
+        prefix: 'uwu',
+      },
+    },
+  ],
 };
 ```
+
 ### Default preset
 
 Instead of configuring SVGO from scratch, you can tweak the default preset to suit your needs by configuring or disabling the respective plugin.
 
 **`svgo.config.js`**
+
 ```js
 module.exports = {
   plugins: [
@@ -91,11 +95,11 @@ module.exports = {
           // customize the params of a default plugin
           inlineStyles: {
             onlyMatchedOnce: false,
-          }
-        }
-      }
-    }
-  ]
+          },
+        },
+      },
+    },
+  ],
 };
 ```
 
@@ -106,6 +110,7 @@ You can find a list of the default plugins in the order they run in [Preset Defa
 You can also specify custom plugins:
 
 **`svgo.config.js`**
+
 ```js
 const importedPlugin = require('./imported-plugin');
 
@@ -120,9 +125,9 @@ module.exports = {
       params: {
         paramName: 'paramValue',
       },
-      fn: (ast, params, info) => {}
-    }
-  ]
+      fn: (ast, params, info) => {},
+    },
+  ],
 };
 ```
 
@@ -139,7 +144,7 @@ const { optimize } = require('svgo');
 
 const result = optimize(svgString, {
   path: 'path-to.svg', // recommended
-  multipass: true // all other config fields are available here
+  multipass: true, // all other config fields are available here
 });
 
 const optimizedSvgString = result.data;
@@ -163,29 +168,29 @@ const config = await loadConfig(configFile, cwd);
 
 ## Other ways to use SVGO
 
-| Method | Reference |
-| --- | --- |
-| Web app | [SVGOMG](https://jakearchibald.github.io/svgomg/) |
-| Grunt task | [grunt-svgmin](https://github.com/sindresorhus/grunt-svgmin) |
-| Gulp task | [gulp-svgmin](https://github.com/ben-eb/gulp-svgmin) |
-| Webpack loader | [image-minimizer-webpack-plugin](https://github.com/webpack-contrib/image-minimizer-webpack-plugin/#optimize-with-svgo) |
-| PostCSS plugin | [postcss-svgo](https://github.com/cssnano/cssnano/tree/master/packages/postcss-svgo) |
-| Inkscape plugin | [inkscape-svgo](https://github.com/konsumer/inkscape-svgo) |
-| Sketch plugin | [svgo-compressor](https://github.com/BohemianCoding/svgo-compressor) |
-| Rollup plugin | [rollup-plugin-svgo](https://github.com/porsager/rollup-plugin-svgo) |
-| Visual Studio Code plugin | [vscode-svgo](https://github.com/1000ch/vscode-svgo) |
-| Atom plugin | [atom-svgo](https://github.com/1000ch/atom-svgo) |
-| Sublime plugin | [Sublime-svgo](https://github.com/1000ch/Sublime-svgo) |
-| Figma plugin | [Advanced SVG Export](https://www.figma.com/c/plugin/782713260363070260/Advanced-SVG-Export) |
-| Linux app | [Oh My SVG](https://github.com/sonnyp/OhMySVG) |
-| Browser extension | [SVG Gobbler](https://github.com/rossmoody/svg-gobbler) |
-| API | [Vector Express](https://github.com/smidyo/vectorexpress-api#convertor-svgo) |
+| Method                    | Reference                                                                                                               |
+| ------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| Web app                   | [SVGOMG](https://jakearchibald.github.io/svgomg/)                                                                       |
+| Grunt task                | [grunt-svgmin](https://github.com/sindresorhus/grunt-svgmin)                                                            |
+| Gulp task                 | [gulp-svgmin](https://github.com/ben-eb/gulp-svgmin)                                                                    |
+| Webpack loader            | [image-minimizer-webpack-plugin](https://github.com/webpack-contrib/image-minimizer-webpack-plugin/#optimize-with-svgo) |
+| PostCSS plugin            | [postcss-svgo](https://github.com/cssnano/cssnano/tree/master/packages/postcss-svgo)                                    |
+| Inkscape plugin           | [inkscape-svgo](https://github.com/konsumer/inkscape-svgo)                                                              |
+| Sketch plugin             | [svgo-compressor](https://github.com/BohemianCoding/svgo-compressor)                                                    |
+| Rollup plugin             | [rollup-plugin-svgo](https://github.com/porsager/rollup-plugin-svgo)                                                    |
+| Visual Studio Code plugin | [vscode-svgo](https://github.com/1000ch/vscode-svgo)                                                                    |
+| Atom plugin               | [atom-svgo](https://github.com/1000ch/atom-svgo)                                                                        |
+| Sublime plugin            | [Sublime-svgo](https://github.com/1000ch/Sublime-svgo)                                                                  |
+| Figma plugin              | [Advanced SVG Export](https://www.figma.com/c/plugin/782713260363070260/Advanced-SVG-Export)                            |
+| Linux app                 | [Oh My SVG](https://github.com/sonnyp/OhMySVG)                                                                          |
+| Browser extension         | [SVG Gobbler](https://github.com/rossmoody/svg-gobbler)                                                                 |
+| API                       | [Vector Express](https://github.com/smidyo/vectorexpress-api#convertor-svgo)                                            |
 
 ## Donors
 
 | [<img src="https://sheetjs.com/sketch128.png" width="80">](https://sheetjs.com/) | [<img src="https://raw.githubusercontent.com/fontello/fontello/8.0.0/fontello-image.svg" width="80">](https://fontello.com/) |
-| :---: | :---: |
-| [SheetJS LLC](https://sheetjs.com/) | [Fontello](https://fontello.com/) |
+| :------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------: |
+|                       [SheetJS LLC](https://sheetjs.com/)                        |                                              [Fontello](https://fontello.com/)                                               |
 
 ## License and Copyright
 

diff --git a/bin/svgo b/bin/svgo
@@ -4,7 +4,7 @@ const colors = require('picocolors');
 const { program } = require('commander');
 const makeProgram = require('../lib/svgo/coa');
 makeProgram(program);
-program.parseAsync(process.argv).catch(error => {
+program.parseAsync(process.argv).catch((error) => {
   console.error(colors.red(error.stack));
   process.exit(1);
 });
diff --git a/docs/01-index.mdx b/docs/01-index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Introduction
-slug: "introduction"
+slug: 'introduction'
 ---
 
 SVGO (short for SVG Optimizer) is a Node.js library and command-line application for optimizing SVG files.
@@ -11,7 +11,7 @@ SVG files, especially those exported from vector editors, usually contain a lot
 
 ### System Requirements
 
-* [Node.js 14](https://nodejs.org/) or later
+- [Node.js 14](https://nodejs.org/) or later
 
 <Tabs>
   <TabItem value="npm" label="npm" default>