rumdl-wasm 0.0.185

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2025 Ruben J. Jongejan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,197 @@
+# rumdl-wasm
+
+Fast markdown linter with 60+ rules, compiled to WebAssembly.
+
+## Installation
+
+```bash
+npm install rumdl-wasm
+```
+
+## Quick Start
+
+```javascript
+import init, { lint_markdown, apply_all_fixes } from 'rumdl-wasm';
+
+// Initialize the WASM module
+await init();
+
+// Lint markdown content
+const content = '# Hello World\n\nSome text here...';
+const warnings = JSON.parse(lint_markdown(content));
+
+// Apply all auto-fixes
+const fixed = apply_all_fixes(content);
+```
+
+## API Reference
+
+### `init()`
+
+Initialize the WASM module. Must be called before using other functions.
+
+```javascript
+await init();
+```
+
+### `lint_markdown(content: string): string`
+
+Lint markdown content and return warnings as JSON.
+
+```javascript
+const warnings = JSON.parse(lint_markdown(content));
+```
+
+Returns a JSON array of warnings (see Warning Format below).
+
+### `apply_all_fixes(content: string): string`
+
+Apply all available auto-fixes to the content.
+
+```javascript
+const fixed = apply_all_fixes(content);
+```
+
+Returns the fixed content string.
+
+### `apply_fix(content: string, fix_json: string): string`
+
+Apply a single fix to the content.
+
+```javascript
+const fix = JSON.stringify({ start: 0, end: 5, replacement: 'Hello' });
+const fixed = apply_fix(content, fix);
+```
+
+### `get_version(): string`
+
+Get the rumdl version.
+
+```javascript
+const version = get_version(); // e.g., "0.0.185"
+```
+
+### `get_available_rules(): string`
+
+Get list of available rules as JSON.
+
+```javascript
+const rules = JSON.parse(get_available_rules());
+// [{ name: "MD001", description: "Heading levels should only increment by one level at a time" }, ...]
+```
+
+## Warning Format
+
+Each warning object contains:
+
+```typescript
+interface Warning {
+  rule: string;        // Rule name (e.g., "MD001")
+  message: string;     // Warning message
+  line: number;        // 1-indexed line number
+  column: number;      // 1-indexed column number
+  end_line: number;    // 1-indexed end line
+  end_column: number;  // 1-indexed end column
+  severity: string;    // "Error" or "Warning"
+  fix?: {              // Optional auto-fix
+    start: number;     // Byte offset start
+    end: number;       // Byte offset end
+    replacement: string;
+  };
+}
+```
+
+## Browser Usage
+
+### ES Module
+
+```html
+<script type="module">
+  import init, { lint_markdown } from './rumdl_wasm.js';
+
+  async function main() {
+    await init();
+    const warnings = JSON.parse(lint_markdown('# Test'));
+    console.log(warnings);
+  }
+
+  main();
+</script>
+```
+
+### With CDN (unpkg)
+
+```html
+<script type="module">
+  import init, { lint_markdown } from 'https://unpkg.com/rumdl-wasm/rumdl_wasm.js';
+
+  await init();
+  console.log(JSON.parse(lint_markdown('# Test')));
+</script>
+```
+
+## Node.js Usage
+
+```javascript
+import init, { lint_markdown, apply_all_fixes } from 'rumdl-wasm';
+import { readFile } from 'fs/promises';
+
+await init();
+
+const content = await readFile('README.md', 'utf-8');
+const warnings = JSON.parse(lint_markdown(content));
+
+for (const w of warnings) {
+  console.log(`${w.line}:${w.column} ${w.rule} ${w.message}`);
+}
+```
+
+## Bundler Usage
+
+### Vite
+
+```javascript
+// vite.config.js
+export default {
+  optimizeDeps: {
+    exclude: ['rumdl-wasm']
+  }
+};
+```
+
+```javascript
+// main.js
+import init, { lint_markdown } from 'rumdl-wasm';
+
+await init();
+const warnings = JSON.parse(lint_markdown(content));
+```
+
+### Webpack 5
+
+```javascript
+// webpack.config.js
+module.exports = {
+  experiments: {
+    asyncWebAssembly: true
+  }
+};
+```
+
+## TypeScript
+
+TypeScript definitions are included. The package exports all functions with proper types.
+
+```typescript
+import init, { lint_markdown, apply_all_fixes, get_version } from 'rumdl-wasm';
+
+await init();
+
+const warnings: Warning[] = JSON.parse(lint_markdown(content));
+const fixed: string = apply_all_fixes(content);
+const version: string = get_version();
+```
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "rumdl-wasm",
+  "type": "module",
+  "collaborators": [
+    "Ruben J. Jongejan <ruben.jongejan@gmail.com>"
+  ],
+  "description": "Fast markdown linter with 60+ rules - WebAssembly build",
+  "version": "0.0.185",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rvben/rumdl"
+  },
+  "files": [
+    "rumdl_lib_bg.wasm",
+    "rumdl_lib.js",
+    "rumdl_lib.d.ts"
+  ],
+  "main": "rumdl_lib.js",
+  "homepage": "https://github.com/rvben/rumdl",
+  "types": "rumdl_lib.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ],
+  "keywords": [
+    "markdown",
+    "linter",
+    "wasm",
+    "webassembly",
+    "lint",
+    "markdown-linter",
+    "static-analysis"
+  ]
+}

package/rumdl_lib.d.ts

@@ -0,0 +1,84 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Get list of available rules as JSON
+ *
+ * Returns a JSON array of rule info objects, each with:
+ * - `name`: Rule name (e.g., "MD001")
+ * - `description`: Rule description
+ */
+export function get_available_rules(): string;
+/**
+ * Lint markdown content and return warnings as JSON
+ *
+ * Returns a JSON array of warnings, each with:
+ * - `rule`: Rule name (e.g., "MD001")
+ * - `message`: Warning message
+ * - `line`: 1-indexed line number
+ * - `column`: 1-indexed column number
+ * - `end_line`: 1-indexed end line
+ * - `end_column`: 1-indexed end column
+ * - `severity`: "Error" or "Warning"
+ * - `fix`: Optional fix object with `start`, `end`, `replacement`
+ */
+export function lint_markdown(content: string): string;
+/**
+ * Apply all auto-fixes to the content and return the fixed content
+ *
+ * Returns the content with all available fixes applied.
+ * Uses the same fix coordinator as the CLI for consistent behavior.
+ */
+export function apply_all_fixes(content: string): string;
+/**
+ * Initialize the WASM module with better panic messages
+ */
+export function init(): void;
+/**
+ * Get the rumdl version
+ */
+export function get_version(): string;
+/**
+ * Apply a single fix to the content
+ *
+ * Takes a JSON-encoded fix object with `start`, `end`, `replacement` fields.
+ * Returns the content with the fix applied.
+ */
+export function apply_fix(content: string, fix_json: string): string;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly apply_all_fixes: (a: number, b: number, c: number) => void;
+  readonly apply_fix: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly get_available_rules: (a: number) => void;
+  readonly get_version: (a: number) => void;
+  readonly init: () => void;
+  readonly lint_markdown: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_export: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_export2: (a: number, b: number) => number;
+  readonly __wbindgen_export3: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+  readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+*
+* @returns {InitOutput}
+*/
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+*
+* @returns {Promise<InitOutput>}
+*/
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/rumdl_lib.js

@@ -0,0 +1,396 @@
+let wasm;
+
+let cachedUint8ArrayMemory0 = null;
+
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+
+cachedTextDecoder.decode();
+
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return decodeText(ptr, len);
+}
+
+let heap = new Array(128).fill(undefined);
+
+heap.push(undefined, null, true, false);
+
+let heap_next = heap.length;
+
+function addHeapObject(obj) {
+    if (heap_next === heap.length) heap.push(heap.length + 1);
+    const idx = heap_next;
+    heap_next = heap[idx];
+
+    heap[idx] = obj;
+    return idx;
+}
+
+function getObject(idx) { return heap[idx]; }
+
+let WASM_VECTOR_LEN = 0;
+
+const cachedTextEncoder = new TextEncoder();
+
+if (!('encodeInto' in cachedTextEncoder)) {
+    cachedTextEncoder.encodeInto = function (arg, view) {
+        const buf = cachedTextEncoder.encode(arg);
+        view.set(buf);
+        return {
+            read: arg.length,
+            written: buf.length
+        };
+    }
+}
+
+function passStringToWasm0(arg, malloc, realloc) {
+
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length, 1) >>> 0;
+        getUint8ArrayMemory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len, 1) >>> 0;
+
+    const mem = getUint8ArrayMemory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3, 1) >>> 0;
+        const view = getUint8ArrayMemory0().subarray(ptr + offset, ptr + len);
+        const ret = cachedTextEncoder.encodeInto(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+let cachedDataViewMemory0 = null;
+
+function getDataViewMemory0() {
+    if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
+        cachedDataViewMemory0 = new DataView(wasm.memory.buffer);
+    }
+    return cachedDataViewMemory0;
+}
+
+function dropObject(idx) {
+    if (idx < 132) return;
+    heap[idx] = heap_next;
+    heap_next = idx;
+}
+
+function takeObject(idx) {
+    const ret = getObject(idx);
+    dropObject(idx);
+    return ret;
+}
+/**
+ * Get list of available rules as JSON
+ *
+ * Returns a JSON array of rule info objects, each with:
+ * - `name`: Rule name (e.g., "MD001")
+ * - `description`: Rule description
+ * @returns {string}
+ */
+export function get_available_rules() {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        wasm.get_available_rules(retptr);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        deferred1_0 = r0;
+        deferred1_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_export(deferred1_0, deferred1_1, 1);
+    }
+}
+
+/**
+ * Lint markdown content and return warnings as JSON
+ *
+ * Returns a JSON array of warnings, each with:
+ * - `rule`: Rule name (e.g., "MD001")
+ * - `message`: Warning message
+ * - `line`: 1-indexed line number
+ * - `column`: 1-indexed column number
+ * - `end_line`: 1-indexed end line
+ * - `end_column`: 1-indexed end column
+ * - `severity`: "Error" or "Warning"
+ * - `fix`: Optional fix object with `start`, `end`, `replacement`
+ * @param {string} content
+ * @returns {string}
+ */
+export function lint_markdown(content) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        const ptr0 = passStringToWasm0(content, wasm.__wbindgen_export2, wasm.__wbindgen_export3);
+        const len0 = WASM_VECTOR_LEN;
+        wasm.lint_markdown(retptr, ptr0, len0);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        deferred2_0 = r0;
+        deferred2_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_export(deferred2_0, deferred2_1, 1);
+    }
+}
+
+/**
+ * Apply all auto-fixes to the content and return the fixed content
+ *
+ * Returns the content with all available fixes applied.
+ * Uses the same fix coordinator as the CLI for consistent behavior.
+ * @param {string} content
+ * @returns {string}
+ */
+export function apply_all_fixes(content) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        const ptr0 = passStringToWasm0(content, wasm.__wbindgen_export2, wasm.__wbindgen_export3);
+        const len0 = WASM_VECTOR_LEN;
+        wasm.apply_all_fixes(retptr, ptr0, len0);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        deferred2_0 = r0;
+        deferred2_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_export(deferred2_0, deferred2_1, 1);
+    }
+}
+
+/**
+ * Initialize the WASM module with better panic messages
+ */
+export function init() {
+    wasm.init();
+}
+
+/**
+ * Get the rumdl version
+ * @returns {string}
+ */
+export function get_version() {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        wasm.get_version(retptr);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        deferred1_0 = r0;
+        deferred1_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_export(deferred1_0, deferred1_1, 1);
+    }
+}
+
+/**
+ * Apply a single fix to the content
+ *
+ * Takes a JSON-encoded fix object with `start`, `end`, `replacement` fields.
+ * Returns the content with the fix applied.
+ * @param {string} content
+ * @param {string} fix_json
+ * @returns {string}
+ */
+export function apply_fix(content, fix_json) {
+    let deferred3_0;
+    let deferred3_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        const ptr0 = passStringToWasm0(content, wasm.__wbindgen_export2, wasm.__wbindgen_export3);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(fix_json, wasm.__wbindgen_export2, wasm.__wbindgen_export3);
+        const len1 = WASM_VECTOR_LEN;
+        wasm.apply_fix(retptr, ptr0, len0, ptr1, len1);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        deferred3_0 = r0;
+        deferred3_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_export(deferred3_0, deferred3_1, 1);
+    }
+}
+
+const EXPECTED_RESPONSE_TYPES = new Set(['basic', 'cors', 'default']);
+
+async function __wbg_load(module, imports) {
+    if (typeof Response === 'function' && module instanceof Response) {
+        if (typeof WebAssembly.instantiateStreaming === 'function') {
+            try {
+                return await WebAssembly.instantiateStreaming(module, imports);
+
+            } catch (e) {
+                const validResponse = module.ok && EXPECTED_RESPONSE_TYPES.has(module.type);
+
+                if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
+                    console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
+
+                } else {
+                    throw e;
+                }
+            }
+        }
+
+        const bytes = await module.arrayBuffer();
+        return await WebAssembly.instantiate(bytes, imports);
+
+    } else {
+        const instance = await WebAssembly.instantiate(module, imports);
+
+        if (instance instanceof WebAssembly.Instance) {
+            return { instance, module };
+
+        } else {
+            return instance;
+        }
+    }
+}
+
+function __wbg_get_imports() {
+    const imports = {};
+    imports.wbg = {};
+    imports.wbg.__wbg_error_7534b8e9a36f1ab4 = function(arg0, arg1) {
+        let deferred0_0;
+        let deferred0_1;
+        try {
+            deferred0_0 = arg0;
+            deferred0_1 = arg1;
+            console.error(getStringFromWasm0(arg0, arg1));
+        } finally {
+            wasm.__wbindgen_export(deferred0_0, deferred0_1, 1);
+        }
+    };
+    imports.wbg.__wbg_new_8a6f238a6ece86ea = function() {
+        const ret = new Error();
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbg_stack_0ed75d68575b0f3c = function(arg0, arg1) {
+        const ret = getObject(arg1).stack;
+        const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_export2, wasm.__wbindgen_export3);
+        const len1 = WASM_VECTOR_LEN;
+        getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
+        getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
+    };
+    imports.wbg.__wbindgen_object_drop_ref = function(arg0) {
+        takeObject(arg0);
+    };
+
+    return imports;
+}
+
+function __wbg_finalize_init(instance, module) {
+    wasm = instance.exports;
+    __wbg_init.__wbindgen_wasm_module = module;
+    cachedDataViewMemory0 = null;
+    cachedUint8ArrayMemory0 = null;
+
+
+    wasm.__wbindgen_start();
+    return wasm;
+}
+
+function initSync(module) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (typeof module !== 'undefined') {
+        if (Object.getPrototypeOf(module) === Object.prototype) {
+            ({module} = module)
+        } else {
+            console.warn('using deprecated parameters for `initSync()`; pass a single object instead')
+        }
+    }
+
+    const imports = __wbg_get_imports();
+
+    if (!(module instanceof WebAssembly.Module)) {
+        module = new WebAssembly.Module(module);
+    }
+
+    const instance = new WebAssembly.Instance(module, imports);
+
+    return __wbg_finalize_init(instance, module);
+}
+
+async function __wbg_init(module_or_path) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (typeof module_or_path !== 'undefined') {
+        if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
+            ({module_or_path} = module_or_path)
+        } else {
+            console.warn('using deprecated parameters for the initialization function; pass a single object instead')
+        }
+    }
+
+    if (typeof module_or_path === 'undefined') {
+        module_or_path = new URL('rumdl_lib_bg.wasm', import.meta.url);
+    }
+    const imports = __wbg_get_imports();
+
+    if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
+        module_or_path = fetch(module_or_path);
+    }
+
+    const { instance, module } = await __wbg_load(await module_or_path, imports);
+
+    return __wbg_finalize_init(instance, module);
+}
+
+export { initSync };
+export default __wbg_init;