remark-inline-svg-flex 0.2.3 → 0.3.4

package/README.md

@@ -61,16 +61,21 @@ This is a test markdown document.
 ![some svg](some.svg)
 ```
 
-And our module `example.js` looks as follows:
+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 { inlineSvg } from 'remark-inline-svg-flex';
+import { remarkInlineSvg } from 'remark-inline-svg-flex';
 
 const markdown = await readFile(_path, { encoding: 'utf8' });
 
-return await remark().use(remarkParse).use(inlineSvg).process(markdown);
+return await remark()
+  .use(remarkParse)
+  .use(remarkInlineSvg)
+  .process({ value: markdown, path: _path });
 ```
 
 Now running `node example.js` yields:
@@ -120,5 +125,5 @@ The SVG's are optimized by default. Disable it by setting it to `false`.
 ## SVGO configuration
 
 ```
-{ plugins: ['preset-default', 'removeXMLNS', 'removeDimensions'] }
+{ plugins: ['preset-default', 'removeXMLNS'] }
 ```

package/dist/cjs/plugin.d.ts

@@ -10,5 +10,5 @@ import type { Options } from './types';
  * @param options.wrapper - Optional HTML wrapper for the inline SVG (default: `<figure class="inline-svg"></figure>`)
  * @param options.svgo - Whether to optimize SVG using SVGO (default: true)
  */
-declare const inlineSvg: Plugin<[Options?], Root, Root>;
-export { inlineSvg };
+declare const remarkInlineSvg: Plugin<[Options?], Root, Root>;
+export { remarkInlineSvg };

package/dist/cjs/plugin.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.inlineSvg = void 0;
+exports.remarkInlineSvg = void 0;
 const node_path_1 = require("node:path");
 const node_fs_1 = require("node:fs");
 const unist_util_visit_1 = require("unist-util-visit");
@@ -14,7 +14,7 @@ const svgo_1 = require("svgo");
  * @param options.wrapper - Optional HTML wrapper for the inline SVG (default: `<figure class="inline-svg"></figure>`)
  * @param options.svgo - Whether to optimize SVG using SVGO (default: true)
  */
-const inlineSvg = (consumerOptions = {}) => {
+const remarkInlineSvg = (consumerOptions = {}) => {
     const options = {
         suffix: consumerOptions.suffix ?? '.svg',
         assetsDir: consumerOptions.assetsDir,
@@ -39,7 +39,7 @@ const inlineSvg = (consumerOptions = {}) => {
         });
     };
 };
-exports.inlineSvg = inlineSvg;
+exports.remarkInlineSvg = remarkInlineSvg;
 /**
  * Reads an SVG file and optionally optimizes it with SVGO.
  */
@@ -61,7 +61,7 @@ function wrap(svgString, htmlWrapper) {
  * Resolves the final SVG file path based on:
  * 1) absolute URL → from project root
  * 2) `assetsDir` → relative to it
- * 3) fallback → relative to Markdown file directory
+ * 3) fallback → relative to Markdown file directory (if markdown file directory is undefined use absolute URL)
  */
 function resolvePath(assetsDir, node, markdownFileDir) {
     if (node_path_1.default.isAbsolute(node.url)) {
@@ -71,7 +71,7 @@ function resolvePath(assetsDir, node, markdownFileDir) {
         return node_path_1.default.resolve(process.cwd(), assetsDir, node.url);
     }
     else {
-        return node_path_1.default.resolve(markdownFileDir, node.url);
+        return node_path_1.default.resolve(markdownFileDir ?? process.cwd(), node.url);
     }
 }
 /**
@@ -79,6 +79,6 @@ function resolvePath(assetsDir, node, markdownFileDir) {
  */
 function optimizeSvg(svgString) {
     return (0, svgo_1.optimize)(svgString, {
-        plugins: ['preset-default', 'removeXMLNS', 'removeDimensions'],
+        plugins: ['preset-default', 'removeXMLNS'],
     });
 }

package/dist/plugin.d.ts

@@ -10,5 +10,5 @@ import type { Options } from './types';
  * @param options.wrapper - Optional HTML wrapper for the inline SVG (default: `<figure class="inline-svg"></figure>`)
  * @param options.svgo - Whether to optimize SVG using SVGO (default: true)
  */
-declare const inlineSvg: Plugin<[Options?], Root, Root>;
-export { inlineSvg };
+declare const remarkInlineSvg: Plugin<[Options?], Root, Root>;
+export { remarkInlineSvg };

package/dist/plugin.js

@@ -12,7 +12,7 @@ import { optimize } from 'svgo';
  * @param options.wrapper - Optional HTML wrapper for the inline SVG (default: `<figure class="inline-svg"></figure>`)
  * @param options.svgo - Whether to optimize SVG using SVGO (default: true)
  */
-const inlineSvg = (consumerOptions = {}) => {
+const remarkInlineSvg = (consumerOptions = {}) => {
     const options = {
         suffix: consumerOptions.suffix ?? '.svg',
         assetsDir: consumerOptions.assetsDir,
@@ -58,7 +58,7 @@ function wrap(svgString, htmlWrapper) {
  * Resolves the final SVG file path based on:
  * 1) absolute URL → from project root
  * 2) `assetsDir` → relative to it
- * 3) fallback → relative to Markdown file directory
+ * 3) fallback → relative to Markdown file directory (if markdown file directory is undefined use absolute URL)
  */
 function resolvePath(assetsDir, node, markdownFileDir) {
     if (path.isAbsolute(node.url)) {
@@ -68,7 +68,7 @@ function resolvePath(assetsDir, node, markdownFileDir) {
         return path.resolve(process.cwd(), assetsDir, node.url);
     }
     else {
-        return path.resolve(markdownFileDir, node.url);
+        return path.resolve(markdownFileDir ?? process.cwd(), node.url);
     }
 }
 /**
@@ -76,7 +76,7 @@ function resolvePath(assetsDir, node, markdownFileDir) {
  */
 function optimizeSvg(svgString) {
     return optimize(svgString, {
-        plugins: ['preset-default', 'removeXMLNS', 'removeDimensions'],
+        plugins: ['preset-default', 'removeXMLNS'],
     });
 }
-export { inlineSvg };
+export { remarkInlineSvg };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-inline-svg-flex",
-  "version": "0.2.3",
+  "version": "0.3.4",
   "description": "Flexible Remark plugin that inlines and optimizes SVGs with SVGO, featuring customizable path resolution and wrappers.",
   "keywords": [
     "unified",
@@ -48,11 +48,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"
+    "unist-util-visit": "^5.1.0",
+    "vfile": "^6.0.3"
   }
 }