@hongdown/wasm 0.2.0-dev.0

package/dist/index.d.cts

@@ -0,0 +1,236 @@
+//#region src/types.d.ts
+/**
+ * Padding style for ordered list numbers.
+ *
+ * - `"start"`: Pad before the number (default): `  1.`, `  2.`, ..., ` 10.`
+ * - `"end"`: Pad after the number: `1. `, `2. `, ..., `10.`
+ */
+type OrderedListPad = "start" | "end";
+/**
+ * Dash transformation setting.
+ *
+ * - `false`: Disabled
+ * - `string`: Pattern to transform to the dash character
+ */
+type DashSetting = false | string;
+/**
+ * Formatting options for the Hongdown formatter.
+ *
+ * All options are optional. When not specified, default values are used.
+ */
+interface FormatOptions {
+  /**
+   * Line width for wrapping.
+   * @default 80
+   */
+  lineWidth?: number;
+  /**
+   * Use setext-style (underlined) for h1 headings.
+   * @default true
+   */
+  setextH1?: boolean;
+  /**
+   * Use setext-style (underlined) for h2 headings.
+   * @default true
+   */
+  setextH2?: boolean;
+  /**
+   * Marker character for unordered lists: `"-"`, `"*"`, or `"+"`.
+   * @default "-"
+   */
+  unorderedMarker?: string;
+  /**
+   * Number of leading spaces before the list marker.
+   * @default 1
+   */
+  leadingSpaces?: number;
+  /**
+   * Number of trailing spaces after the list marker.
+   * @default 2
+   */
+  trailingSpaces?: number;
+  /**
+   * Indentation width for nested list items.
+   * @default 4
+   */
+  indentWidth?: number;
+  /**
+   * Marker style for ordered lists at odd nesting levels.
+   * Use `"."` for `1.` or `")"` for `1)`.
+   * @default "."
+   */
+  oddLevelMarker?: string;
+  /**
+   * Marker style for ordered lists at even nesting levels.
+   * Use `"."` for `1.` or `")"` for `1)`.
+   * @default ")"
+   */
+  evenLevelMarker?: string;
+  /**
+   * Padding style for ordered list numbers.
+   * @default "start"
+   */
+  orderedListPad?: OrderedListPad;
+  /**
+   * Indentation width for nested ordered list items.
+   * @default 4
+   */
+  orderedListIndentWidth?: number;
+  /**
+   * Fence character for code blocks: `"~"` or `` "`" ``.
+   * @default "~"
+   */
+  fenceChar?: string;
+  /**
+   * Minimum fence length for code blocks.
+   * @default 4
+   */
+  minFenceLength?: number;
+  /**
+   * Add space between fence and language identifier.
+   * @default true
+   */
+  spaceAfterFence?: boolean;
+  /**
+   * Default language identifier for code blocks without one.
+   * When empty, code blocks without a language identifier remain without one.
+   * @default ""
+   */
+  defaultLanguage?: string;
+  /**
+   * The style string for thematic breaks.
+   * @default "- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -"
+   */
+  thematicBreakStyle?: string;
+  /**
+   * Number of leading spaces before thematic breaks (0-3).
+   * @default 3
+   */
+  thematicBreakLeadingSpaces?: number;
+  /**
+   * Convert straight double quotes to curly quotes.
+   * `"text"` becomes `"text"` (U+201C and U+201D).
+   * @default true
+   */
+  curlyDoubleQuotes?: boolean;
+  /**
+   * Convert straight single quotes to curly quotes.
+   * `'text'` becomes `'text'` (U+2018 and U+2019).
+   * @default true
+   */
+  curlySingleQuotes?: boolean;
+  /**
+   * Convert straight apostrophes to curly apostrophes.
+   * `it's` becomes `it's` (U+2019).
+   * @default false
+   */
+  curlyApostrophes?: boolean;
+  /**
+   * Convert three dots to ellipsis character.
+   * `...` becomes `…` (U+2026).
+   * @default true
+   */
+  ellipsis?: boolean;
+  /**
+   * Convert a pattern to en-dash.
+   * Set to a string like `"--"` to enable.
+   * The pattern is replaced with `–` (U+2013).
+   * @default false
+   */
+  enDash?: DashSetting;
+  /**
+   * Convert a pattern to em-dash.
+   * Set to `false` to disable, or a string like `"---"` for a different pattern.
+   * The pattern is replaced with `—` (U+2014).
+   * @default "--"
+   */
+  emDash?: DashSetting;
+}
+/**
+ * A warning generated during formatting.
+ */
+interface Warning {
+  /**
+   * Line number where the warning was generated (1-indexed).
+   */
+  line: number;
+  /**
+   * Warning message.
+   */
+  message: string;
+}
+/**
+ * Result of formatting with warnings.
+ */
+interface FormatResult {
+  /**
+   * The formatted Markdown output.
+   */
+  output: string;
+  /**
+   * Warnings generated during formatting.
+   */
+  warnings: Warning[];
+}
+//#endregion
+//#region src/index.d.ts
+
+/**
+ * Format Markdown according to Hong Minhee's style conventions.
+ *
+ * This function supports formatting directives embedded in HTML comments:
+ *
+ * - `<!-- hongdown-disable-file -->` - Disable formatting for the entire file.
+ * - `<!-- hongdown-disable-next-line -->` - Disable formatting for the next block.
+ * - `<!-- hongdown-disable-next-section -->` - Disable formatting until the next
+ *   section heading.
+ * - `<!-- hongdown-disable -->` - Disable formatting from this point.
+ * - `<!-- hongdown-enable -->` - Re-enable formatting.
+ *
+ * @param input - Markdown source to format
+ * @param options - Formatting options (all optional)
+ * @returns The formatted Markdown string
+ *
+ * @example
+ * ```typescript
+ * import { format } from "@hongdown/wasm";
+ *
+ * // Basic usage
+ * const result = await format("# Hello\nWorld");
+ *
+ * // With options
+ * const result = await format(markdown, {
+ *   lineWidth: 100,
+ *   setextH1: false,
+ *   fenceChar: "`",
+ * });
+ * ```
+ */
+declare function format(input: string, options?: FormatOptions): Promise<string>;
+/**
+ * Format Markdown and return both output and warnings.
+ *
+ * This is similar to {@link format}, but also returns any warnings generated
+ * during formatting (e.g., inconsistent table column counts).
+ *
+ * @param input - Markdown source to format
+ * @param options - Formatting options (all optional)
+ * @returns Object with formatted output and any warnings
+ *
+ * @example
+ * ```typescript
+ * import { formatWithWarnings } from "@hongdown/wasm";
+ *
+ * const { output, warnings } = await formatWithWarnings(markdown);
+ *
+ * if (warnings.length > 0) {
+ *   for (const warning of warnings) {
+ *     console.warn(`Line ${warning.line}: ${warning.message}`);
+ *   }
+ * }
+ * ```
+ */
+declare function formatWithWarnings(input: string, options?: FormatOptions): Promise<FormatResult>;
+//#endregion
+export { type DashSetting, type FormatOptions, type FormatResult, type OrderedListPad, type Warning, format, formatWithWarnings };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/index.ts"],"sourcesContent":[],"mappings":";;AAMA;AAQA;AAOA;;;AAoJW,KAnKC,cAAA,GAmKD,OAAA,GAAA,KAAA;;AAMX;AAeA;;;;AClHsB,KD9DV,WAAA,GCgED,KAAA,GAAA,MACR;AA4BH;;;;;UDtFiB,aAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA6DE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+ER;;;;;;;WAQA;;;;;UAMM,OAAA;;;;;;;;;;;;;UAeA,YAAA;;;;;;;;YASL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBC3HU,MAAA,0BAEX,gBACR;;;;;;;;;;;;;;;;;;;;;;;;iBA4BmB,kBAAA,0BAEX,gBACR,QAAQ"}

package/dist/index.d.mts

@@ -0,0 +1,236 @@
+//#region src/types.d.ts
+/**
+ * Padding style for ordered list numbers.
+ *
+ * - `"start"`: Pad before the number (default): `  1.`, `  2.`, ..., ` 10.`
+ * - `"end"`: Pad after the number: `1. `, `2. `, ..., `10.`
+ */
+type OrderedListPad = "start" | "end";
+/**
+ * Dash transformation setting.
+ *
+ * - `false`: Disabled
+ * - `string`: Pattern to transform to the dash character
+ */
+type DashSetting = false | string;
+/**
+ * Formatting options for the Hongdown formatter.
+ *
+ * All options are optional. When not specified, default values are used.
+ */
+interface FormatOptions {
+  /**
+   * Line width for wrapping.
+   * @default 80
+   */
+  lineWidth?: number;
+  /**
+   * Use setext-style (underlined) for h1 headings.
+   * @default true
+   */
+  setextH1?: boolean;
+  /**
+   * Use setext-style (underlined) for h2 headings.
+   * @default true
+   */
+  setextH2?: boolean;
+  /**
+   * Marker character for unordered lists: `"-"`, `"*"`, or `"+"`.
+   * @default "-"
+   */
+  unorderedMarker?: string;
+  /**
+   * Number of leading spaces before the list marker.
+   * @default 1
+   */
+  leadingSpaces?: number;
+  /**
+   * Number of trailing spaces after the list marker.
+   * @default 2
+   */
+  trailingSpaces?: number;
+  /**
+   * Indentation width for nested list items.
+   * @default 4
+   */
+  indentWidth?: number;
+  /**
+   * Marker style for ordered lists at odd nesting levels.
+   * Use `"."` for `1.` or `")"` for `1)`.
+   * @default "."
+   */
+  oddLevelMarker?: string;
+  /**
+   * Marker style for ordered lists at even nesting levels.
+   * Use `"."` for `1.` or `")"` for `1)`.
+   * @default ")"
+   */
+  evenLevelMarker?: string;
+  /**
+   * Padding style for ordered list numbers.
+   * @default "start"
+   */
+  orderedListPad?: OrderedListPad;
+  /**
+   * Indentation width for nested ordered list items.
+   * @default 4
+   */
+  orderedListIndentWidth?: number;
+  /**
+   * Fence character for code blocks: `"~"` or `` "`" ``.
+   * @default "~"
+   */
+  fenceChar?: string;
+  /**
+   * Minimum fence length for code blocks.
+   * @default 4
+   */
+  minFenceLength?: number;
+  /**
+   * Add space between fence and language identifier.
+   * @default true
+   */
+  spaceAfterFence?: boolean;
+  /**
+   * Default language identifier for code blocks without one.
+   * When empty, code blocks without a language identifier remain without one.
+   * @default ""
+   */
+  defaultLanguage?: string;
+  /**
+   * The style string for thematic breaks.
+   * @default "- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -"
+   */
+  thematicBreakStyle?: string;
+  /**
+   * Number of leading spaces before thematic breaks (0-3).
+   * @default 3
+   */
+  thematicBreakLeadingSpaces?: number;
+  /**
+   * Convert straight double quotes to curly quotes.
+   * `"text"` becomes `"text"` (U+201C and U+201D).
+   * @default true
+   */
+  curlyDoubleQuotes?: boolean;
+  /**
+   * Convert straight single quotes to curly quotes.
+   * `'text'` becomes `'text'` (U+2018 and U+2019).
+   * @default true
+   */
+  curlySingleQuotes?: boolean;
+  /**
+   * Convert straight apostrophes to curly apostrophes.
+   * `it's` becomes `it's` (U+2019).
+   * @default false
+   */
+  curlyApostrophes?: boolean;
+  /**
+   * Convert three dots to ellipsis character.
+   * `...` becomes `…` (U+2026).
+   * @default true
+   */
+  ellipsis?: boolean;
+  /**
+   * Convert a pattern to en-dash.
+   * Set to a string like `"--"` to enable.
+   * The pattern is replaced with `–` (U+2013).
+   * @default false
+   */
+  enDash?: DashSetting;
+  /**
+   * Convert a pattern to em-dash.
+   * Set to `false` to disable, or a string like `"---"` for a different pattern.
+   * The pattern is replaced with `—` (U+2014).
+   * @default "--"
+   */
+  emDash?: DashSetting;
+}
+/**
+ * A warning generated during formatting.
+ */
+interface Warning {
+  /**
+   * Line number where the warning was generated (1-indexed).
+   */
+  line: number;
+  /**
+   * Warning message.
+   */
+  message: string;
+}
+/**
+ * Result of formatting with warnings.
+ */
+interface FormatResult {
+  /**
+   * The formatted Markdown output.
+   */
+  output: string;
+  /**
+   * Warnings generated during formatting.
+   */
+  warnings: Warning[];
+}
+//#endregion
+//#region src/index.d.ts
+
+/**
+ * Format Markdown according to Hong Minhee's style conventions.
+ *
+ * This function supports formatting directives embedded in HTML comments:
+ *
+ * - `<!-- hongdown-disable-file -->` - Disable formatting for the entire file.
+ * - `<!-- hongdown-disable-next-line -->` - Disable formatting for the next block.
+ * - `<!-- hongdown-disable-next-section -->` - Disable formatting until the next
+ *   section heading.
+ * - `<!-- hongdown-disable -->` - Disable formatting from this point.
+ * - `<!-- hongdown-enable -->` - Re-enable formatting.
+ *
+ * @param input - Markdown source to format
+ * @param options - Formatting options (all optional)
+ * @returns The formatted Markdown string
+ *
+ * @example
+ * ```typescript
+ * import { format } from "@hongdown/wasm";
+ *
+ * // Basic usage
+ * const result = await format("# Hello\nWorld");
+ *
+ * // With options
+ * const result = await format(markdown, {
+ *   lineWidth: 100,
+ *   setextH1: false,
+ *   fenceChar: "`",
+ * });
+ * ```
+ */
+declare function format(input: string, options?: FormatOptions): Promise<string>;
+/**
+ * Format Markdown and return both output and warnings.
+ *
+ * This is similar to {@link format}, but also returns any warnings generated
+ * during formatting (e.g., inconsistent table column counts).
+ *
+ * @param input - Markdown source to format
+ * @param options - Formatting options (all optional)
+ * @returns Object with formatted output and any warnings
+ *
+ * @example
+ * ```typescript
+ * import { formatWithWarnings } from "@hongdown/wasm";
+ *
+ * const { output, warnings } = await formatWithWarnings(markdown);
+ *
+ * if (warnings.length > 0) {
+ *   for (const warning of warnings) {
+ *     console.warn(`Line ${warning.line}: ${warning.message}`);
+ *   }
+ * }
+ * ```
+ */
+declare function formatWithWarnings(input: string, options?: FormatOptions): Promise<FormatResult>;
+//#endregion
+export { type DashSetting, type FormatOptions, type FormatResult, type OrderedListPad, type Warning, format, formatWithWarnings };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/index.ts"],"sourcesContent":[],"mappings":";;AAMA;AAQA;AAOA;;;AAoJW,KAnKC,cAAA,GAmKD,OAAA,GAAA,KAAA;;AAMX;AAeA;;;;AClHsB,KD9DV,WAAA,GCgED,KAAA,GAAA,MACR;AA4BH;;;;;UDtFiB,aAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA6DE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+ER;;;;;;;WAQA;;;;;UAMM,OAAA;;;;;;;;;;;;;UAeA,YAAA;;;;;;;;YASL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBC3HU,MAAA,0BAEX,gBACR;;;;;;;;;;;;;;;;;;;;;;;;iBA4BmB,kBAAA,0BAEX,gBACR,QAAQ"}