SVGO v3

[TrySound]

Just a list of possible changes

• replace JSAPI class with set of utilities
• drop createContentItem which creates JSAPI instance from public api
• remove extendDefaultPlugins in favour of "preset-default" plugin
• accept only visitor plugins
• replace stable with native sorting which is stable since node v12
• replace default params object with default params syntax in destructuring
• enable sortAttrs plugin in default preset
• replace convertPathData applyTransforms option with applyTransforms plugin
• throw errors instead of putting into result.error
• split cdata -> text optimisation from minifyStyles into separate plugin (194058b)
• drop commonjs support
• support both es modules and commonjs in loadConfig utility
• remove global floatPrecision in favour of "preset-default" plugin option
• merge removeHiddenElems options
• enable remove-xlink-ns by default ([new plugin] remove-xlink-ns #1535)
• remove multipass option and make all plugins deterministic and idempotent
• remove cleanupIds prefix option in favour of prefxIds plugin (ref 'prefix' option of cleanupIDs does not seem to work #595)
• combine inlineStyles and convertStyleToAttrs into one mature plugin

[strarsis]

Would it make sense to add the txml parser PR (#1301) to the milestone, too?

[vanillajonathan]

Maybe TypeScript?

[TrySound]

Maybe. We already started adding jsdoc for ts.

[TrySound]

Started covering plugins with tsdoc. Quite handy.
#1527

[septs]

Will this project eventually migrate to TypeScript only? or most files?

[TrySound]

Probably no, I'd like to avoid build step. And tsdoc looks like good enough.

[vanillajonathan]

With tsdoc/esdoc/jsdoc you might want to generate HTML documentation which you can host on GitHub pages.

[oscarotero]

Typescript or, at least, ES modules would be great. I created a fork to provide support for Deno some time ago (https://github.com/lumeland/svgo) but it's hard to maintain and update every new version. If the SVGO core used ESM it would be much more easy to adapt for Deno.

[TrySound]

Thank you for this! Not sure about timing. Will try to start working on v3 before the end of the year.

[TrySound]

Btw @oscarotero svgo provides esm module for browsers
https://unpkg.com/browse/[email protected]/dist/svgo.browser.js

The entry point is this module https://github.com/svg/svgo/blob/master/lib/svgo.js

Instead of https://github.com/svg/svgo/blob/master/lib/svgo-node.js used for node.

Can this help with deno?

[oscarotero]

Yes, It's the same entry point that I've used in the Deno fork https://github.com/lumeland/svgo/blob/deno/mod.js
But the browser dist stores the SVG in globalThis (or window), and to use it in Deno it must be imported as module.

[TrySound]

SVGs are not stored in globalThis. Just some dependencies rely on globalThis to cache polyfills.

[oscarotero]

Sorry, you're right. I didn't know SVGO exports ES modules. Just tested it and seems to work fine. Thanks!

I'd love to have some official Deno support (to take advantage of types for configuration and stuff) but, for now, the browser dist just works.

[vanillajonathan]

If you decide not to use TypeScript you might be interested to generate TypeScript defintion files (*.d.ts).

https://www.typescriptlang.org/docs/handbook/declaration-files/dts-from-js.html
https://github.com/microsoft/dts-gen

[TrySound]

That's not a problem. I'll publish types when whole project migrate to TSDoc.

[vanillajonathan]

That's not a problem. I'll publish types when whole project migrate to TSDoc.

Maybe you could generate HTML docs and host it on GitHub Pages then also?

[TrySound]

@vanillajonathan You already wrote about this. Types are not ready yet.

[vanillajonathan]

I meant when you publish the types and when the project has finished its migration to TSDoc.

[amareshsm]

Hey @TrySound,
I would like to contribute to replace default params object with default params syntax in destructuring change Can you give some examples for this?

svgo/lib/svgo.js

Lines 16 to 19 in a9834ef

	const optimize = (input, config) => {
	if (config == null) {
	config = {};
	}

something like this?

const optimize = (input:string='', config: { [key: string]: string; } | null = null) => { 
  if (config == null) { 
    config = {}; 
  } 

[JoKalliauer]

svgo v3.0 is released. Is this issue still up to date?