Add npm package using napi-rs

.cargo/config.toml

@@ -0,0 +1,5 @@
+[target.x86_64-apple-darwin]
+rustflags = ["-C", "link-args=-Wl,-undefined,dynamic_lookup"]
+
+[target.aarch64-apple-darwin]
+rustflags = ["-C", "link-args=-Wl,-undefined,dynamic_lookup"]

.github/contribute.md

@@ -36,6 +36,14 @@ It’s probably a good idea to first post a question or open an issue to report
 bug or suggest a new feature before creating a pull request.
 See [Project][] for more info.
 
+## `napi` folder
+
+This is the package that handles NAPI bindings for markdown-rs. It also supports WASM. It uses napi-rs to generate the npm packages published on npm.
+
+Tests use vitest, expect().toMatchInlineSnapshot() mostly. Most tests should be run with `pnpm vitest --run -u` to update snapshots, then read the test file again and make sure they have the expected result.
+
+When making changes in rust run `pnpm build:debug` to make sure the Rust code compiles.
+
 ## Submitting an issue
 
 * the issue tracker is for issues, discussions are for questions

.github/workflows/release-napi.yml

@@ -0,0 +1,183 @@
+name: Release NAPI
+
+permissions: {}
+
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - napi/package.json # make new release on version change of napi package
+    # TODO enable the release napi workflow only on main
+    # branches:
+    #   - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  DEBUG: "napi:*"
+
+jobs:
+  check:
+    name: Check version
+    runs-on: ubuntu-latest
+    outputs:
+      version_changed: ${{ steps.version.outputs.changed }}
+    steps:
+      - uses: taiki-e/checkout-action@b13d20b7cda4e2f325ef19895128f7ff735c0b3d # v1.3.1
+
+      - name: Check version changes
+        uses: EndBug/version-check@36ff30f37c7deabe56a30caa043d127be658c425 # v2.1.5
+        id: version
+        with:
+          static-checking: localIsNew
+          file-url: https://unpkg.com/@xmorse/markdown-rs@latest/package.json
+          file-name: napi/package.json
+
+      - name: Set version name
+        if: steps.version.outputs.changed == 'true'
+        env:
+          version: ${{ steps.version.outputs.version }}
+        run: echo "version=${version}"
+
+  build:
+    needs: check
+    if: needs.check.outputs.version_changed == 'true'
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+            build: |
+              pnpm build --target x86_64-pc-windows-msvc
+
+          - os: windows-latest
+            target: aarch64-pc-windows-msvc
+            build: |
+              pnpm build --target aarch64-pc-windows-msvc
+
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            build: |
+              pnpm build --target x86_64-unknown-linux-gnu --use-napi-cross
+
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+            build: |
+              pnpm build --target x86_64-unknown-linux-musl -x
+
+          - os: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+            build: |
+              pnpm build --target aarch64-unknown-linux-gnu --use-napi-cross
+
+          - os: ubuntu-latest
+            target: aarch64-unknown-linux-musl
+            build: |
+              pnpm build --target aarch64-unknown-linux-musl -x
+
+          - os: ubuntu-latest
+            target: armv7-unknown-linux-gnueabihf
+            build: |
+              pnpm build --target armv7-unknown-linux-gnueabihf --use-napi-cross
+
+          - os: macos-latest
+            target: x86_64-apple-darwin
+            build: |
+              pnpm build --target x86_64-apple-darwin
+
+          - os: macos-latest
+            target: aarch64-apple-darwin
+            build: |
+              pnpm build --target aarch64-apple-darwin
+
+          - os: ubuntu-latest
+            target: wasm32-wasip1-threads
+            build: |
+              pnpm build --target wasm32-wasip1-threads
+
+          - os: ubuntu-latest
+            target: s390x-unknown-linux-gnu
+            build: |
+              export CFLAGS="-fuse-ld=lld"
+              pnpm build --target s390x-unknown-linux-gnu --use-napi-cross
+
+          - os: ubuntu-latest
+            target: riscv64gc-unknown-linux-gnu
+            build: |
+              sudo apt-get update
+              sudo apt-get install gcc-riscv64-linux-gnu g++-riscv64-linux-gnu -y
+              export CC=riscv64-linux-gnu-gcc
+              export CXX=riscv64-linux-gnu-g++
+              pnpm build --target riscv64gc-unknown-linux-gnu
+
+    name: Build ${{ matrix.target }}
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: taiki-e/checkout-action@b13d20b7cda4e2f325ef19895128f7ff735c0b3d # v1.3.1
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - uses: pnpm/action-setup@v4
+      - run: pnpm i --frozen-lockfile=false
+
+      - run: rustup target add ${{ matrix.target }}
+
+      - uses: goto-bus-stop/setup-zig@abea47f85e598557f500fa1fd2ab7464fcb39406 # v2.2.1
+        if: ${{ contains(matrix.target, 'musl') }}
+        with:
+          version: 0.13.0
+
+      - name: Build
+        run: ${{ matrix.build }}
+        shell: bash
+        working-directory: napi
+        env:
+          CC: clang # for mimalloc
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          if-no-files-found: "error"
+          name: bindings-${{ matrix.target }}
+          path: |
+            napi/*.node
+            napi/*.wasm
+
+  publish:
+    name: Publish NAPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write # for `npm publish --provenance`
+    needs:
+      - build
+    steps:
+      - uses: taiki-e/checkout-action@b13d20b7cda4e2f325ef19895128f7ff735c0b3d # v1.3.1
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - uses: pnpm/action-setup@v4
+      - run: pnpm i --frozen-lockfile=false
+
+      - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
+        with:
+          path: artifacts
+
+      - run: pnpm napi create-npm-dirs --package-json-path napi/package.json
+
+      - run: pnpm napi artifacts --package-json-path package.json --npm-dir ../npm --build-output-dir .
+        working-directory: napi
+
+      - name: Publish npm packages as latest
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+          pnpm napi pre-publish --no-gh-release --tagstyle npm --package-json-path napi/package.json --npm-dir npm
+
+          # Publish root package
+          npm publish napi/ --tag latest --provenance --access public

.gitignore

@@ -10,3 +10,8 @@ fuzz/corpus
 fuzz/artifacts
 fuzz/hfuzz_target
 fuzz/hfuzz_workspace
+*.node
+*.wasm
+node_modules
+/npm
+target/

Cargo.toml

@@ -41,7 +41,7 @@ rust-version = "1.56"
 version = "1.0.0"
 
 [workspace]
-members = ["generate", "mdast_util_to_markdown"]
+members = ["generate", "mdast_util_to_markdown", "napi"]
 
 [workspace.dependencies]
 pretty_assertions = "1"

napi/.cargo/config.toml

@@ -0,0 +1,5 @@
+[target.x86_64-apple-darwin]
+rustflags = ["-C", "link-args=-Wl,-undefined,dynamic_lookup"]
+
+[target.aarch64-apple-darwin]
+rustflags = ["-C", "link-args=-Wl,-undefined,dynamic_lookup"]

napi/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "markdown-napi"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[lib]
+crate-type = ["cdylib", "lib"]
+
+
+[dependencies]
+napi = { version = "3.0.0-beta.8", default-features = false, features = ["napi3", "serde-json"] }
+napi-derive = { version = "3.0.0-beta.8" }
+markdown = { path = "..", package = "markdown", version = "1.0.0", features = ["serde"] }
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"
+
+
+[build-dependencies]
+napi-build = "2.2.1"

napi/README.md

@@ -0,0 +1,3 @@
+# markdown-rs
+
+CommonMark compliant markdown parser in Rust with ASTs and extensions. Packaged for npm with full WASM support.

napi/browser.js

@@ -0,0 +1 @@
+export * from '@xmorse/markdown-rs-binding-wasm32-wasi'

napi/index.d.ts

@@ -0,0 +1,54 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+export interface CompileOptions {
+  /** Whether to allow (dangerous) HTML */
+  allowDangerousHtml?: boolean
+  /** Whether to allow dangerous protocols in links and images */
+  allowDangerousProtocol?: boolean
+  /** Whether to allow all values in images */
+  allowAnyImgSrc?: boolean
+  /** Default line ending to use when compiling to HTML */
+  defaultLineEnding?: string
+  /** Textual label to describe the backreference back to footnote calls */
+  gfmFootnoteBackLabel?: string
+  /** Prefix to use before the `id` attribute on footnotes */
+  gfmFootnoteClobberPrefix?: string
+  /** Textual label to use for the footnotes section */
+  gfmFootnoteLabel?: string
+  /** Attributes to use on the footnote label */
+  gfmFootnoteLabelAttributes?: string
+  /** HTML tag name to use for the footnote label element */
+  gfmFootnoteLabelTagName?: string
+  /** Whether or not GFM task list html `<input>` items are enabled */
+  gfmTaskListItemCheckable?: boolean
+  /** Whether to support the GFM tagfilter */
+  gfmTagfilter?: boolean
+}
+
+export interface HtmlOptions {
+  /** Configuration that describes how to parse from markdown */
+  parse?: ParseOptions
+  /** Configuration that describes how to compile to HTML */
+  compile?: CompileOptions
+}
+
+export declare function parse(input: string, options?: ParseOptions | undefined | null): any
+
+export interface ParseOptions {
+  /** Whether to parse as MDX */
+  mdx?: boolean
+  /** Whether to enable GitHub Flavored Markdown (GFM) constructs */
+  gfm?: boolean
+  /** Whether to support GFM strikethrough with a single tilde */
+  gfmStrikethroughSingleTilde?: boolean
+  /** Whether to support math (text) with a single dollar */
+  mathTextSingleDollar?: boolean
+  /** Whether to enable basic MDX expression parsing */
+  mdxExpressionParse?: boolean
+  /** Whether to enable basic MDX ESM parsing */
+  mdxEsmParse?: boolean
+  /** Whether to support frontmatter */
+  frontmatter?: boolean
+}
+
+export declare function toHtml(input: string, options?: HtmlOptions | undefined | null): string