1
0
mirror of https://github.com/svg/svgo.git synced 2025-07-29 20:21:14 +03:00

Add "visitor" plugins support (#1454)

Visitor is a simple pattern which helps to avoid many type checks
and provide both "perItem" and "perItemReverse" functionality without
fragmentation.

The most important case is an ability to define state which in many
plugins specified either on module level or by polluting `params`.

In this diff I added visit and detachFromParent utilities and refactored
new mergeStyles plugin with it.

Also fixed bug when cdata content is merged into "text" node which is
not always valid.
This commit is contained in:
Bogdan Chadkin
2021-03-28 11:20:17 +03:00
committed by GitHub
parent 19c77d2398
commit 27bef1a954
6 changed files with 234 additions and 60 deletions

View File

@ -1,87 +1,85 @@
'use strict';
const { querySelectorAll, closestByName } = require('../lib/xast.js');
const { getCssStr, setCssStr } = require('../lib/css-tools');
const { closestByName, detachNodeFromParent } = require('../lib/xast.js');
const JSAPI = require('../lib/svgo/jsAPI.js');
exports.type = 'full';
exports.type = 'visitor';
exports.active = true;
exports.description = 'merge multiple style elements into one';
/**
* Merge multiple style elements into one.
*
* @param {Object} document document element
*
* @author strarsis <strarsis@gmail.com>
*/
exports.fn = function (document) {
// collect <style/>s with valid type attribute (preserve order)
const styleElements = querySelectorAll(document, 'style');
exports.fn = () => {
let firstStyleElement = null;
let collectedStyles = '';
let styleContentType = 'text';
// no <styles/>s, nothing to do
if (styleElements.length === 0) {
return document;
}
const enterElement = (node) => {
// collect style elements
if (node.name !== 'style') {
return;
}
const styles = [];
for (const styleElement of styleElements) {
// skip <style> with invalid type attribute
if (
styleElement.attributes.type &&
styleElement.attributes.type !== 'text/css'
node.attributes.type != null &&
node.attributes.type !== '' &&
node.attributes.type !== 'text/css'
) {
// skip <style> with invalid type attribute
continue;
return;
}
if (closestByName(styleElement, 'foreignObject')) {
// skip <foreignObject> content
continue;
// skip <foreignObject> content
if (closestByName(node, 'foreignObject')) {
return;
}
const cssString = getCssStr(styleElement);
// extract style element content
let css = '';
for (const child of node.children) {
if (child.type === 'text') {
css += child.value;
}
if (child.type === 'cdata') {
styleContentType = 'cdata';
css += child.value;
}
}
styles.push({
styleElement: styleElement,
// remove empty style elements
if (css.trim().length === 0) {
detachNodeFromParent(node);
return;
}
mq: styleElement.attributes.media,
cssStr: cssString,
});
}
const collectedStyles = [];
for (let styleNo = 0; styleNo < styles.length; styleNo += 1) {
const style = styles[styleNo];
if (style.mq) {
const wrappedStyles = `@media ${style.mq}{${style.cssStr}}`;
collectedStyles.push(wrappedStyles);
// collect css and wrap with media query if present in attribute
if (node.attributes.media == null) {
collectedStyles += css;
} else {
collectedStyles.push(style.cssStr);
collectedStyles += `@media ${node.attributes.media}{${css}}`;
delete node.attributes.media;
}
// remove all processed style elements except the first one
if (styleNo > 0) {
removeFromParent(style.styleElement);
// combine collected styles in the first style element
if (firstStyleElement == null) {
firstStyleElement = node;
} else {
detachNodeFromParent(node);
firstStyleElement.children = [
new JSAPI(
{ type: styleContentType, value: collectedStyles },
firstStyleElement
),
];
}
}
const collectedStylesString = collectedStyles.join('');
};
// combine collected styles in the first style element
const firstStyle = styles[0];
delete firstStyle.styleElement.attributes.media; // remove media mq attribute as CSS media queries are used
if (collectedStylesString.trim().length > 0) {
setCssStr(firstStyle.styleElement, collectedStylesString);
} else {
removeFromParent(firstStyle.styleElement);
}
return document;
return {
element: {
enter: enterElement,
},
};
};
function removeFromParent(element) {
const parentElement = element.parentNode;
return parentElement.children.splice(
parentElement.children.indexOf(element),
1
);
}