svgo-v2 2.8.0

package/lib/svgo-node.js

@@ -0,0 +1,106 @@
+'use strict';
+
+const os = require('os');
+const fs = require('fs');
+const { pathToFileURL } = require('url');
+const path = require('path');
+const {
+  extendDefaultPlugins,
+  optimize: optimizeAgnostic,
+  createContentItem,
+} = require('./svgo.js');
+
+exports.extendDefaultPlugins = extendDefaultPlugins;
+exports.createContentItem = createContentItem;
+
+const importConfig = async (configFile) => {
+  let config;
+  // at the moment dynamic import may randomly fail with segfault
+  // to workaround this for some users .cjs extension is loaded
+  // exclusively with require
+  if (configFile.endsWith('.cjs')) {
+    config = require(configFile);
+  } else {
+    try {
+      // dynamic import expects file url instead of path and may fail
+      // when windows path is provided
+      const { default: imported } = await import(pathToFileURL(configFile));
+      config = imported;
+    } catch (importError) {
+      // TODO remove require in v3
+      try {
+        config = require(configFile);
+      } catch (requireError) {
+        // throw original error if es module is detected
+        if (requireError.code === 'ERR_REQUIRE_ESM') {
+          throw importError;
+        } else {
+          throw requireError;
+        }
+      }
+    }
+  }
+  if (config == null || typeof config !== 'object' || Array.isArray(config)) {
+    throw Error(`Invalid config file "${configFile}"`);
+  }
+  return config;
+};
+
+const isFile = async (file) => {
+  try {
+    const stats = await fs.promises.stat(file);
+    return stats.isFile();
+  } catch {
+    return false;
+  }
+};
+
+const loadConfig = async (configFile, cwd = process.cwd()) => {
+  if (configFile != null) {
+    if (path.isAbsolute(configFile)) {
+      return await importConfig(configFile);
+    } else {
+      return await importConfig(path.join(cwd, configFile));
+    }
+  }
+  let dir = cwd;
+  // eslint-disable-next-line no-constant-condition
+  while (true) {
+    const js = path.join(dir, 'svgo.config.js');
+    if (await isFile(js)) {
+      return await importConfig(js);
+    }
+    const mjs = path.join(dir, 'svgo.config.mjs');
+    if (await isFile(mjs)) {
+      return await importConfig(mjs);
+    }
+    const cjs = path.join(dir, 'svgo.config.cjs');
+    if (await isFile(cjs)) {
+      return await importConfig(cjs);
+    }
+    const parent = path.dirname(dir);
+    if (dir === parent) {
+      return null;
+    }
+    dir = parent;
+  }
+};
+exports.loadConfig = loadConfig;
+
+const optimize = (input, config) => {
+  if (config == null) {
+    config = {};
+  }
+  if (typeof config !== 'object') {
+    throw Error('Config should be an object');
+  }
+  return optimizeAgnostic(input, {
+    ...config,
+    js2svg: {
+      // platform specific default for end of line
+      eol: os.EOL === '\r\n' ? 'crlf' : 'lf',
+      ...config.js2svg,
+    },
+  });
+};
+exports.optimize = optimize;

package/lib/svgo.js

@@ -0,0 +1,83 @@
+'use strict';
+
+const {
+  defaultPlugins,
+  resolvePluginConfig,
+  extendDefaultPlugins,
+} = require('./svgo/config.js');
+const { parseSvg } = require('./parser.js');
+const { stringifySvg } = require('./stringifier.js');
+const { invokePlugins } = require('./svgo/plugins.js');
+const JSAPI = require('./svgo/jsAPI.js');
+const { encodeSVGDatauri } = require('./svgo/tools.js');
+
+exports.extendDefaultPlugins = extendDefaultPlugins;
+
+const optimize = (input, config) => {
+  if (config == null) {
+    config = {};
+  }
+  if (typeof config !== 'object') {
+    throw Error('Config should be an object');
+  }
+  const maxPassCount = config.multipass ? 10 : 1;
+  let prevResultSize = Number.POSITIVE_INFINITY;
+  let svgjs = null;
+  const info = {};
+  if (config.path != null) {
+    info.path = config.path;
+  }
+  for (let i = 0; i < maxPassCount; i += 1) {
+    info.multipassCount = i;
+    // TODO throw this error in v3
+    try {
+      svgjs = parseSvg(input, config.path);
+    } catch (error) {
+      return { error: error.toString(), modernError: error };
+    }
+    if (svgjs.error != null) {
+      if (config.path != null) {
+        svgjs.path = config.path;
+      }
+      return svgjs;
+    }
+    const plugins = config.plugins || defaultPlugins;
+    if (Array.isArray(plugins) === false) {
+      throw Error(
+        "Invalid plugins list. Provided 'plugins' in config should be an array."
+      );
+    }
+    const resolvedPlugins = plugins.map(resolvePluginConfig);
+    const globalOverrides = {};
+    if (config.floatPrecision != null) {
+      globalOverrides.floatPrecision = config.floatPrecision;
+    }
+    svgjs = invokePlugins(svgjs, info, resolvedPlugins, null, globalOverrides);
+    svgjs = stringifySvg(svgjs, config.js2svg);
+    if (svgjs.data.length < prevResultSize) {
+      input = svgjs.data;
+      prevResultSize = svgjs.data.length;
+    } else {
+      if (config.datauri) {
+        svgjs.data = encodeSVGDatauri(svgjs.data, config.datauri);
+      }
+      if (config.path != null) {
+        svgjs.path = config.path;
+      }
+      return svgjs;
+    }
+  }
+  return svgjs;
+};
+exports.optimize = optimize;
+
+/**
+ * The factory that creates a content item with the helper methods.
+ *
+ * @param {Object} data which is passed to jsAPI constructor
+ * @returns {JSAPI} content item
+ */
+const createContentItem = (data) => {
+  return new JSAPI(data);
+};
+exports.createContentItem = createContentItem;

package/lib/types.ts

@@ -0,0 +1,172 @@
+export type XastDoctype = {
+  type: 'doctype';
+  name: string;
+  data: {
+    doctype: string;
+  };
+};
+
+export type XastInstruction = {
+  type: 'instruction';
+  name: string;
+  value: string;
+};
+
+export type XastComment = {
+  type: 'comment';
+  value: string;
+};
+
+export type XastCdata = {
+  type: 'cdata';
+  value: string;
+};
+
+export type XastText = {
+  type: 'text';
+  value: string;
+};
+
+export type XastElement = {
+  type: 'element';
+  name: string;
+  attributes: Record<string, string>;
+  children: Array<XastChild>;
+};
+
+export type XastChild =
+  | XastDoctype
+  | XastInstruction
+  | XastComment
+  | XastCdata
+  | XastText
+  | XastElement;
+
+export type XastRoot = {
+  type: 'root';
+  children: Array<XastChild>;
+};
+
+export type XastParent = XastRoot | XastElement;
+
+export type XastNode = XastRoot | XastChild;
+
+export type StringifyOptions = {
+  doctypeStart?: string;
+  doctypeEnd?: string;
+  procInstStart?: string;
+  procInstEnd?: string;
+  tagOpenStart?: string;
+  tagOpenEnd?: string;
+  tagCloseStart?: string;
+  tagCloseEnd?: string;
+  tagShortStart?: string;
+  tagShortEnd?: string;
+  attrStart?: string;
+  attrEnd?: string;
+  commentStart?: string;
+  commentEnd?: string;
+  cdataStart?: string;
+  cdataEnd?: string;
+  textStart?: string;
+  textEnd?: string;
+  indent?: number | string;
+  regEntities?: RegExp;
+  regValEntities?: RegExp;
+  encodeEntity?: (char: string) => string;
+  pretty?: boolean;
+  useShortTags?: boolean;
+  eol?: 'lf' | 'crlf';
+  finalNewline?: boolean;
+};
+
+type VisitorNode<Node> = {
+  enter?: (node: Node, parentNode: XastParent) => void | symbol;
+  exit?: (node: Node, parentNode: XastParent) => void;
+};
+
+type VisitorRoot = {
+  enter?: (node: XastRoot, parentNode: null) => void;
+  exit?: (node: XastRoot, parentNode: null) => void;
+};
+
+export type Visitor = {
+  doctype?: VisitorNode<XastDoctype>;
+  instruction?: VisitorNode<XastInstruction>;
+  comment?: VisitorNode<XastComment>;
+  cdata?: VisitorNode<XastCdata>;
+  text?: VisitorNode<XastText>;
+  element?: VisitorNode<XastElement>;
+  root?: VisitorRoot;
+};
+
+export type PluginInfo = {
+  path?: string;
+  multipassCount: number;
+};
+
+export type Plugin<Params> = (
+  root: XastRoot,
+  params: Params,
+  info: PluginInfo
+) => null | Visitor;
+
+export type Specificity = [number, number, number, number];
+
+export type StylesheetDeclaration = {
+  name: string;
+  value: string;
+  important: boolean;
+};
+
+export type StylesheetRule = {
+  dynamic: boolean;
+  selectors: string;
+  specificity: Specificity;
+  declarations: Array<StylesheetDeclaration>;
+};
+
+export type Stylesheet = {
+  rules: Array<StylesheetRule>;
+  parents: Map<XastElement, XastParent>;
+};
+
+type StaticStyle = {
+  type: 'static';
+  inherited: boolean;
+  value: string;
+};
+
+type DynamicStyle = {
+  type: 'dynamic';
+  inherited: boolean;
+};
+
+export type ComputedStyles = Record<string, StaticStyle | DynamicStyle>;
+
+export type PathDataCommand =
+  | 'M'
+  | 'm'
+  | 'Z'
+  | 'z'
+  | 'L'
+  | 'l'
+  | 'H'
+  | 'h'
+  | 'V'
+  | 'v'
+  | 'C'
+  | 'c'
+  | 'S'
+  | 's'
+  | 'Q'
+  | 'q'
+  | 'T'
+  | 't'
+  | 'A'
+  | 'a';
+
+export type PathDataItem = {
+  command: PathDataCommand;
+  args: Array<number>;
+};

package/lib/xast.js

@@ -0,0 +1,102 @@
+'use strict';
+
+/**
+ * @typedef {import('./types').XastNode} XastNode
+ * @typedef {import('./types').XastChild} XastChild
+ * @typedef {import('./types').XastParent} XastParent
+ * @typedef {import('./types').Visitor} Visitor
+ */
+
+const { selectAll, selectOne, is } = require('css-select');
+const xastAdaptor = require('./svgo/css-select-adapter.js');
+
+const cssSelectOptions = {
+  xmlMode: true,
+  adapter: xastAdaptor,
+};
+
+/**
+ * @type {(node: XastNode, selector: string) => Array<XastChild>}
+ */
+const querySelectorAll = (node, selector) => {
+  return selectAll(selector, node, cssSelectOptions);
+};
+exports.querySelectorAll = querySelectorAll;
+
+/**
+ * @type {(node: XastNode, selector: string) => null | XastChild}
+ */
+const querySelector = (node, selector) => {
+  return selectOne(selector, node, cssSelectOptions);
+};
+exports.querySelector = querySelector;
+
+/**
+ * @type {(node: XastChild, selector: string) => boolean}
+ */
+const matches = (node, selector) => {
+  return is(node, selector, cssSelectOptions);
+};
+exports.matches = matches;
+
+/**
+ * @type {(node: XastChild, name: string) => null | XastChild}
+ */
+const closestByName = (node, name) => {
+  let currentNode = node;
+  while (currentNode) {
+    if (currentNode.type === 'element' && currentNode.name === name) {
+      return currentNode;
+    }
+    // @ts-ignore parentNode is hidden from public usage
+    currentNode = currentNode.parentNode;
+  }
+  return null;
+};
+exports.closestByName = closestByName;
+
+const visitSkip = Symbol();
+exports.visitSkip = visitSkip;
+
+/**
+ * @type {(node: XastNode, visitor: Visitor, parentNode?: any) => void}
+ */
+const visit = (node, visitor, parentNode) => {
+  const callbacks = visitor[node.type];
+  if (callbacks && callbacks.enter) {
+    // @ts-ignore hard to infer
+    const symbol = callbacks.enter(node, parentNode);
+    if (symbol === visitSkip) {
+      return;
+    }
+  }
+  // visit root children
+  if (node.type === 'root') {
+    // copy children array to not loose cursor when children is spliced
+    for (const child of node.children) {
+      visit(child, visitor, node);
+    }
+  }
+  // visit element children if still attached to parent
+  if (node.type === 'element') {
+    if (parentNode.children.includes(node)) {
+      for (const child of node.children) {
+        visit(child, visitor, node);
+      }
+    }
+  }
+  if (callbacks && callbacks.exit) {
+    // @ts-ignore hard to infer
+    callbacks.exit(node, parentNode);
+  }
+};
+exports.visit = visit;
+
+/**
+ * @type {(node: XastChild, parentNode: XastParent) => void}
+ */
+const detachNodeFromParent = (node, parentNode) => {
+  // avoid splice to not break for loops
+  parentNode.children = parentNode.children.filter((child) => child !== node);
+};
+exports.detachNodeFromParent = detachNodeFromParent;

package/package.json

@@ -0,0 +1,130 @@
+{
+  "packageManager": "yarn@2.4.3",
+  "name": "svgo-v2",
+  "version": "2.8.0",
+  "description": "将css-tree替换为css-tree-v2",
+  "license": "MIT",
+  "keywords": [
+    "svgo",
+    "svg",
+    "optimize",
+    "minify"
+  ],
+  "homepage": "https://github.com/svg/svgo",
+  "bugs": {
+    "url": "https://github.com/svg/svgo/issues"
+  },
+  "author": {
+    "name": "Kir Belevich",
+    "email": "kir@belevi.ch",
+    "url": "https://github.com/deepsweet"
+  },
+  "contributors": [
+    {
+      "name": "Sergey Belov",
+      "email": "peimei@ya.ru",
+      "url": "https://github.com/arikon"
+    },
+    {
+      "name": "Lev Solntsev",
+      "email": "lev.sun@ya.ru",
+      "url": "https://github.com/GreLI"
+    },
+    {
+      "name": "Bogdan Chadkin",
+      "email": "trysound@yandex.ru",
+      "url": "https://github.com/TrySound"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/svg/svgo.git"
+  },
+  "main": "./lib/svgo-node.js",
+  "bin": "./bin/svgo",
+  "files": [
+    "bin",
+    "lib",
+    "plugins",
+    "dist",
+    "!**/*.test.js"
+  ],
+  "engines": {
+    "node": ">=10.13.0"
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --maxWorkers=4 --coverage",
+    "lint": "eslint --ignore-path .gitignore . && prettier --check \"**/*.js\" --ignore-path .gitignore",
+    "fix": "eslint --ignore-path .gitignore --fix . && prettier --write \"**/*.js\" --ignore-path .gitignore",
+    "typecheck": "tsc",
+    "test-browser": "rollup -c && node ./test/browser.js",
+    "test-regression": "node ./test/regression-extract.js && NO_DIFF=1 node ./test/regression.js"
+  },
+  "prettier": {
+    "singleQuote": true
+  },
+  "eslintConfig": {
+    "parserOptions": {
+      "ecmaVersion": "2021"
+    },
+    "env": {
+      "node": true,
+      "es2021": true
+    },
+    "extends": [
+      "eslint:recommended"
+    ],
+    "overrides": [
+      {
+        "files": [
+          "rollup.config.js"
+        ],
+        "parserOptions": {
+          "sourceType": "module"
+        }
+      },
+      {
+        "files": [
+          "**/*.test.js"
+        ],
+        "env": {
+          "jest": true
+        }
+      }
+    ]
+  },
+  "jest": {
+    "coveragePathIgnorePatterns": [
+      "fixtures"
+    ]
+  },
+  "dependencies": {
+    "@trysound/sax": "0.2.0",
+    "commander": "^7.2.0",
+    "css-select": "^4.1.3",
+    "css-tree-v2": "^1.1.3",
+    "csso": "^4.2.0",
+    "picocolors": "^1.0.0",
+    "stable": "^0.1.8"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^20.0.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.0.4",
+    "@types/css-tree": "^1.0.6",
+    "@types/csso": "^4.2.0",
+    "@types/jest": "^27.0.1",
+    "del": "^6.0.0",
+    "eslint": "^7.32.0",
+    "jest": "^27.2.5",
+    "node-fetch": "^2.6.2",
+    "pixelmatch": "^5.2.1",
+    "playwright": "^1.14.1",
+    "pngjs": "^6.0.0",
+    "prettier": "^2.4.0",
+    "rollup": "^2.56.3",
+    "rollup-plugin-terser": "^7.0.2",
+    "tar-stream": "^2.2.0",
+    "typescript": "^4.4.3"
+  }
+}