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

package/README.md

@@ -14,12 +14,12 @@ The `@md-plugins/shared` package provides common utilities, types, and helpers u
 Install the plugin via your preferred package manager:
 
 ```bash
-# With npm:
-npm install @md-plugins/shared
-# Or with Yarn:
-yarn add @md-plugins/shared
-# Or with pnpm:
+# with pnpm:
 pnpm add @md-plugins/shared
+# with Yarn:
+yarn add @md-plugins/shared
+# with npm:
+npm install @md-plugins/shared
 ```
 
 ## Usage
@@ -98,6 +98,10 @@ function slugify(str: string): string
 - Converts a string into a URL-friendly slug.
 - Removes special characters and replaces spaces with hyphens.
 
+## Documentation
+
+In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/md-plugins/shared/overview) for the latest information.
+
 ## License
 
 This package is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

package/dist/index.d.mts

@@ -41,6 +41,9 @@ interface MarkdownItHeader {
      */
     children: MarkdownItHeader[];
 }
+type ResolvePluginOptionsFn = <T extends object, K extends keyof any>(options: T | {
+    [P in K]?: T;
+} | undefined, key: K, defaults: T) => T;
 
 interface ResolveTitleOptions {
     /**
@@ -97,4 +100,9 @@ declare const resolveHeadersFromTokens: (tokens: Token[], { level, shouldAllowHt
  */
 declare const slugify: (str: string) => string;
 
-export { type MarkdownItEnv, type MarkdownItHeader, type ResolveHeadersOptions, type ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };
+declare function resolvePluginOptions<T extends object, K extends keyof any>(options: T | {
+    [key in K]?: T;
+} | undefined, key: K, defaults: T): T;
+
+export { htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolvePluginOptions, resolveTitleFromToken, slugify };
+export type { MarkdownItEnv, MarkdownItHeader, ResolveHeadersOptions, ResolvePluginOptionsFn, ResolveTitleOptions };

package/dist/index.d.ts

@@ -41,6 +41,9 @@ interface MarkdownItHeader {
      */
     children: MarkdownItHeader[];
 }
+type ResolvePluginOptionsFn = <T extends object, K extends keyof any>(options: T | {
+    [P in K]?: T;
+} | undefined, key: K, defaults: T) => T;
 
 interface ResolveTitleOptions {
     /**
@@ -97,4 +100,9 @@ declare const resolveHeadersFromTokens: (tokens: Token[], { level, shouldAllowHt
  */
 declare const slugify: (str: string) => string;
 
-export { type MarkdownItEnv, type MarkdownItHeader, type ResolveHeadersOptions, type ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };
+declare function resolvePluginOptions<T extends object, K extends keyof any>(options: T | {
+    [key in K]?: T;
+} | undefined, key: K, defaults: T): T;
+
+export { htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolvePluginOptions, resolveTitleFromToken, slugify };
+export type { MarkdownItEnv, MarkdownItHeader, ResolveHeadersOptions, ResolvePluginOptionsFn, ResolveTitleOptions };

package/dist/index.mjs

@@ -43,11 +43,11 @@ const resolveTitleFromToken = (token, { shouldAllowHtml, shouldEscapeText }) =>
   }, "").trim();
 };
 
+const andRE = /&/g;
+const rCombining = /[\u0300-\u036F]/g;
 const rControl = /[\u0000-\u001f]/g;
 const rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’<>,.?/]+/g;
-const rCombining = /[\u0300-\u036F]/g;
-const andRE = /&/g;
-const slugify = (str) => str.normalize("NFKD").toLowerCase().replace(andRE, "-and-").replace(rCombining, "").replace(rControl, "-").replace(rSpecial, "-").replace(/[^a-z0-9-]+/g, "").replace(/-{2,}/g, "-").replace(/^-+|-+$/g, "").replace(/^(\d)/, "_$1");
+const slugify = (str) => str.trim().replace(/([a-z])([A-Z])/g, "$1-$2").replace(/[\s_]+/g, "-").toLowerCase().normalize("NFKD").replace(rCombining, "").replace(andRE, "-and-").replace(rControl, "-").replace(rSpecial, "-").replace(/[^a-z0-9-]+/g, "").replace(/([a-z])(\d)/g, "$1-$2").replace(/(\d)([a-z])/g, "$1-$2").replace(/-{2,}/g, "-").replace(/(^-|-$)/g, "").replace(/^(\d)/, "_$1");
 
 const resolveHeadersFromTokens = (tokens, {
   level = [1, 2, 3],
@@ -93,4 +93,11 @@ const resolveHeadersFromTokens = (tokens, {
   return headers;
 };
 
-export { htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };
+function resolvePluginOptions(options, key, defaults) {
+  if (options && typeof options === "object" && key in options) {
+    return { ...defaults, ...options[key] };
+  }
+  return { ...defaults, ...options };
+}
+
+export { htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolvePluginOptions, resolveTitleFromToken, slugify };

package/package.json

@@ -1,24 +1,29 @@
 {
   "name": "@md-plugins/shared",
-  "version": "0.1.0-alpha.9",
+  "version": "0.1.0-beta.1",
   "description": "Shared functions and utilities for md-plugins.",
   "keywords": [
     "markdown-it",
     "quasarframework",
-    "vue",
-    "utils"
+    "utils",
+    "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,23 +32,16 @@
       }
     }
   },
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "./dist"
-  ],
-  "dependencies": {
-    "markdown-it": "^14.1.0"
+  "publishConfig": {
+    "access": "public"
   },
   "devDependencies": {
-    "@types/markdown-it": "^14.1.2"
+    "@types/markdown-it": "^14.1.2",
+    "markdown-it": "^14.1.1"
   },
   "peerDependencies": {
     "markdown-it": "^14.1.0"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
     "build": "unbuild",
     "clean": "rm -rf dist/ node_modules/",