Switch to "type: module" and support latest SVGO (#9)

Author: scriptex

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Build
+name: Test
 
 on: [push, pull_request]
 
@@ -8,7 +8,7 @@ jobs:
 
         strategy:
             matrix:
-                node-version: [14.x, 16.x]
+                node-version: [lts/*]
 
         steps:
             - uses: actions/checkout@v3

.npmignore

@@ -35,5 +35,3 @@ renovate.json
 tsconfig.json
 tslint.json
 yarn.lock
-
-test

README.md

@@ -3,7 +3,7 @@
 [![Codebeat Badge](https://codebeat.co/badges/d765a4c8-2c0e-44f2-89c3-fa364fdc14e6)](https://codebeat.co/projects/github-com-scriptex-svgo-add-viewbox-master)
 [![CodeFactor Badge](https://www.codefactor.io/repository/github/scriptex/svgo-add-viewbox/badge)](https://www.codefactor.io/repository/github/scriptex/svgo-add-viewbox)
 [![DeepScan grade](https://deepscan.io/api/teams/3574/projects/5257/branches/40799/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=3574&pid=5257&bid=40799)
-[![Analytics](https://ga-beacon-361907.ew.r.appspot.com/UA-83446952-1/github.com/scriptex/svgo-add-viewbox/README.md?pixel)](https://github.com/scriptex/svgo-add-viewbox/)
+[![Analytics](https://ga-beacon.atanas.info/api/analytics?account=UA-83446952-1&page=github.com/scriptex/svgo-add-viewbox&pixel)](https://github.com/scriptex/svgo-add-viewbox/)
 
 # SVGO Add viewBox
 
@@ -26,40 +26,40 @@
 
 This plugin adds the `viewBox` attribute to your SVGs based on the `width` and `height` attributes. The difference between this plugin and the built-in [`removeDimensions`](https://github.com/svg/svgo/blob/master/plugins/removeDimensions.js) plugin is that `svgo-add-viewbox` does not remove the `width` and `height` of your SVGs.
 
-In order to use this plugin correctly, you SVGs should have their `width` and `height` attributes specified.
+In order to use this plugin correctly, your SVGs should have their `width` and `height` attributes specified.
 
 ## Usage
 
-**v2.x.x of this plugin should be used with SVGO v3 and above.**
+**v2.x.x or 3.x.x of this plugin should be used with SVGO v3 and above.**
 
 **v1.x.x of this plugin should be used with SVGO v2.**
 
 1. Create a `svgo.config.js` file following the [official configuration guide](https://github.com/svg/svgo#configuration)
 2. Use the option to specify a custom plugin.
 3. Install this module from NPM
-    ```sh
-    npm install svgo-add-viewbox --save-dev
-    # or
-    yarn add svgo-add-viewbox -D
-    ```
-4. `require` the module which you just created in your `svgo.config.js` file:
-    ```javascript
-    const addViewBox = require('svgo-add-viewbox');
-    ```
+
+```sh
+npm install svgo-add-viewbox --save-dev
+# or
+yarn add svgo-add-viewbox -D
+```
+
+4. `import` the module in your `svgo.config.js` file:
+
+```javascript
+import addViewBox from 'svgo-add-viewbox';
+```
+
 5. In the `plugins` array in your `svgo.config.js` file add the following:
-    ```javascript
-    plugins: [
-    	// ... more plugins
-    	{
-    		fn: addViewBox.fn,
-    		name: 'addViewBox',
-    		type: addViewBox.type,
-    		active: addViewBox.active,
-    		description: addViewBox.description
-    	}
-    	// ... more plugins
-    ];
-    ```
+
+```javascript
+plugins: [
+	// ... more plugins
+	addViewBox
+	// ... more plugins
+];
+```
+
 6. Execute your SVG transformation NPM script.
 
 ## LICENSE

index.js

@@ -0,0 +1,42 @@
+/**
+ * @typedef {import("svgo").CustomPlugin} SVGOPlugin
+ * @typedef {SVGOPlugin['fn']} SVGOPluginFunction
+ * @typedef {SVGOPlugin['name']} SVGOPluginName
+ * @typedef {import("svgo/lib/types").XastElement} SVGOElement
+ */
+
+/**
+ * @type {SVGOPluginName}
+ */
+const name = 'SVGOAddViewBox';
+
+/**
+ * @type {SVGOPluginFunction}
+ */
+const fn = () => ({
+	root: {
+		enter: node => {
+			const element = /** @type {SVGOElement} */ (node?.children?.[0]);
+
+			if (!element) {
+				return;
+			}
+
+			const { width, height } = element.attributes;
+
+			if (typeof width === 'undefined' || typeof height === 'undefined') {
+				return;
+			}
+
+			element.attributes.viewBox = `0 0 ${Number(width)} ${Number(height)}`;
+		}
+	}
+});
+
+/**
+ * @type {SVGOPlugin}
+ */
+export default {
+	fn,
+	name
+};

index.mjs

@@ -1,6 +1,6 @@
 {
 	"name": "svgo-add-viewbox",
-	"version": "2.0.1",
+	"version": "3.0.0",
 	"description": "SVGO plugin which adds 'viewBox' attribute based on 'width' and 'height' attributes",
 	"keywords": [
 		"viewBox",
@@ -16,14 +16,15 @@
 	"license": "MIT",
 	"author": "Atanas Atanasov <hi@atanas.info> (https://atanas.info)",
 	"funding": "https://github.com/sponsors/scriptex",
-	"main": "index.js",
+	"main": "index.mjs",
+	"type": "module",
 	"repository": {
 		"type": "git",
 		"url": "github:scriptex/svgo-add-viewbox"
 	},
 	"scripts": {
-		"svg": "svgo -f ./test/input -o ./test/output --config ./test/svgo.config.js",
-		"test": "yarn svg && tape test/index.js"
+		"svg": "svgo -f ./test/input -o ./test/output --config ./test/svgo.config.mjs",
+		"test": "yarn svg && tape test/index.mjs"
 	},
 	"dependencies": {},
 	"devDependencies": {

package.json

@@ -0,0 +1,25 @@
+import tape from 'tape';
+import { parse } from 'svg-parser';
+import { optimize, loadConfig } from 'svgo';
+
+import { resolve } from 'node:path';
+import { existsSync, readFileSync } from 'node:fs';
+
+tape('Has viewBox attribute', async t => {
+	const input = resolve('test', 'input', 'test.svg');
+	const output = resolve('test', 'output', 'test.svg');
+	const inputSVG = readFileSync(input, 'utf-8');
+	const outputSVG = readFileSync(output, 'utf-8');
+
+	const config = await loadConfig(resolve('test', 'svgo.config.mjs'));
+	const optimized = optimize(inputSVG, config).data;
+	const parsed = parse(optimized);
+	const rootNode = /** @type {svgParser.ElementNode} */ (parsed.children[0]);
+
+	t.ok(existsSync(input), 'Input file exists.');
+	t.ok(existsSync(output), 'Output file exists.');
+	t.equals(optimized, outputSVG, 'The parsed input file and saved output files match.');
+	t.ok(!!rootNode?.properties?.viewBox, 'Has viewBox attribute.');
+
+	t.end();
+});

test/index.js

@@ -0,0 +1,22 @@
+/**
+ * @typedef {Array<import('svgo').PluginConfig>} SVGOPlugins
+ */
+
+import addViewBox from '../index.mjs';
+
+export default {
+	/**
+	 * @type {SVGOPlugins}
+	 */
+	plugins: [
+		{
+			name: 'preset-default',
+			params: {
+				overrides: {
+					removeViewBox: false
+				}
+			}
+		},
+		addViewBox
+	]
+};