@md-plugins/md-plugin-image 0.1.0-alpha.9 → 0.1.0-beta.1

package/README.md

@@ -13,12 +13,12 @@ A **Markdown-It** plugin that enhances image rendering by adding customizable CS
 Install the plugin via your preferred package manager:
 
 ```bash
-# With npm:
-npm install @md-plugins/md-plugin-image
-# Or with Yarn:
-yarn add @md-plugins/md-plugin-image
-# Or with pnpm:
+# with pnpm:
 pnpm add @md-plugins/md-plugin-image
+# with Yarn:
+yarn add @md-plugins/md-plugin-image
+# with npm:
+npm install @md-plugins/md-plugin-image
 ```
 
 ## Usage
@@ -67,6 +67,10 @@ Run the tests to ensure the plugin behaves as expected:
 pnpm test
 ```
 
+## Documentation
+
+In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/md-plugins/image/overview) for the latest information.
+
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.

package/dist/index.d.mts

@@ -1,8 +1,4 @@
-import MarkdownIt from 'markdown-it';
-
-declare const imagePlugin: (md: MarkdownIt, { imageClass }?: {
-    imageClass?: string | undefined;
-}) => void;
+import { PluginWithOptions } from 'markdown-it';
 
 interface ImagePluginOptions {
     /**
@@ -13,4 +9,7 @@ interface ImagePluginOptions {
     imageClass?: string;
 }
 
-export { type ImagePluginOptions, imagePlugin };
+declare const imagePlugin: PluginWithOptions<ImagePluginOptions>;
+
+export { imagePlugin };
+export type { ImagePluginOptions };

package/dist/index.d.ts

@@ -1,8 +1,4 @@
-import MarkdownIt from 'markdown-it';
-
-declare const imagePlugin: (md: MarkdownIt, { imageClass }?: {
-    imageClass?: string | undefined;
-}) => void;
+import { PluginWithOptions } from 'markdown-it';
 
 interface ImagePluginOptions {
     /**
@@ -13,4 +9,7 @@ interface ImagePluginOptions {
     imageClass?: string;
 }
 
-export { type ImagePluginOptions, imagePlugin };
+declare const imagePlugin: PluginWithOptions<ImagePluginOptions>;
+
+export { imagePlugin };
+export type { ImagePluginOptions };

package/dist/index.mjs

@@ -1,26 +1,41 @@
-const imagePlugin = (md, { imageClass = "markdown-image" } = {}) => {
+function resolvePluginOptions(options, key, defaults) {
+  if (options && typeof options === "object" && key in options) {
+    return { ...defaults, ...options[key] };
+  }
+  return { ...defaults, ...options };
+}
+
+const DEFAULT_IMAGE_PLUGIN_OPTIONS = {
+  imageClass: "markdown-image"
+};
+const imagePlugin = (md, options) => {
+  const { imageClass } = resolvePluginOptions(
+    options,
+    "imagePlugin",
+    DEFAULT_IMAGE_PLUGIN_OPTIONS
+  );
   const originalImageRender = md.renderer.rules.image;
-  md.renderer.rules.image = (tokens, idx, options, env, self) => {
+  md.renderer.rules.image = (tokens, idx, options2, env, self) => {
     const token = tokens[idx];
     if (!token) {
-      return self.renderToken(tokens, idx, options);
+      return self.renderToken(tokens, idx, options2);
     }
     let content = token.content;
     const widthMatch = content.match(/width="(\d+)"/);
     const heightMatch = content.match(/height="(\d+)"/);
-    if (widthMatch) {
+    if (widthMatch && widthMatch.length > 1) {
       token.attrSet("width", widthMatch[1]);
       content = content.replace(widthMatch[0], "").trim();
     }
-    if (heightMatch) {
+    if (heightMatch && heightMatch.length > 1) {
       token.attrSet("height", heightMatch[1]);
       content = content.replace(heightMatch[0], "").trim();
     }
     if (content) {
       const altIndex = token.attrIndex("alt");
-      if (altIndex >= 0 && token.attrs) {
+      if (altIndex >= 0 && token.attrs && token.attrs[altIndex] && token.attrs[altIndex].length > 1) {
         const altValue = token.attrs[altIndex][1];
-        if (!altValue) {
+        if (!altValue && altIndex) {
           token.attrs[altIndex][1] = content;
         }
       } else {
@@ -38,7 +53,7 @@ const imagePlugin = (md, { imageClass = "markdown-image" } = {}) => {
         }
       });
     }
-    return originalImageRender ? originalImageRender(tokens, idx, options, env, self) : self.renderToken(tokens, idx, options);
+    return originalImageRender ? originalImageRender(tokens, idx, options2, env, self) : self.renderToken(tokens, idx, options2);
   };
 };
 

package/package.json

@@ -1,24 +1,29 @@
 {
   "name": "@md-plugins/md-plugin-image",
-  "version": "0.1.0-alpha.9",
+  "version": "0.1.0-beta.1",
   "description": "A markdown-it plugin for handling images.",
   "keywords": [
     "markdown-it",
     "quasarframework",
-    "vue",
-    "types"
+    "types",
+    "vue"
   ],
   "homepage": "https://github.com/md-plugins",
   "bugs": {
     "url": "https://github.com/md-plugins/md-plugins/issues"
   },
+  "license": "MIT",
+  "author": "hawkeye64 <galbraith64@gmail.com>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/md-plugins/md-plugins.git"
   },
-  "license": "MIT",
-  "author": "hawkeye64 <galbraith64@gmail.com>",
+  "files": [
+    "./dist"
+  ],
   "type": "module",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "import": {
@@ -27,24 +32,17 @@
       }
     }
   },
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "./dist"
-  ],
-  "dependencies": {
-    "markdown-it": "^14.1.0",
-    "@md-plugins/shared": "0.1.0-alpha.9"
+  "publishConfig": {
+    "access": "public"
   },
   "devDependencies": {
-    "@types/markdown-it": "^14.1.2"
+    "@types/markdown-it": "^14.1.2",
+    "markdown-it": "^14.1.1",
+    "@md-plugins/shared": "0.1.0-beta.1"
   },
   "peerDependencies": {
     "markdown-it": "^14.1.0"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
     "build": "unbuild",
     "clean": "rm -rf dist/ node_modules/",