build: Add 'svgo', SVG minifier script and unify SVGO rules

Adds: - npm run svgmin - .svgo.yaml: unified SVGO rules from Wikimedia coding conventions Bug: T247004 Change-Id: I7017ecfebb811fa8d626747a830ad000774bbf2f
2024-11-23 23:33:54 +00:00 · 2020-03-06 00:25:05 +01:00 · 2020-03-06 00:25:05 +01:00 · b9968d9d93
parent ecfd7a2b28
commit b9968d9d93
3 changed files with 150 additions and 2 deletions
--- a/.svgo.yml
+++ b/.svgo.yml
@ -0,0 +1,27 @@
+# Recommended options from:
+# https://www.mediawiki.org/wiki/Manual:Coding_conventions/SVG#Exemplified_safe_configuration
+#
+multipass: true
+plugins:
+  - cleanupIDs: false
+  - removeDesc: false
+  - removeRasterImages: true
+  - removeTitle: false
+  - removeViewBox: false
+  # If the SVG doesn't start with an XML declaration, then its MIME type will
+  # be detected as "text/plain" rather than "image/svg+xml" by libmagic and,
+  # consequently, MediaWiki's CSSMin CSS minifier. libmagic's default database
+  # currently requires that SVGs contain an XML declaration:
+  # https://github.com/threatstack/libmagic/blob/master/magic/Magdir/sgml#L5
+  - removeXMLProcInst: false
+  - sortAttrs: true
+
+# Configure the indent (default 4 spaces) used by `--pretty` here:
+# @see https://github.com/svg/svgo/blob/master/lib/svgo/js2svg.js#L6 for more config options
+#
+# Unfortunately EOL cannot be configured, svgo uses the platform's EOL marker.
+# On non-unix systems the linebreaks will be normalized to LF (unix) only at git commit, assuming `core.autocrlf` is 'true' (default) or 'input'.
+#
+js2svg:
+  pretty: true
+  indent: "\t"
--- a/package-lock.json
+++ b/package-lock.json
@ -1506,6 +1506,12 @@
 			"integrity": "sha512-KfRL3PuHmqQLOG+2tGpRO26Ctg+Cq1E01D2DMriKEATHgWLfeNDmq9e29Q9WIky0dQ3NPkd1mzYH8Lm936Z9qw==",
 			"dev": true
 		},
+		"@types/q": {
+			"version": "1.5.2",
+			"resolved": "https://registry.npmjs.org/@types/q/-/q-1.5.2.tgz",
+			"integrity": "sha512-ce5d3q03Ex0sy4R14722Rmt6MT07Ua+k4FwDfdcToYJcMKNtRVQvJ6JCAPdAmAnbRb6CsX6aYb9m96NGod9uTw==",
+			"dev": true
+		},
 		"@types/reach__router": {
 			"version": "1.3.0",
 			"resolved": "https://registry.npmjs.org/@types/reach__router/-/reach__router-1.3.0.tgz",
@ -3399,6 +3405,17 @@
 				"is-supported-regexp-flag": "^1.0.0"
 			}
 		},
+		"coa": {
+			"version": "2.0.2",
+			"resolved": "https://registry.npmjs.org/coa/-/coa-2.0.2.tgz",
+			"integrity": "sha512-q5/jG+YQnSy4nRTV4F7lPepBJZ8qBNJJDBuJdoejDyLXgmL7IEo+Le2JDZudFTFt7mrCqIRaSjws4ygRCTCAXA==",
+			"dev": true,
+			"requires": {
+				"@types/q": "^1.5.1",
+				"chalk": "^2.4.1",
+				"q": "^1.1.2"
+			}
+		},
 		"code-point-at": {
 			"version": "1.1.0",
 			"resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz",
@ -3763,6 +3780,30 @@
 				"nth-check": "~1.0.1"
 			}
 		},
+		"css-select-base-adapter": {
+			"version": "0.1.1",
+			"resolved": "https://registry.npmjs.org/css-select-base-adapter/-/css-select-base-adapter-0.1.1.tgz",
+			"integrity": "sha512-jQVeeRG70QI08vSTwf1jHxp74JoZsr2XSgETae8/xC8ovSnL2WF87GTLO86Sbwdt2lK4Umg4HnnwMO4YF3Ce7w==",
+			"dev": true
+		},
+		"css-tree": {
+			"version": "1.0.0-alpha.37",
+			"resolved": "https://registry.npmjs.org/css-tree/-/css-tree-1.0.0-alpha.37.tgz",
+			"integrity": "sha512-DMxWJg0rnz7UgxKT0Q1HU/L9BeJI0M6ksor0OgqOnF+aRCDWg/N2641HmVyU9KVIu0OVVWOb2IpC9A+BJRnejg==",
+			"dev": true,
+			"requires": {
+				"mdn-data": "2.0.4",
+				"source-map": "^0.6.1"
+			},
+			"dependencies": {
+				"source-map": {
+					"version": "0.6.1",
+					"resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
+					"integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
+					"dev": true
+				}
+			}
+		},
 		"css-what": {
 			"version": "2.1.3",
 			"resolved": "https://registry.npmjs.org/css-what/-/css-what-2.1.3.tgz",
@ -3775,6 +3816,15 @@
 			"integrity": "sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==",
 			"dev": true
 		},
+		"csso": {
+			"version": "4.0.2",
+			"resolved": "https://registry.npmjs.org/csso/-/csso-4.0.2.tgz",
+			"integrity": "sha512-kS7/oeNVXkHWxby5tHVxlhjizRCSv8QdU7hB2FpdAibDU8FjTAolhNjKNTiLzXtUrKT6HwClE81yXwEk1309wg==",
+			"dev": true,
+			"requires": {
+				"css-tree": "1.0.0-alpha.37"
+			}
+		},
 		"csstype": {
 			"version": "2.6.9",
 			"resolved": "https://registry.npmjs.org/csstype/-/csstype-2.6.9.tgz",
@ -7852,6 +7902,12 @@
 				"unist-util-visit": "^1.1.0"
 			}
 		},
+		"mdn-data": {
+			"version": "2.0.4",
+			"resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.4.tgz",
+			"integrity": "sha512-iV3XNKw06j5Q7mi6h+9vbx23Tv7JkjEVgKHW4pimwyDGWm0OIQntJJ+u1C6mg6mK1EaTv42XQ7w76yuzH7M2cA==",
+			"dev": true
+		},
 		"mdurl": {
 			"version": "1.0.1",
 			"resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz",
@ -9306,6 +9362,12 @@
 			"integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==",
 			"dev": true
 		},
+		"q": {
+			"version": "1.5.1",
+			"resolved": "https://registry.npmjs.org/q/-/q-1.5.1.tgz",
+			"integrity": "sha1-fjL3W0E4EpHQRhHxvxQQmsAGUdc=",
+			"dev": true
+		},
 		"qs": {
 			"version": "6.9.1",
 			"resolved": "https://registry.npmjs.org/qs/-/qs-6.9.1.tgz",
@ -10285,6 +10347,12 @@
 			"integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==",
 			"dev": true
 		},
+		"sax": {
+			"version": "1.2.4",
+			"resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz",
+			"integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==",
+			"dev": true
+		},
 		"scheduler": {
 			"version": "0.18.0",
 			"resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.18.0.tgz",
@ -11918,6 +11986,57 @@
 			"integrity": "sha1-WPcc7jvVGbWdSyqEO2x95krAR2Q=",
 			"dev": true
 		},
+		"svgo": {
+			"version": "1.3.2",
+			"resolved": "https://registry.npmjs.org/svgo/-/svgo-1.3.2.tgz",
+			"integrity": "sha512-yhy/sQYxR5BkC98CY7o31VGsg014AKLEPxdfhora76l36hD9Rdy5NZA/Ocn6yayNPgSamYdtX2rFJdcv07AYVw==",
+			"dev": true,
+			"requires": {
+				"chalk": "^2.4.1",
+				"coa": "^2.0.2",
+				"css-select": "^2.0.0",
+				"css-select-base-adapter": "^0.1.1",
+				"css-tree": "1.0.0-alpha.37",
+				"csso": "^4.0.2",
+				"js-yaml": "^3.13.1",
+				"mkdirp": "~0.5.1",
+				"object.values": "^1.1.0",
+				"sax": "~1.2.4",
+				"stable": "^0.1.8",
+				"unquote": "~1.1.1",
+				"util.promisify": "~1.0.0"
+			},
+			"dependencies": {
+				"css-select": {
+					"version": "2.1.0",
+					"resolved": "https://registry.npmjs.org/css-select/-/css-select-2.1.0.tgz",
+					"integrity": "sha512-Dqk7LQKpwLoH3VovzZnkzegqNSuAziQyNZUcrdDM401iY+R5NkGBXGmtO05/yaXQziALuPogeG0b7UAgjnTJTQ==",
+					"dev": true,
+					"requires": {
+						"boolbase": "^1.0.0",
+						"css-what": "^3.2.1",
+						"domutils": "^1.7.0",
+						"nth-check": "^1.0.2"
+					}
+				},
+				"css-what": {
+					"version": "3.2.1",
+					"resolved": "https://registry.npmjs.org/css-what/-/css-what-3.2.1.tgz",
+					"integrity": "sha512-WwOrosiQTvyms+Ti5ZC5vGEK0Vod3FTt1ca+payZqvKuGJF+dq7bG63DstxtN0dpm6FxY27a/zS3Wten+gEtGw==",
+					"dev": true
+				},
+				"domutils": {
+					"version": "1.7.0",
+					"resolved": "https://registry.npmjs.org/domutils/-/domutils-1.7.0.tgz",
+					"integrity": "sha512-Lgd2XcJ/NjEw+7tFvfKxOzCYKZsdct5lczQ2ZaQY8Djz7pfAD3Gbp8ySJWtreII/vDlMVmxwa6pHmdxIYgttDg==",
+					"dev": true,
+					"requires": {
+						"dom-serializer": "0",
+						"domelementtype": "1"
+					}
+				}
+			}
+		},
 		"symbol.prototype.description": {
 			"version": "1.0.2",
 			"resolved": "https://registry.npmjs.org/symbol.prototype.description/-/symbol.prototype.description-1.0.2.tgz",
--- a/package.json
+++ b/package.json
@ -11,7 +11,8 @@

 		"doc": "jsdoc -c jsdoc.json && npm run build-storybook",
 		"storybook": "bash ./dev-scripts/setup-storybook.sh && start-storybook -p 6006",
-		"build-storybook": "bash ./dev-scripts/setup-storybook.sh && build-storybook -o docs/ui"
+		"build-storybook": "bash ./dev-scripts/setup-storybook.sh && build-storybook -o docs/ui",
+		"svgmin": "svgo --config=.svgo.yml -q -r -f resources/"
 	},
 	"devDependencies": {
 		"@babel/core": "7.7.7",
@ -25,6 +26,7 @@
 		"less-loader": "4.1.0",
 		"mustache": "3.0.1",
 		"stylelint": "10.0.1",
-		"stylelint-config-wikimedia": "0.9.0"
+		"stylelint-config-wikimedia": "0.9.0",
+		"svgo": "1.3.2"
 	}
 }