{ "manifest": { "packageManager": "yarn@2.4.3", "name": "svgo", "version": "2.8.0", "description": "Nodejs-based tool for optimizing SVG vector graphics files", "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": { "svgo": "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", "prepublishOnly": "rm -rf dist && rollup -c" }, "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": "^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" }, "_registry": "npm", "_loc": "/homez.1033/heliovt/.cache/yarn/v6/npm-svgo-2.8.0-4ff80cce6710dc2795f0c7c74101e6764cfccd24-integrity/node_modules/svgo/package.json", "readmeFilename": "README.md", "readme": "
\n \"SVGO\n
\n\n## SVGO [![npm version](https://img.shields.io/npm/v/svgo)](https://npmjs.org/package/svgo) [![Discord](https://img.shields.io/discord/815166721315831868)](https://discord.gg/z8jX8NYxrE)\n\n**SVG O**ptimizer is a Node.js-based tool for optimizing SVG vector graphics files.\n\n## Why?\n\nSVG files, especially those exported from various editors, usually contain a lot of redundant and useless information. This can include editor metadata, comments, hidden elements, default or non-optimal values and other stuff that can be safely removed or converted without affecting the SVG rendering result.\n\n## Installation\n\n```sh\nnpm -g install svgo\n```\n\nor\n\n```sh\nyarn global add svgo\n```\n\n## CLI usage\n\n```sh\nsvgo one.svg two.svg -o one.min.svg two.min.svg\n```\n\nOr use the `--folder`/`-f` flag to optimize a whole folder of SVG icons\n\n```sh\nsvgo -f ./path/to/folder/with/svg/files -o ./path/to/folder/with/svg/output\n```\n\nSee help for advanced usage\n\n```sh\nsvgo --help\n```\n\n## Configuration\n\nSome options can be configured with CLI though it may be easier to have the configuration in a separate file.\nSVGO automatically loads configuration from `svgo.config.js` or module specified with `--config` flag.\n\n```js\nmodule.exports = {\n multipass: true, // boolean. false by default\n datauri: 'enc', // 'base64', 'enc' or 'unenc'. 'base64' by default\n js2svg: {\n indent: 2, // string with spaces or number of spaces. 4 by default\n pretty: true, // boolean, false by default\n },\n};\n```\n\nSVGO has a plugin-based architecture, so almost every optimization is a separate plugin.\nThere is a set of [built-in plugins](#built-in-plugins). See how to configure them:\n\n```js\nmodule.exports = {\n plugins: [\n // enable a built-in plugin by name\n 'prefixIds',\n\n // or by expanded version\n {\n name: 'prefixIds',\n },\n\n // some plugins allow/require to pass options\n {\n name: 'prefixIds',\n params: {\n prefix: 'my-prefix',\n },\n },\n ],\n};\n```\n\nThe default preset of plugins is fully overridden if the `plugins` field is specified.\nUse `preset-default` plugin to customize plugins options.\n\n```js\nmodule.exports = {\n plugins: [\n {\n name: 'preset-default',\n params: {\n overrides: {\n // customize options for plugins included in preset\n inlineStyles: {\n onlyMatchedOnce: false,\n },\n\n // or disable plugins\n removeDoctype: false,\n },\n },\n },\n\n // enable builtin plugin not included in default preset\n 'prefixIds',\n\n // enable and configure builtin plugin not included in preset\n {\n name: 'sortAttrs',\n params: {\n xmlnsOrder: 'alphabetical',\n },\n },\n ],\n};\n```\n\nDefault preset includes the following list of plugins:\n\n- removeDoctype\n- removeXMLProcInst\n- removeComments\n- removeMetadata\n- removeEditorsNSData\n- cleanupAttrs\n- mergeStyles\n- inlineStyles\n- minifyStyles\n- cleanupIDs\n- removeUselessDefs\n- cleanupNumericValues\n- convertColors\n- removeUnknownsAndDefaults\n- removeNonInheritableGroupAttrs\n- removeUselessStrokeAndFill\n- removeViewBox\n- cleanupEnableBackground\n- removeHiddenElems\n- removeEmptyText\n- convertShapeToPath\n- convertEllipseToCircle\n- moveElemsAttrsToGroup\n- moveGroupAttrsToElems\n- collapseGroups\n- convertPathData\n- convertTransform\n- removeEmptyAttrs\n- removeEmptyContainers\n- mergePaths\n- removeUnusedNS\n- sortDefsChildren\n- removeTitle\n- removeDesc\n\nIt's also possible to specify a custom plugin:\n\n```js\nconst anotherCustomPlugin = require('./another-custom-plugin.js');\nmodule.exports = {\n plugins: [\n {\n name: 'customPluginName',\n type: 'perItem', // 'perItem', 'perItemReverse' or 'full'\n params: {\n optionName: 'optionValue',\n },\n fn: (ast, params, info) => {},\n },\n anotherCustomPlugin,\n ],\n};\n```\n\n## API usage\n\nSVGO provides a few low level utilities.\n\n### optimize\n\nThe core of SVGO is `optimize` function.\n\n```js\nconst { optimize } = require('svgo');\nconst result = optimize(svgString, {\n // optional but recommended field\n path: 'path-to.svg',\n // all config fields are also available here\n multipass: true,\n});\nconst optimizedSvgString = result.data;\n```\n\n### loadConfig\n\nIf you write a tool on top of SVGO you might need a way to load SVGO config.\n\n```js\nconst { loadConfig } = require('svgo');\nconst config = await loadConfig();\n\n// you can also specify a relative or absolute path and customize the current working directory\nconst config = await loadConfig(configFile, cwd);\n```\n\n## Built-in plugins\n\n| Plugin | Description | Default |\n| ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |\n| [cleanupAttrs](https://github.com/svg/svgo/blob/master/plugins/cleanupAttrs.js) | cleanup attributes from newlines, trailing, and repeating spaces | `enabled` |\n| [mergeStyles](https://github.com/svg/svgo/blob/master/plugins/mergeStyles.js) | merge multiple style elements into one | `enabled` |\n| [inlineStyles](https://github.com/svg/svgo/blob/master/plugins/inlineStyles.js) | move and merge styles from `