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.

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

Update dependency svgo to v2 #162

Merged
merged 6 commits into from
Jul 7, 2021
Merged

Update dependency svgo to v2 #162

merged 6 commits into from
Jul 7, 2021

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Feb 17, 2021

WhiteSource Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
svgo 1.3.2 -> 2.3.1 age adoption passing confidence
@types/svgo 1.3.5 -> 2.3.1 age adoption passing confidence

Release Notes

svg/svgo

v2.3.1

Compare Source

Fixed vulnerability in css-select dependency (svg/svgo#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 (svg/svgo#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 (svg/svgo#1378 and svg/svgo#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: At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Renovate will not automatically rebase this PR, because other commits have been found.

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


  • If you want to rebase/retry this PR, check this box.

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

@renovate renovate bot force-pushed the renovate/svgo-2.x branch 8 times, most recently from 7f4cd9c to e7ecf5e Compare February 24, 2021 00:53
@renovate renovate bot force-pushed the renovate/svgo-2.x branch 7 times, most recently from 026fa86 to 49f5b8b Compare March 6, 2021 11:55
@renovate renovate bot force-pushed the renovate/svgo-2.x branch 12 times, most recently from 694770c to a7f79a1 Compare March 13, 2021 05:53
@renovate renovate bot force-pushed the renovate/svgo-2.x branch 3 times, most recently from 84edf4e to f09f032 Compare March 15, 2021 20:41
@renovate renovate bot force-pushed the renovate/svgo-2.x branch 6 times, most recently from a5c0689 to e39bc53 Compare April 5, 2021 20:02
@renovate renovate bot force-pushed the renovate/svgo-2.x branch 7 times, most recently from 635a0da to cd5ab42 Compare April 12, 2021 20:00
@renovate renovate bot force-pushed the renovate/svgo-2.x branch 4 times, most recently from f933659 to 67aeaf2 Compare April 29, 2021 22:09
@renovate renovate bot force-pushed the renovate/svgo-2.x branch 2 times, most recently from ed62d59 to a8a25cd Compare July 7, 2021 22:25
@jameswilddev jameswilddev merged commit 93a9884 into master Jul 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants