npm - @hongdown/wasm - Versions diffs - 0.2.0-dev.0 → 0.2.0-dev.69 - Mend

@hongdown/wasm 0.2.0-dev.0 → 0.2.0-dev.69

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,64 @@
+@hongdown/wasm
+==============
+A WebAssembly-based Markdown formatter library that enforces
+[Hong Minhee's Markdown style conventions].
+This package provides the same formatting as the [Hongdown CLI], but as a
+JavaScript/TypeScript library that works in Node.js, Bun, Deno, and web
+browsers.
+[Hong Minhee's Markdown style conventions]: https://github.com/dahlia/hongdown/blob/main/STYLE.md
+[Hongdown CLI]: https://www.npmjs.com/package/hongdown
+Installation
+------------
+~~~~ bash
+npm install @hongdown/wasm
+~~~~
+Usage
+-----
+~~~~ typescript
+import { format, formatWithWarnings } from "@hongdown/wasm";
+// Basic usage
+const markdown = "# Hello\nWorld";
+const formatted = await format(markdown);
+// With options
+const result = await format(markdown, {
+  lineWidth: 100,
+  setextH1: false,
+  fenceChar: "`",
+});
+// Get warnings along with formatted output
+const { output, warnings } = await formatWithWarnings(markdown);
+if (warnings.length > 0) {
+  for (const warning of warnings) {
+    console.warn(`Line ${warning.line}: ${warning.message}`);
+  }
+}
+~~~~
+Options
+-------
+All options are optional.  See the [TypeScript type definitions] for the
+complete list of available options.
+[TypeScript type definitions]: https://github.com/dahlia/hongdown/blob/main/npm/wasm/src/types.ts
+License
+-------
+Distributed under the [GPL-3.0-or-later].
+[GPL-3.0-or-later]: https://www.gnu.org/licenses/gpl-3.0.html

package/dist/hongdown_bg.wasm CHANGED Viewed

Binary file

package/package.json CHANGED Viewed

@@ -1,79 +1,79 @@
 {
-  "name": "@hongdown/wasm",
-  "version": "0.2.0-dev.0",
-  "type": "module",
-  "description": "WASM-based Markdown formatter library for Hong Minhee's style conventions",
-  "license": "GPL-3.0-or-later",
-  "author": "Hong Minhee <hong@minhee.org>",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/dahlia/hongdown.git",
-    "directory": "npm/wasm"
-  },
-  "homepage": "https://github.com/dahlia/hongdown",
-  "keywords": [
-    "Markdown",
-    "formatter",
-    "WASM",
-    "WebAssembly"
-  ],
-  "imports": {
-    "#wasm-loader": {
-      "node": {
-        "import": {
-          "types": "./dist/loader-node.d.mts",
-          "default": "./dist/loader-node.mjs"
-        },
-        "require": {
-          "types": "./dist/loader-node.d.cts",
-          "default": "./dist/loader-node.cjs"
+    "name": "@hongdown/wasm",
+    "version": "0.2.0-dev.69+25f3a0fa",
+    "type": "module",
+    "description": "WASM-based Markdown formatter library for Hong Minhee's style conventions",
+    "license": "GPL-3.0-or-later",
+    "author": "Hong Minhee \u003chong@minhee.org\u003e",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/dahlia/hongdown.git",
+        "directory": "npm/wasm"
+    },
+    "homepage": "https://github.com/dahlia/hongdown",
+    "keywords": [
+        "Markdown",
+        "formatter",
+        "WASM",
+        "WebAssembly"
+    ],
+    "imports": {
+        "#wasm-loader": {
+            "node": {
+                "import": {
+                    "types": "./dist/loader-node.d.mts",
+                    "default": "./dist/loader-node.mjs"
+                },
+                "require": {
+                    "types": "./dist/loader-node.d.cts",
+                    "default": "./dist/loader-node.cjs"
+                }
+            },
+            "default": {
+                "import": {
+                    "types": "./dist/loader-web.d.mts",
+                    "default": "./dist/loader-web.mjs"
+                },
+                "require": {
+                    "types": "./dist/loader-web.d.cts",
+                    "default": "./dist/loader-web.cjs"
+                }
+            }
         }
-      },
-      "default": {
-        "import": {
-          "types": "./dist/loader-web.d.mts",
-          "default": "./dist/loader-web.mjs"
-        },
-        "require": {
-          "types": "./dist/loader-web.d.cts",
-          "default": "./dist/loader-web.cjs"
+    },
+    "exports": {
+        ".": {
+            "import": {
+                "types": "./dist/index.d.mts",
+                "default": "./dist/index.mjs"
+            },
+            "require": {
+                "types": "./dist/index.d.cts",
+                "default": "./dist/index.cjs"
+            }
         }
-      }
+    },
+    "main": "./dist/index.cjs",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.mts",
+    "files": [
+        "dist/",
+        "README.md"
+    ],
+    "engines": {
+        "node": "\u003e=18"
+    },
+    "scripts": {
+        "build": "tsdown",
+        "test": "tsdown \u0026\u0026 node --experimental-transform-types --test test/*.test.ts \u0026\u0026 bun test test/ \u0026\u0026 deno test --allow-read test/",
+        "test:node": "tsdown \u0026\u0026 node --experimental-transform-types --test test/*.test.ts",
+        "test:bun": "tsdown \u0026\u0026 bun test test/",
+        "test:deno": "tsdown \u0026\u0026 deno test --allow-read test/",
+        "prepublishOnly": "npm run build"
+    },
+    "devDependencies": {
+        "@types/node": "^22.0.0",
+        "tsdown": "^0.20.0-beta.1",
+        "typescript": "^5.0.0"
     }
-  },
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.mts",
-  "files": [
-    "dist/",
-    "README.md"
-  ],
-  "engines": {
-    "node": ">=18"
-  },
-  "scripts": {
-    "build": "tsdown",
-    "test": "tsdown && node --experimental-transform-types --test test/*.test.ts && bun test test/ && deno test --allow-read test/",
-    "test:node": "tsdown && node --experimental-transform-types --test test/*.test.ts",
-    "test:bun": "tsdown && bun test test/",
-    "test:deno": "tsdown && deno test --allow-read test/",
-    "prepublishOnly": "npm run build"
-  },
-  "devDependencies": {
-    "@types/node": "^22.0.0",
-    "tsdown": "^0.20.0-beta.1",
-    "typescript": "^5.0.0"
-  }
 }