Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(deps): update dependency svgo to v2 - autoclosed #92

Closed
wants to merge 1 commit into from
Closed

chore(deps): update dependency svgo to v2 - autoclosed #92

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Apr 1, 2021 •
edited
Loading

WhiteSource Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
svgo 1.3.2 -> 2.8.0 age adoption passing confidence

Release Notes

svg/svgo

v2.8.0

Compare Source

If you enjoy SVGO and would like to support our work, consider sponsoring us directly via our OpenCollective.

Join us in our discord

Features and bug fixes

Refactorings

DX

I found some users are trying to enable plugins which are not part of default preset, for example

{
  name: 'preset-default',
  params: {
    overrides: {
      cleanupListOfValues: true
    }
  }
}

To fix this I made docs more concrete about plugin (svg/svgo@5165ccb)
and introduced a warning when true is specified in overrides (svg/svgo@cb7e9be).
Please give us feedback if you still have issues.

Thanks to @​IlyaSkriblovsky, @​devongovett, @​matheus1lva, @​omgovich, @​renatorib and @​TrySound

v2.7.0

Compare Source

If you enjoy SVGO and would like to support our work, consider sponsoring us directly via our OpenCollective.

Join us in our discord

ES Modules support

This release adds support for es modules in svgo.config.js when package.json type field is "module".
For projects with mixed cjs and esm svgo.config.mjs and svgo.config.cjs are also supported as fallback.

See https://github.com/svg/svgo/pull/1583

export default {
  plugins: [
    'preset-default'
  ]
}
Fixes
Refactorings

Follwing plugins are migrated to the new visitor plugin api and covered with tsdoc

Other internal changes

Thanks to @​renatorib, @​matheus1lva, @​omgovich, @​deepsweet, @​ai, @​samouss and @​TrySound

v2.6.1

Compare Source

Thanks to @​XhmikosR, @​thewilkybarkid, @​renatorib, @​matheus1lva, @​omgovich and @​TrySound

v2.6.0

Compare Source

If you enjoy SVGO and would like to support our work, consider sponsoring us directly via our OpenCollective.

We have some good stuff in this release

Better syntax errors (https://github.com/svg/svgo/pull/1553)

Before people struggled to figure out what and why happens with such cryptic error

Error: Error in parsing SVG: Unquoted attribute value
Line: 1
Column: 29
Char: 6
File: input.svg

This gives too little information when a lot of svgs are transformed.

New errors look like this, include context and point to exact location with the issue.
We hope this will solve many issues when dealing with bundlers and other tools integrations.

Error: SvgoParserError: input.svg:2:29: Unquoted attribute value

  1 | <svg viewBox="0 0 120 120">
> 2 |   <circle fill="#ff0000" cx=60.444444" cy="60" r="50"/>
    |                             ^
  3 | </svg>
  4 |

pefixIds plugin is now idempotent (https://github.com/svg/svgo/pull/1561)

To get better compression results SVGO uses multipass option. This option is used
to run prefixIds plugin only once to prefix ids and classes properly.

Though sometimes users run svgo manually a few times which leads to duplicated
prefixes and make code much bigger. To solves this prefixIds was redesigned
to add prefix only when it does not exit in ids and classes.

Eventually all plugins are planned to be determenistic and idempotent
so multipass option would not be necessary and single pass compression
could be as effective as possible.

New js2svg options (https://github.com/svg/svgo/pull/1546)

js2svg.eol: 'lf' | 'crlf'

Allows to customize end of line characters which is usually resolved by os.EOL in node.

finalNewline: boolean

Ensures SVG output has a final newline which is required for some tools like git.

Fixes and refactorings

Follwing plugins are migrated to the new visitor plugin api and covered with tsdoc

Also fixed a few bugs

Thanks to @​XhmikosR, @​matheus1lva, @​deepsweet, @​omgovich, @​adalinesimonian and @​TrySound

v2.5.0

Compare Source

In this release we have a couple of fixes

Visitor api now get parentNode in enter and exit callback

return {
  element: {
    enter: (node, parentNode) => {
    },
    exit: (node, parentNode) => {
    }
  }
}

And a lot of plugins are migrated to visitor api and covered them with tsdoc

  • addAttributesToSVGElement
  • addClassesToSVGElement
  • cleanupAttrs
  • cleanupEnableBackground
  • cleanupListOfValues
  • cleanupNumericValues
  • convertColors
  • convertEllipseToCircle
  • convertShapeToPath
  • convertTransform
  • mergePaths
  • removeAttributesBySelector
  • removeAttrs
  • removeComments
  • removeDesc
  • removeDoctype
  • removeElementsByAttr
  • removeEmptyText
  • removeMetadata
  • removeRasterImages
  • removeScriptElement
  • removeStyleElement
  • removeTitle
  • removeXMLProcInst
  • removeHiddenElems
  • removeViewBox
  • removeUselessDefs
  • removeOffCanvasPaths
  • removeUnknownsAndDefaults
  • sortDefsChildren

Thanks to @​XhmikosR, @​morganney, @​oBusk, @​matheus1lva and @​TrySound

v2.4.0

Compare Source

Hey everybody!

In this release I happy to introduce the new plugin "preset-default" which allows to declaratively setup and customize default set of plugins. Previous solution extendDefaultPlugins utility prevented parcel users from using cachable json config, svgo-loader and svgo-jsx required svgo to be installed locally. "preset-default" plugin is just another builtin plugi.

module.exports = {
  plugins: [
    {
      name: 'preset-default',
      params: {
        overrides: {
          // customize options
          builtinPluginName: {
            optionName: 'optionValue',
          },
          // or disable plugins
          anotherBuiltinPlugin: false,
        },
      },
    },
  ],
};

We also fixed a few bugs

Thanks to @​TrySound, @​ydaniv, @​ludofischer, @​XhmikosR and @​joseprio

v2.3.1

Compare Source

Fixed vulnerability in css-select dependency (https://github.com/svg/svgo/pull/1485)

Thanks to @​ericcornelissen

v2.3.0

Compare Source

Hey, everybody! We have a big release here.

  • The new plugin is added for merging style elements into one. See #​1381

Before:

<svg>
  <style media="print">
    .st0{ fill:red; padding-top: 1em; padding-right: 1em; padding-bottom: 1em; padding-left: 1em; }
  </style>
  <style>
    .test { background: red; }
  </style>
</svg>

After:

<svg>
  <style>
    @&#8203;media print{
      .st0{ fill:red; padding-top: 1em; padding-right: 1em; padding-bottom: 1em; padding-left: 1em; }
    }
    .test { background: red; }
  </style>
</svg>
  • CLI got new --exclude flag which uses regexps to exclude some files from --folder. See #​1409
svgo --folder=svgs --exclude "invalid-icon" "bad-.+"

  • Internal AST is migrated to XAST. This spec makes maintaining plugins easier and may be used as interop with other tools like SVGR.

  • The new visitor plugin type combines features of "full", "perItem" and "perItemReverse" plugins without loosing simplicity. Eventually only visitor api will be supported. See #​1454

Also small fixes

Thanks to @​chambo-e, @​strarsis, @​XhmikosR, @​omgovich and @​TrySound

v2.2.2

Compare Source

v2.2.1

Compare Source

This is a big patch with new style computing (https://github.com/svg/svgo/pull/1399) and landed to master regression tests

A lot of bugs are fixed

435 of 526 regression tests are passing

Thanks to @​XhmikosR @​sk- and @​TrySound

v2.2.0

Compare Source

Wow, two minor releases in a row. There is a big reason for that. We got a new logo! See it in readme. Big thanks to @​DerianAndre.

There were also implemented brand new path data parser and stringifier (https://github.com/svg/svgo/pull/1378 and https://github.com/svg/svgo/pull/1387) to do more reliable transformations and produce smaller svg.

A cup of small fixes

Thanks to @​sk- @​XhmikosR @​deepsweet and @​TrySound

v2.1.0

Compare Source

This release introduced two big changes

See fixed bugs

Thanks to @​XhmikosR @​sk- @​chromakode @​devongovett and @​TrySound

v2.0.3

Compare Source

Thanks to @​ChrisRu @​XhmikosR @​yisibl @​TrySound

v2.0.2

Compare Source

Thanks to @​XhmikosR and @​TrySound

v2.0.1

Compare Source

Thanks to @​sk- @​Brooooooklyn @​strarsis @​AlpayY @​TrySound

v2.0.0

Compare Source

Happy to introduce SVGO 2.0. Package size was drastically reduced. Configuration
is heavily simplified. Node 10.13+ is required.

  • smaller install size
  • simplified config format
  • added browser ready es module bundle
  • API is synchronous
  • support only svgo.config.js for external configuration

Config changes

Since early versions plugins configuration was affected by yaml syntax.
Though it was not practial in json or javascript for writing and for internal
work.

plugins:
    - removeViewBox: true
    - removeAttr:
        attrs: '(fill|stroke)'
{
  plugins: [
    {
      removeViewBox: true
    },
    {
      removeAttr: {
        attrs: '(fill|stroke)'
      }
    }
  ]
}

In the new version plugins configuration is closer to internal representation.

{
  plugins: [
    {
      name: 'removeViewBox'
    },
    {
      name: 'removeAttr',
      params: {
        attrs: '(fill|stroke)'
      }
    }
  ]
}

In v1 full flag allowed to disable all default plugins and run only specified
in plugins list. In v2 it's default behaviour. To extend default plugins list
you can use extendDefaultPlugins utility.

{
  plugins: extendDefaultPlugins([
    {
      name: 'removeViewBox',
      active: false,
    }
  ])
}

Loading custom plugin by path was removed in favour of manual import or require.

+const customPlugin = require('./custom-plugin.js')
 {
   plugins: [
     {
       name: 'customPlugin',
-      path: './custom-plugin.js'
+      ...customPlugin
     }
   ]
 }

CLI changes

Painful coa was replaced with well maintained commander.

--enable and --disable flags are removed. In later versions we will explore
plugins setup via CLI.

Inlined json config is no longer suppored. CLI flags should be used instead.

--config="{multipass:true}"

By default SVGO CLI will search for svgo.config.js. --config flag allows
to specify js config with any name.

YAML and JSON configuration is no longer supported for the sake of simplicity
and less dependencies.

Node API changes

Initially SVGO was implemented with callback style api to fit sax recommendation.
Though in practice api was synchronous and allowed to access the result assigned
in callback right after optimisation.

For v1 callback style was replaced with promise api which cannot longer be run
synchronously. This was a pain point for many tools and required hacking svgo.

In v2 this pain is considered and api is now synchronous. No hacks necessary.

SVGO class is replaced with optimize function.

-const { SVGO } = require('svgo')
-const svgo = new SVGO({
-  // config
-  multipass: true
-})
-svgo.optimize(svgstring, { path: './file.svg' }).then(result => {
-  ...
-})
+const { optimize, extendDefaultPlugins } = require('svgo')
+optimize(svgstring, {
+  path: './file.svg',
+  multipass: true,
+})

Some tools require the same logic for resolving svgo config as SVGO CLI.

const { loadConfig, optimize } = require('svgo')
...
const config = await loadConfig()
optimize(svgstring, { path: './file.svg', ...config })

Browser ready bundle

There were a lot of request for this feature in the past.
Now tools like svgomg may use official and tested es module for browsers with optimize, extendDefaultPlugins and createContentItem support.

import {
  optimize,
  extendDefaultPlugins,
  createContentItem
} from 'svgo/dist/svgo.browser.js'

Configuration

📅 Schedule: "before 3am on the first day of the month" in timezone Europe/Paris.

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by WhiteSource Renovate. View repository job log here.

@renovate renovate bot requested a review from lmorel3 as a code owner April 1, 2021 00:14
@renovate renovate bot force-pushed the renovate/svgo-2.x branch 2 times, most recently from 7c4cd72 to 1c55343 Compare June 16, 2021 10:44
@renovate renovate bot changed the title chore(deps): update dependency svgo to v2 chore(deps): update dependency svgo to v2 - autoclosed Nov 25, 2021
@renovate renovate bot closed this Nov 25, 2021
@renovate renovate bot deleted the renovate/svgo-2.x branch November 25, 2021 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lmorel3 lmorel3 Awaiting requested review from lmorel3 lmorel3 is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@renovate-bot