Merge branch 'master' of https://github.com/svg/svgo into tests-multi…

…pass
svg · Feb 14, 2021 · b43238b · b43238b
2 parents fb4dd6b + cb14e3c
commit b43238b
Show file tree

Hide file tree

Showing 21 changed files with 4,887 additions and 1,925 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,27 @@
+name: CI
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  test:
+    name: Node.js ${{ matrix.node-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - 15
+          - 14
+          - 12
+          - 10
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test
diff --git a/.gitignore b/.gitignore
@@ -1,11 +1,6 @@
 node_modules/
-lib-cov/
-html-report/
-lcov.info
+.nyc_output
+coverage
 bin/svgo-profiling
-*.sublime-*
-*.log
 .DS_Store
-.idea
-.vscode
-.npmrc
+*.log
diff --git a/.travis.yml b/.travis.yml
diff --git a/LICENSE b/LICENSE
@@ -1,55 +1,21 @@
-The MIT License
-
-Copyright © 2012–2016 Kir Belevich
-
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
-
-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-Лицензия MIT
-
-Copyright © 2012–2016 Кир Белевич
-
-Данная лицензия разрешает лицам, получившим копию данного
-программного обеспечения и сопутствующей документации
-(в дальнейшем именуемыми «Программное Обеспечение»), безвозмездно
-использовать Программное Обеспечение без ограничений, включая
-неограниченное право на использование, копирование, изменение,
-добавление, публикацию, распространение, сублицензирование
-и/или продажу копий Программного Обеспечения, также как и лицам,
-которым предоставляется данное Программное Обеспечение,
-при соблюдении следующих условий:
-
-Указанное выше уведомление об авторском праве и данные условия
-должны быть включены во все копии или значимые части данного
-Программного Обеспечения.
-
-ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ»,
-БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ,
-ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ ГАРАНТИЯМИ ТОВАРНОЙ ПРИГОДНОСТИ,
-СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ
-ПРАВ. НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ
-ОТВЕТСТВЕННОСТИ ПО ИСКАМ О ВОЗМЕЩЕНИИ УЩЕРБА, УБЫТКОВ ИЛИ ДРУГИХ
-ТРЕБОВАНИЙ ПО ДЕЙСТВУЮЩИМ КОНТРАКТАМ, ДЕЛИКТАМ ИЛИ ИНОМУ,
-ВОЗНИКШИМ ИЗ, ИМЕЮЩИМ ПРИЧИНОЙ ИЛИ СВЯЗАННЫМ С ПРОГРАММНЫМ
-ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
-ИЛИ ИНЫМИ ДЕЙСТВИЯМИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.
+MIT License
+
+Copyright (c) Kir Belevich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -121,6 +121,7 @@ Arguments:
     ```sh
     $ svgo *.svg
     ```
+    Windows does not support glob expansion. The command above will not work on Windows. 
 
     ```sh
     $ svgo test.svg -o test.min.svg

diff --git a/bin/svgo b/bin/svgo
@@ -1,3 +1,6 @@
 #!/usr/bin/env node
 
-require('../lib/svgo/coa').run();
+const { program } = require('commander');
+const makeProgram = require('../lib/svgo/coa');
+makeProgram(program);
+program.parseAsync(process.argv);
diff --git a/examples/test.js b/examples/test.js
@@ -82,20 +82,18 @@ FS.readFile(filepath, 'utf8', function(err, data) {
         throw err;
     }
 
-    svgo.optimize(data, {path: filepath}).then(function(result) {
+    const result = svgo.optimize(data, {path: filepath});
 
-        console.log(result);
+    console.log(result);
 
-        // {
-        //     // optimized SVG data string
-        //     data: '<svg width="10" height="20">test</svg>'
-        //     // additional info such as width/height
-        //     info: {
-        //         width: '10',
-        //         height: '20'
-        //     }
-        // }
-
-    });
+    // {
+    //     // optimized SVG data string
+    //     data: '<svg width="10" height="20">test</svg>'
+    //     // additional info such as width/height
+    //     info: {
+    //         width: '10',
+    //         height: '20'
+    //     }
+    // }
 
 });
diff --git a/lib/svgo.js b/lib/svgo.js
@@ -1,89 +1,72 @@
-'use strict';
-
-/**
- * SVGO is a Nodejs-based tool for optimizing SVG vector graphics files.
- *
- * @see https://github.com/svg/svgo
- *
- * @author Kir Belevich <kir@soulshine.in> (https://github.com/deepsweet)
- * @copyright © 2012 Kir Belevich
- * @license MIT https://raw.githubusercontent.com/svg/svgo/master/LICENSE
- */
-
-var CONFIG = require('./svgo/config.js'),
-    SVG2JS = require('./svgo/svg2js.js'),
-    PLUGINS = require('./svgo/plugins.js'),
-    JSAPI = require('./svgo/jsAPI.js'),
-    encodeSVGDatauri = require('./svgo/tools.js').encodeSVGDatauri,
-    JS2SVG = require('./svgo/js2svg.js');
-
-var SVGO = function(config) {
-    this.config = CONFIG(config);
-};
-
-SVGO.prototype.optimize = function(svgstr, info) {
-    info = info || {};
-    return new Promise((resolve, reject) => {
-        if (this.config.error) {
-            reject(this.config.error);
-            return;
-        }
-
-        var config = this.config,
-            maxPassCount = config.multipass ? 10 : 1,
-            counter = 0,
-            prevResultSize = Number.POSITIVE_INFINITY,
-            optimizeOnceCallback = (svgjs) => {
-                if (svgjs.error) {
-                    reject(svgjs.error);
-                    return;
-                }
-
-                if ((info.multipassCount = ++counter) < maxPassCount && svgjs.data.length < prevResultSize) {
-                    prevResultSize = svgjs.data.length;
-                    this._optimizeOnce(svgjs.data, info, optimizeOnceCallback);
-                } else {
-                    if (config.datauri) {
-                        svgjs.data = encodeSVGDatauri(svgjs.data, config.datauri);
-                    }
-                    if (info && info.path) {
-                        svgjs.path = info.path;
-                    }
-                    resolve(svgjs);
-                }
-            };
-
-        this._optimizeOnce(svgstr, info, optimizeOnceCallback);
-    });
-};
-
-SVGO.prototype._optimizeOnce = function(svgstr, info, callback) {
-    var config = this.config;
-
-    SVG2JS(svgstr, function(svgjs) {
-        if (svgjs.error) {
-            callback(svgjs);
-            return;
-        }
-
-        svgjs = PLUGINS(svgjs, info, config.plugins);
-
-        callback(JS2SVG(svgjs, config.js2svg));
-    });
-};
-
-/**
- * The factory that creates a content item with the helper methods.
- *
- * @param {Object} data which is passed to jsAPI constructor
- * @returns {JSAPI} content item
- */
-SVGO.prototype.createContentItem = function(data) {
-    return new JSAPI(data);
-};
-
-SVGO.Config = CONFIG;
-
-module.exports = SVGO;
-// Offer ES module interop compatibility.
-module.exports.default = SVGO;
+'use strict';
+
+/**
+ * SVGO is a Nodejs-based tool for optimizing SVG vector graphics files.
+ *
+ * @see https://github.com/svg/svgo
+ *
+ * @author Kir Belevich <kir@soulshine.in> (https://github.com/deepsweet)
+ * @copyright © 2012 Kir Belevich
+ * @license MIT https://raw.githubusercontent.com/svg/svgo/master/LICENSE
+ */
+
+var CONFIG = require('./svgo/config.js'),
+    SVG2JS = require('./svgo/svg2js.js'),
+    PLUGINS = require('./svgo/plugins.js'),
+    JSAPI = require('./svgo/jsAPI.js'),
+    encodeSVGDatauri = require('./svgo/tools.js').encodeSVGDatauri,
+    JS2SVG = require('./svgo/js2svg.js');
+
+var SVGO = function(config) {
+    this.config = CONFIG(config);
+};
+
+SVGO.prototype.optimize = function(svgstr, info = {}) {
+    const config = this.config;
+    if (config.error) {
+        throw Error(config.error);
+    }
+    const maxPassCount = config.multipass ? 10 : 1;
+    let prevResultSize = Number.POSITIVE_INFINITY;
+    let svgjs = null;
+	info.multipassCount = 0;
+    for (let i = 0; i < maxPassCount; i += 1) {
+        svgjs = SVG2JS(svgstr);
+        if (svgjs.error == null) {
+            svgjs = PLUGINS(svgjs, info, config.plugins);
+        }
+        svgjs = JS2SVG(svgjs, config.js2svg);
+        if (svgjs.error) {
+            throw Error(svgjs.error);
+        }
+        info.multipassCount = i;
+        if (svgjs.data.length < prevResultSize) {
+            prevResultSize = svgjs.data.length
+        } else {
+            if (config.datauri) {
+                svgjs.data = encodeSVGDatauri(svgjs.data, config.datauri);
+            }
+            if (info && info.path) {
+                svgjs.path = info.path;
+            }
+            return svgjs;
+        }
+    }
+    return svgjs;
+};
+
+/**
+ * The factory that creates a content item with the helper methods.
+ *
+ * @param {Object} data which is passed to jsAPI constructor
+ * @returns {JSAPI} content item
+ */
+SVGO.prototype.createContentItem = function(data) {
+    return new JSAPI(data);
+};
+
+SVGO.Config = CONFIG;
+
+module.exports = SVGO;
+// Offer ES module interop compatibility.
+module.exports.default = SVGO;