remark-inline-svg-flex 0.3.7 → 0.3.9

package/.github/workflows/release.yml

@@ -6,6 +6,8 @@ on:
       - main
     paths:
       - package.json
+      - src/**
+      - .github/workflows/**
 
 jobs:
   release:
@@ -43,6 +45,7 @@ jobs:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: |
           npm ci
+          npm run tests
           npm run build
           git config user.name "github-actions"
           git config user.email "github-actions@github.com"

package/README.md

@@ -6,7 +6,7 @@
 [![version](https://img.shields.io/npm/v/remark-inline-svg-flex.svg?style=flat-square)](https://www.npmjs.com/package/remark-inline-svg-flex)
 [![MIT License](https://img.shields.io/npm/l/remark-inline-svg-flex.svg?style=flat-square)](https://github.com/gass-git/remark-inline-svg-flex/blob/main/LICENSE)
 
-Flexible Remark plugin that inlines and optimizes SVGs with SVGO, featuring customizable path resolution, wrappers and others.
+Flexible Remark plugin that inlines and optimizes SVGs with SVGO, featuring customizable path resolution, HTML wrappers and more.
 
 - [remark-inline-svg-flex](#remark-inline-svg-flex)
   - [Features](#features)
@@ -24,7 +24,7 @@ Flexible Remark plugin that inlines and optimizes SVGs with SVGO, featuring cust
 ### ✔️ Robust and customizable path resolution
 
 - If the SVG path is absolute, it is used as-is.
-- If the path is relative and assetsDir is defined, it is resolved relative to that directory.
+- If the path is relative and `assetsDir` is defined, it is resolved relative to the `assetsDir` directory.
 - Otherwise, the path is resolved relative to the Markdown file’s location.
 
 ### ✔️ Custom HTML wrapper support
@@ -61,21 +61,19 @@ This is a test markdown document.
 ![some svg](some.svg)
 ```
 
-And our module `example.js` looks as the one below. It is recommended to pass
-the markdown directory path to `process()` so that the plugin can resolve relative
-paths correctly.
+And our module `example.js` looks as the one below (it is recommended to pass the markdown directory `path` to `process()` so that the plugin can resolve relative paths correctly).
 
 ```js
 import { remark } from 'remark';
 import { readFile } from 'node:fs/promises';
 import { remarkInlineSvg } from 'remark-inline-svg-flex';
 
-const markdown = await readFile(_path, { encoding: 'utf8' });
+const markdown = await readFile(path, { encoding: 'utf8' });
 
 return await remark()
   .use(remarkParse)
   .use(remarkInlineSvg)
-  .process({ value: markdown, path: _path });
+  .process({ value: markdown, path: path });
 ```
 
 Now running `node example.js` yields:
@@ -86,7 +84,9 @@ Now running `node example.js` yields:
 This is a test markdown document.
 
 <figure class="inline-svg">
-  <svg fill="none" viewBox="0 0 250 250" role="img" aria-hidden="true"><circle cx="125" cy="125" r="100" fill="#BA5B5B"/></svg>
+  <svg width="800" height="800" fill="none" viewBox="0 0 16 16">
+  ...
+  </svg>
 </figure>
 ```
 
@@ -124,6 +124,8 @@ The SVG's are optimized by default. Disable it by setting it to `false`.
 
 ## SVGO configuration
 
+SVGO is configured to use the [default preset](https://svgo.dev/docs/preset-default/) of plugins and the [removeXMLNS](https://svgo.dev/docs/plugins/removeXMLNS/) plugin.
+
 ```
 { plugins: ['preset-default', 'removeXMLNS'] }
 ```

package/dist/cjs/plugin.js

@@ -26,12 +26,14 @@ const remarkInlineSvg = (consumerOptions = {}) => {
             if (!node.url?.endsWith(options.suffix) || !parent)
                 return;
             try {
-                const svgPath = resolvePath(options.assetsDir, node, node_path_1.default.dirname(file.history[0]));
+                const svgPath = resolvePath(options.assetsDir, node, file.history[0] && node_path_1.default.dirname(file.history[0]));
                 const svgString = processSvg(svgPath, options.svgo);
-                parent.children[i] = {
-                    type: 'html',
-                    value: options.wrapper ? wrap(svgString, options.wrapper) : svgString,
-                };
+                if (typeof i === 'number') {
+                    parent.children[i] = {
+                        type: 'html',
+                        value: options.wrapper ? wrap(svgString, options.wrapper) : svgString,
+                    };
+                }
             }
             catch (error) {
                 console.warn(error);

package/dist/plugin.js

@@ -24,12 +24,14 @@ const remarkInlineSvg = (consumerOptions = {}) => {
             if (!node.url?.endsWith(options.suffix) || !parent)
                 return;
             try {
-                const svgPath = resolvePath(options.assetsDir, node, path.dirname(file.history[0]));
+                const svgPath = resolvePath(options.assetsDir, node, file.history[0] && path.dirname(file.history[0]));
                 const svgString = processSvg(svgPath, options.svgo);
-                parent.children[i] = {
-                    type: 'html',
-                    value: options.wrapper ? wrap(svgString, options.wrapper) : svgString,
-                };
+                if (typeof i === 'number') {
+                    parent.children[i] = {
+                        type: 'html',
+                        value: options.wrapper ? wrap(svgString, options.wrapper) : svgString,
+                    };
+                }
             }
             catch (error) {
                 console.warn(error);

package/package.json

@@ -1,19 +1,16 @@
 {
   "name": "remark-inline-svg-flex",
-  "version": "0.3.7",
-  "description": "Flexible Remark plugin that inlines and optimizes SVGs with SVGO, featuring customizable path resolution and wrappers.",
+  "version": "0.3.9",
+  "description": "Customizable Remark plugin to inline and optimize SVGs with SVGO, with robust path resolution.",
   "keywords": [
-    "unified",
-    "rehype",
-    "plugin",
-    "rehype-plugin",
+    "remark",
     "inline",
     "svg",
+    "svgo",
     "image",
     "img",
     "html"
   ],
-  "homepage": "https://github.com/gass-git/remark-inline-svg-flex#readme",
   "bugs": {
     "url": "https://github.com/gass-git/remark-inline-svg-flex/issues"
   },
@@ -26,12 +23,12 @@
   "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/types.d.ts",
   "exports": {
     ".": {
       "import": "./dist/index.js",
       "require": "./dist/cjs/index.js",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/types.d.ts"
     }
   },
   "scripts": {
@@ -48,11 +45,11 @@
     "rimraf": "^6.1.3",
     "typescript": "^5.9.3",
     "unified": "^11.0.5",
+    "vfile": "^6.0.3",
     "vitest": "^4.1.0"
   },
   "dependencies": {
     "svgo": "^4.0.1",
-    "unist-util-visit": "^5.1.0",
-    "vfile": "^6.0.3"
+    "unist-util-visit": "^5.1.0"
   }
 }