@md-plugins/md-plugin-table 0.1.0-alpha.9 → 0.1.0-beta.0

package/README.md

@@ -14,12 +14,12 @@ A **Markdown-It** plugin that customizes the rendering of tables in Markdown. Th
 Install the plugin via your preferred package manager:
 
 ```bash
-# With npm:
-npm install @md-plugins/md-plugin-table
-# Or with Yarn:
-yarn add @md-plugins/md-plugin-table
-# Or with pnpm:
+# with pnpm:
 pnpm add @md-plugins/md-plugin-table
+# with Yarn:
+yarn add @md-plugins/md-plugin-table
+# with npm:
+npm install @md-plugins/md-plugin-table
 ```
 
 ## Usage
@@ -151,6 +151,10 @@ Run the unit 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/table/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

@@ -41,4 +41,5 @@ interface TablePluginOptions {
 
 declare const tablePlugin: PluginWithOptions<TablePluginOptions>;
 
-export { type TablePluginOptions, tablePlugin };
+export { tablePlugin };
+export type { TablePluginOptions };

package/dist/index.d.ts

@@ -41,4 +41,5 @@ interface TablePluginOptions {
 
 declare const tablePlugin: PluginWithOptions<TablePluginOptions>;
 
-export { type TablePluginOptions, tablePlugin };
+export { tablePlugin };
+export type { TablePluginOptions };

package/dist/index.mjs

@@ -1,28 +1,46 @@
-const tablePlugin = (md, {
-  tableClass = "markdown-table",
-  tableHeaderClass = "text-left",
-  tableRowClass = "",
-  tableCellClass = "",
-  tableToken = "q-markup-table",
-  tableAttributes = []
-} = {}) => {
+function resolvePluginOptions(options, key, defaults) {
+  if (options && typeof options === "object" && key in options) {
+    return { ...defaults, ...options[key] };
+  }
+  return { ...defaults, ...options };
+}
+
+const DEFAULT_TABLE_PLUGIN_OPTIONS = {
+  tableClass: "markdown-table",
+  tableHeaderClass: "text-left",
+  tableRowClass: "",
+  tableCellClass: "",
+  tableToken: "q-markup-table",
+  tableAttributes: []
+};
+const tablePlugin = (md, options) => {
+  const {
+    tableClass = DEFAULT_TABLE_PLUGIN_OPTIONS.tableClass,
+    tableHeaderClass = DEFAULT_TABLE_PLUGIN_OPTIONS.tableHeaderClass,
+    tableRowClass = DEFAULT_TABLE_PLUGIN_OPTIONS.tableRowClass,
+    tableCellClass = DEFAULT_TABLE_PLUGIN_OPTIONS.tableCellClass,
+    tableToken = DEFAULT_TABLE_PLUGIN_OPTIONS.tableToken,
+    tableAttributes = DEFAULT_TABLE_PLUGIN_OPTIONS.tableAttributes
+  } = resolvePluginOptions(
+    options,
+    "tablePlugin",
+    DEFAULT_TABLE_PLUGIN_OPTIONS
+  );
   const render = md.renderer.render.bind(md.renderer);
-  md.renderer.render = (tokens, options, env) => {
+  md.renderer.render = (tokens, options2, env) => {
     for (let i = 0; i < tokens.length; i++) {
       const token = tokens[i];
-      if (!token) {
-        continue;
-      }
+      if (!token) continue;
       switch (token.type) {
         case "table_open":
-          token.tag = tableToken;
-          token.attrSet("class", tableClass);
-          for (const [attrName, attrValue] of tableAttributes) {
+          token.tag = tableToken ?? DEFAULT_TABLE_PLUGIN_OPTIONS.tableToken;
+          token.attrSet("class", tableClass ?? DEFAULT_TABLE_PLUGIN_OPTIONS.tableClass);
+          for (const [attrName, attrValue] of tableAttributes ?? []) {
             token.attrSet(attrName, String(attrValue));
           }
           break;
         case "table_close":
-          token.tag = tableToken;
+          token.tag = tableToken ?? DEFAULT_TABLE_PLUGIN_OPTIONS.tableToken;
           break;
         case "th_open":
           if (tableHeaderClass) {
@@ -41,7 +59,7 @@ const tablePlugin = (md, {
           break;
       }
     }
-    return render(tokens, options, env);
+    return render(tokens, options2, env);
   };
 };
 

package/package.json

@@ -1,24 +1,29 @@
 {
   "name": "@md-plugins/md-plugin-table",
-  "version": "0.1.0-alpha.9",
+  "version": "0.1.0-beta.0",
   "description": "A markdown-it plugin for handling tables with custom tag and styles.",
   "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.0"
   },
   "peerDependencies": {
     "markdown-it": "^14.1.0"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
     "build": "unbuild",
     "clean": "rm -rf dist/ node_modules/",