weml-monaco 0.3.3 → 0.4.2

package/dist/index.d.mts

@@ -0,0 +1,108 @@
+import * as monaco from 'monaco-editor';
+
+declare const WEML_LANGUAGE_ID = "weml";
+
+interface WemlNormalizationFailure extends Error {
+    code: string;
+    line?: number;
+    column?: number;
+    expectedTag?: string | null;
+    actualTag?: string | null;
+}
+/** Normalises a WEML document string into its canonical, reproducible form. */
+declare function formatWemlText(input: string): string;
+declare function isWemlNormalizationFailure(error: unknown): error is WemlNormalizationFailure;
+declare function isWemlStructureValidationFailure(error: unknown): error is WemlNormalizationFailure;
+/** User-facing reason shown when canonical formatting is deliberately skipped. */
+declare function canonicalFormattingFailureMessage(error: unknown): string;
+
+declare function validateWemlModel(m: typeof monaco, model: monaco.editor.ITextModel): monaco.editor.IMarkerData[];
+
+interface WemlActionOptions {
+    /** Optional sink for the short status messages the VS Code extension shows in the status bar. */
+    onStatus?: (message: string) => void;
+}
+/** Wraps the current selection in `<tag [type=...]>…</tag>` (toolbar dropdown / hotkeys). */
+declare function wrapSelection(editor: monaco.editor.ICodeEditor, tag: string, type?: string): void;
+/** Inserts a snippet by its toolbar-button id (composite label or plain tag). */
+declare function insertSnippetById(editor: monaco.editor.ICodeEditor, id: string): void;
+/** Renumbers every `<div>` id in document order to a sequential 1..n. */
+declare function renumberDivIds(editor: monaco.editor.ICodeEditor, options?: WemlActionOptions): void;
+/**
+ * Cycles the whole document between the standard HTML formatting (even steps) and
+ * the canonical WEML normalizer (odd steps). The step counter advances on every
+ * invocation, even when the formatter produces no change, so the cycle stays in
+ * sync — matching the VS Code `weml.cycleFormat` command.
+ */
+declare function cycleFormat(editor: monaco.editor.ICodeEditor, options?: WemlActionOptions): void;
+/**
+ * Registers the WEML editor actions on a specific editor instance: cycle-format
+ * (Alt+Shift+F), renumber div ids, and wrap-format bold/italic/underline
+ * (Ctrl+B / Ctrl+I / Ctrl+U). Returns an `IDisposable` that removes them.
+ *
+ * `editor.addAction` is per-editor (Monaco has no global command registry akin
+ * to the VS Code extension host), so call this for every WEML editor — or just
+ * use `createWemlToolbar`, which calls it for you.
+ */
+declare function registerWemlEditorActions(m: typeof monaco, editor: monaco.editor.IStandaloneCodeEditor, options?: WemlActionOptions): monaco.IDisposable;
+
+interface WemlToolbarOptions extends WemlActionOptions {
+    /** If given, the toolbar element is appended here. Otherwise it is only returned. */
+    container?: HTMLElement;
+    /** Include the (stub) search row, matching the VS Code toolbar. Default: true. */
+    includeSearchRow?: boolean;
+    /**
+     * Handler for the search row. When omitted the row is a no-op stub (as in the
+     * VS Code extension). Receives the query text and the language code.
+     */
+    onSearch?: (query: string, lang: string) => void;
+}
+interface WemlToolbar extends monaco.IDisposable {
+    /** The toolbar's root DOM element. */
+    element: HTMLElement;
+}
+/**
+ * Builds the WEML toolbar for a Monaco editor and wires every button to the same
+ * operations as the VS Code toolbar (wrap selection, snippet insertion, renumber
+ * div ids). Also registers the editor actions/keybindings (Ctrl+B/I/U,
+ * Alt+Shift+F, renumber) via `registerWemlEditorActions`.
+ *
+ * Returns the root element plus a `dispose()` that removes the toolbar and its
+ * actions.
+ */
+declare function createWemlToolbar(m: typeof monaco, editor: monaco.editor.IStandaloneCodeEditor, options?: WemlToolbarOptions): WemlToolbar;
+
+interface IdEdit {
+    /** Replacement range in the source text (start === end means a pure insertion). */
+    start: number;
+    end: number;
+    newText: string;
+}
+/**
+ * Computes the edits needed to renumber every `<div>` id to its 1-based position
+ * in document order. Divs that already carry the right id produce no edit; a div
+ * without an `id` attribute gets one inserted right after the tag name.
+ */
+declare function planDivIdRenumber(text: string): IdEdit[];
+
+/**
+ * Builds a `<tag ...>SELECTION</tag>` snippet body for wrapping `selection`.
+ * - `type` (e.g. for `w-format`) fills `type="..."` directly.
+ * - `a` gets only `href="$1"` (it lists both href and id as required, but a
+ *   wrapped selection is a link).
+ * - otherwise the tag's required attributes become `name="$1"` placeholders.
+ * An empty selection leaves a tab stop where the content goes.
+ */
+declare function buildWrapSnippet(tag: string, type: string | undefined, selection: string): string;
+
+interface RegisterWemlOptions {
+    /** File extensions to associate with the language (default: [".weml"]). */
+    extensions?: string[];
+    /** Debounce for re-validating a model after edits, in ms (default: 300). */
+    diagnosticsDebounceMs?: number;
+    /** Set to false to skip live diagnostics/markers entirely (default: true). */
+    diagnostics?: boolean;
+}
+declare function registerWeml(m: typeof monaco, options?: RegisterWemlOptions): monaco.IDisposable;
+
+export { type IdEdit, type RegisterWemlOptions, WEML_LANGUAGE_ID, type WemlActionOptions, type WemlNormalizationFailure, type WemlToolbar, type WemlToolbarOptions, buildWrapSnippet, canonicalFormattingFailureMessage, createWemlToolbar, cycleFormat, formatWemlText, insertSnippetById, isWemlNormalizationFailure, isWemlStructureValidationFailure, planDivIdRenumber, registerWeml, registerWemlEditorActions, renumberDivIds, validateWemlModel, wrapSelection };

package/dist/index.d.ts

@@ -1,12 +1,101 @@
-import type * as monaco from 'monaco-editor';
-export { WEML_LANGUAGE_ID } from './language';
-export { canonicalFormattingFailureMessage, formatWemlText, isWemlNormalizationFailure, isWemlStructureValidationFailure, type WemlNormalizationFailure, } from './formatter';
-export { validateWemlModel } from './providers/diagnostics';
-export { createWemlToolbar, type WemlToolbar, type WemlToolbarOptions, } from './toolbar/toolbar';
-export { registerWemlEditorActions, wrapSelection, insertSnippetById, renumberDivIds, cycleFormat, type WemlActionOptions, } from './toolbar/actions';
-export { planDivIdRenumber, type IdEdit } from './toolbar/divRenumber';
-export { buildWrapSnippet } from './toolbar/wrap';
-export interface RegisterWemlOptions {
+import * as monaco from 'monaco-editor';
+
+declare const WEML_LANGUAGE_ID = "weml";
+
+interface WemlNormalizationFailure extends Error {
+    code: string;
+    line?: number;
+    column?: number;
+    expectedTag?: string | null;
+    actualTag?: string | null;
+}
+/** Normalises a WEML document string into its canonical, reproducible form. */
+declare function formatWemlText(input: string): string;
+declare function isWemlNormalizationFailure(error: unknown): error is WemlNormalizationFailure;
+declare function isWemlStructureValidationFailure(error: unknown): error is WemlNormalizationFailure;
+/** User-facing reason shown when canonical formatting is deliberately skipped. */
+declare function canonicalFormattingFailureMessage(error: unknown): string;
+
+declare function validateWemlModel(m: typeof monaco, model: monaco.editor.ITextModel): monaco.editor.IMarkerData[];
+
+interface WemlActionOptions {
+    /** Optional sink for the short status messages the VS Code extension shows in the status bar. */
+    onStatus?: (message: string) => void;
+}
+/** Wraps the current selection in `<tag [type=...]>…</tag>` (toolbar dropdown / hotkeys). */
+declare function wrapSelection(editor: monaco.editor.ICodeEditor, tag: string, type?: string): void;
+/** Inserts a snippet by its toolbar-button id (composite label or plain tag). */
+declare function insertSnippetById(editor: monaco.editor.ICodeEditor, id: string): void;
+/** Renumbers every `<div>` id in document order to a sequential 1..n. */
+declare function renumberDivIds(editor: monaco.editor.ICodeEditor, options?: WemlActionOptions): void;
+/**
+ * Cycles the whole document between the standard HTML formatting (even steps) and
+ * the canonical WEML normalizer (odd steps). The step counter advances on every
+ * invocation, even when the formatter produces no change, so the cycle stays in
+ * sync — matching the VS Code `weml.cycleFormat` command.
+ */
+declare function cycleFormat(editor: monaco.editor.ICodeEditor, options?: WemlActionOptions): void;
+/**
+ * Registers the WEML editor actions on a specific editor instance: cycle-format
+ * (Alt+Shift+F), renumber div ids, and wrap-format bold/italic/underline
+ * (Ctrl+B / Ctrl+I / Ctrl+U). Returns an `IDisposable` that removes them.
+ *
+ * `editor.addAction` is per-editor (Monaco has no global command registry akin
+ * to the VS Code extension host), so call this for every WEML editor — or just
+ * use `createWemlToolbar`, which calls it for you.
+ */
+declare function registerWemlEditorActions(m: typeof monaco, editor: monaco.editor.IStandaloneCodeEditor, options?: WemlActionOptions): monaco.IDisposable;
+
+interface WemlToolbarOptions extends WemlActionOptions {
+    /** If given, the toolbar element is appended here. Otherwise it is only returned. */
+    container?: HTMLElement;
+    /** Include the (stub) search row, matching the VS Code toolbar. Default: true. */
+    includeSearchRow?: boolean;
+    /**
+     * Handler for the search row. When omitted the row is a no-op stub (as in the
+     * VS Code extension). Receives the query text and the language code.
+     */
+    onSearch?: (query: string, lang: string) => void;
+}
+interface WemlToolbar extends monaco.IDisposable {
+    /** The toolbar's root DOM element. */
+    element: HTMLElement;
+}
+/**
+ * Builds the WEML toolbar for a Monaco editor and wires every button to the same
+ * operations as the VS Code toolbar (wrap selection, snippet insertion, renumber
+ * div ids). Also registers the editor actions/keybindings (Ctrl+B/I/U,
+ * Alt+Shift+F, renumber) via `registerWemlEditorActions`.
+ *
+ * Returns the root element plus a `dispose()` that removes the toolbar and its
+ * actions.
+ */
+declare function createWemlToolbar(m: typeof monaco, editor: monaco.editor.IStandaloneCodeEditor, options?: WemlToolbarOptions): WemlToolbar;
+
+interface IdEdit {
+    /** Replacement range in the source text (start === end means a pure insertion). */
+    start: number;
+    end: number;
+    newText: string;
+}
+/**
+ * Computes the edits needed to renumber every `<div>` id to its 1-based position
+ * in document order. Divs that already carry the right id produce no edit; a div
+ * without an `id` attribute gets one inserted right after the tag name.
+ */
+declare function planDivIdRenumber(text: string): IdEdit[];
+
+/**
+ * Builds a `<tag ...>SELECTION</tag>` snippet body for wrapping `selection`.
+ * - `type` (e.g. for `w-format`) fills `type="..."` directly.
+ * - `a` gets only `href="$1"` (it lists both href and id as required, but a
+ *   wrapped selection is a link).
+ * - otherwise the tag's required attributes become `name="$1"` placeholders.
+ * An empty selection leaves a tab stop where the content goes.
+ */
+declare function buildWrapSnippet(tag: string, type: string | undefined, selection: string): string;
+
+interface RegisterWemlOptions {
     /** File extensions to associate with the language (default: [".weml"]). */
     extensions?: string[];
     /** Debounce for re-validating a model after edits, in ms (default: 300). */
@@ -14,4 +103,6 @@ export interface RegisterWemlOptions {
     /** Set to false to skip live diagnostics/markers entirely (default: true). */
     diagnostics?: boolean;
 }
-export declare function registerWeml(m: typeof monaco, options?: RegisterWemlOptions): monaco.IDisposable;
+declare function registerWeml(m: typeof monaco, options?: RegisterWemlOptions): monaco.IDisposable;
+
+export { type IdEdit, type RegisterWemlOptions, WEML_LANGUAGE_ID, type WemlActionOptions, type WemlNormalizationFailure, type WemlToolbar, type WemlToolbarOptions, buildWrapSnippet, canonicalFormattingFailureMessage, createWemlToolbar, cycleFormat, formatWemlText, insertSnippetById, isWemlNormalizationFailure, isWemlStructureValidationFailure, planDivIdRenumber, registerWeml, registerWemlEditorActions, renumberDivIds, validateWemlModel, wrapSelection };

package/dist/index.global.d.ts

@@ -0,0 +1,12 @@
+// Types for the IIFE build (`dist/index.global.js`, exposed as `weml-monaco/global`), which
+// attaches the whole API to `window.WemlMonaco` instead of exporting anything.
+// Copied next to the bundle at build time — see `onSuccess` in tsup.config.ts.
+
+import type * as WemlMonacoApi from './index.js';
+
+declare global {
+    // eslint-disable-next-line no-var
+    var WemlMonaco: typeof WemlMonacoApi;
+}
+
+export {};