remark-inline-svg-flex 0.1.1 → 0.2.2

package/dist/cjs/index.d.ts

@@ -0,0 +1 @@
+export * from './plugin';

package/dist/cjs/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./plugin"), exports);

package/dist/cjs/plugin.d.ts

@@ -0,0 +1,14 @@
+import type { Plugin } from 'unified';
+import type { Root } from 'mdast';
+import type { Options } from './types';
+/**
+ * Transforms image nodes that match the given suffix (default: .svg) into inline SVG.
+ *
+ * @param options - Plugin configuration
+ * @param options.suffix - File extension to match (default: '.svg')
+ * @param options.assetsDir - Optional base directory for resolving SVG paths (default: undefined)
+ * @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 };

package/dist/cjs/plugin.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.inlineSvg = 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");
+const svgo_1 = require("svgo");
+/**
+ * Transforms image nodes that match the given suffix (default: .svg) into inline SVG.
+ *
+ * @param options - Plugin configuration
+ * @param options.suffix - File extension to match (default: '.svg')
+ * @param options.assetsDir - Optional base directory for resolving SVG paths (default: undefined)
+ * @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 options = {
+        suffix: consumerOptions.suffix ?? '.svg',
+        assetsDir: consumerOptions.assetsDir,
+        wrapper: consumerOptions.wrapper ?? '<figure class="inline-svg"></figure>',
+        svgo: consumerOptions.svgo ?? true,
+    };
+    return function transformer(tree, file) {
+        (0, unist_util_visit_1.visit)(tree, 'image', (node, i, parent) => {
+            if (!node.url?.endsWith(options.suffix) || !parent)
+                return;
+            try {
+                const svgPath = resolvePath(options.assetsDir, node, 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,
+                };
+            }
+            catch (error) {
+                console.warn(error);
+            }
+        });
+    };
+};
+exports.inlineSvg = inlineSvg;
+/**
+ * Reads an SVG file and optionally optimizes it with SVGO.
+ */
+function processSvg(path, svgo) {
+    const svgString = node_fs_1.default.readFileSync(path, 'utf8');
+    return svgo ? optimizeSvg(svgString).data : svgString;
+}
+/**
+ * Injects SVG markup into an HTML wrapper before its closing tag.
+ */
+function wrap(svgString, htmlWrapper) {
+    const i = htmlWrapper.lastIndexOf('</');
+    if (i === -1) {
+        throw new Error(`Invalid HTML wrapper`);
+    }
+    return htmlWrapper.slice(0, i) + svgString + htmlWrapper.slice(i);
+}
+/**
+ * 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
+ */
+function resolvePath(assetsDir, node, markdownFileDir) {
+    if (node_path_1.default.isAbsolute(node.url)) {
+        return node_path_1.default.resolve(process.cwd(), node.url);
+    }
+    else if (assetsDir) {
+        return node_path_1.default.resolve(process.cwd(), assetsDir, node.url);
+    }
+    else {
+        return node_path_1.default.resolve(markdownFileDir, node.url);
+    }
+}
+/**
+ * Optimizes SVG content using predefined SVGO plugins.
+ */
+function optimizeSvg(svgString) {
+    return (0, svgo_1.optimize)(svgString, {
+        plugins: ['preset-default', 'removeXMLNS', 'removeDimensions'],
+    });
+}

package/dist/cjs/types.d.ts

@@ -0,0 +1,6 @@
+export type Options = {
+    suffix?: string;
+    assetsDir?: string | undefined;
+    wrapper?: string;
+    svgo?: boolean;
+};

package/dist/cjs/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.d.ts

@@ -0,0 +1,6 @@
+export type Options = {
+    suffix?: string;
+    assetsDir?: string | undefined;
+    wrapper?: string;
+    svgo?: boolean;
+};

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-inline-svg-flex",
-  "version": "0.1.1",
+  "version": "0.2.2",
   "description": "Flexible Remark plugin that inlines and optimizes SVGs with SVGO, featuring customizable path resolution and wrappers.",
   "keywords": [
     "unified",
@@ -24,9 +24,18 @@
   "license": "MIT",
   "author": "gass-git",
   "type": "module",
-  "main": "index.js",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "scripts": {
-    "build": "tsc",
+    "build": "rimraf dist && tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json",
     "dev": "rimraf --glob \"*.tgz\" && npm run build && npm pack && npm link",
     "tests": "vitest"
   },
@@ -36,13 +45,14 @@
     "prettier": "^3.8.1",
     "remark": "^15.0.1",
     "remark-parse": "^11.0.0",
-    "svgo": "^4.0.1",
+    "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"
   }
 }