weml-monaco 0.3.3 → 0.4.2

package/package.json

@@ -1,41 +1,76 @@
 {
   "name": "weml-monaco",
-  "version": "0.3.3",
+  "version": "0.4.2",
   "description": "WEML (White Estate Markup Language) language support for the Monaco editor: syntax highlighting, autocomplete, hover docs, structure diagnostics, outline and canonical formatting.",
   "license": "MIT",
+  "type": "commonjs",
+  "keywords": [
+    "weml",
+    "monaco",
+    "monaco-editor",
+    "language",
+    "egw"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Burjuy/weml-language-vscode-extension.git",
     "directory": "monaco-editor"
   },
-  "main": "dist/weml-monaco.js",
-  "module": "dist/weml-monaco.esm.js",
-  "types": "dist/index.d.ts",
+  "homepage": "https://github.com/Burjuy/weml-language-vscode-extension/tree/main/monaco-editor#readme",
+  "bugs": {
+    "url": "https://github.com/Burjuy/weml-language-vscode-extension/issues"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./global": {
+      "types": "./dist/index.global.d.ts",
+      "default": "./dist/index.global.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "unpkg": "./dist/index.global.js",
+  "jsdelivr": "./dist/index.global.js",
   "files": [
     "dist",
     "README.md",
     "CHANGELOG.md"
   ],
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
     "prepublishOnly": "node -e \"if (!process.env.CI) { console.error('\\n  weml-monaco is published from CI only (.github/workflows/publish-weml-monaco.yml).\\n  Bump the version and push to main instead.\\n'); process.exit(1); }\"",
     "typecheck": "tsc -p ./ --noEmit",
-    "build:lib": "esbuild src/index.ts --bundle --format=iife --global-name=WemlMonaco --external:fs --external:crypto --outfile=dist/weml-monaco.js --sourcemap",
-    "build:esm": "esbuild src/index.ts --bundle --format=esm --external:fs --external:crypto --outfile=dist/weml-monaco.esm.js --sourcemap",
-    "build:types": "tsc -p ./ --emitDeclarationOnly --declaration --outDir dist",
-    "build": "npm run build:lib && npm run build:esm && npm run build:types",
+    "build": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\" && tsup",
+    "check:package": "publint --strict && attw --pack . --profile node16",
     "pack:local": "npm run build && node -e \"const fs = require('fs'); if (!fs.existsSync('pack')) fs.mkdirSync('pack');\" && npm pack --pack-destination=pack",
-    "demo": "esbuild src/index.ts --bundle --format=iife --global-name=WemlMonaco --external:fs --external:crypto --outfile=demo/weml-monaco.js --sourcemap && echo Open demo/index.html",
-    "pretest": "npm run build:lib && npm run build:esm",
+    "demo": "npm run build && node -e \"require('fs').copyFileSync('dist/index.global.js', 'demo/weml-monaco.js')\" && echo Open demo/index.html",
+    "pretest": "npm run build",
     "test": "node test/smoke.mjs"
   },
-  "dependencies": {
-    "node-html-parser": "^6.1.13",
-    "vscode-html-languageservice": "^5.2.0"
-  },
   "devDependencies": {
-    "esbuild": "^0.21.0",
+    "@arethetypeswrong/cli": "^0.18.5",
+    "esbuild": "^0.25.12",
     "monaco-editor": "^0.45.0",
-    "typescript": "^5.4.0"
+    "node-html-parser": "^6.1.13",
+    "publint": "^0.3.23",
+    "tsup": "^8.5.1",
+    "typescript": "^5.4.0",
+    "vscode-html-languageservice": "^5.2.0",
+    "@types/node": "^26.2.0"
   },
   "peerDependencies": {
     "monaco-editor": ">=0.34.0"

package/dist/formatter.d.ts

@@ -1,13 +0,0 @@
-export 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. */
-export declare function formatWemlText(input: string): string;
-export declare function isWemlNormalizationFailure(error: unknown): error is WemlNormalizationFailure;
-export declare function isWemlStructureValidationFailure(error: unknown): error is WemlNormalizationFailure;
-/** User-facing reason shown when canonical formatting is deliberately skipped. */
-export declare function canonicalFormattingFailureMessage(error: unknown): string;

package/dist/generated/schema.d.ts

@@ -1,33 +0,0 @@
-export interface EnumValue {
-    value: string;
-    name: string;
-    description: string;
-}
-export interface EnumSchema {
-    id: string;
-    title: string;
-    values: EnumValue[];
-}
-export interface AttributeSchema {
-    name: string;
-    required: boolean;
-    default?: string;
-    description: string;
-    enumRef?: string;
-}
-export interface TagSchema {
-    tag: string;
-    description: string;
-    attributes: AttributeSchema[];
-    notes: string;
-    source: string;
-}
-export interface MetaFieldSchema {
-    name: string;
-    description: string;
-    enumRef?: string;
-}
-export declare const ENUMS: Record<string, EnumSchema>;
-export declare const TAGS: Record<string, TagSchema>;
-export declare const META_FIELDS: MetaFieldSchema[];
-export declare const TEXT_NODE_DESCRIPTION: string;

package/dist/language.d.ts

@@ -1,4 +0,0 @@
-import type * as monaco from 'monaco-editor';
-export declare const WEML_LANGUAGE_ID = "weml";
-export declare const languageConfiguration: monaco.languages.LanguageConfiguration;
-export declare const monarchLanguage: monaco.languages.IMonarchLanguage;

package/dist/providers/completion.d.ts

@@ -1,2 +0,0 @@
-import type * as monaco from 'monaco-editor';
-export declare function createCompletionProvider(m: typeof monaco): monaco.languages.CompletionItemProvider;

package/dist/providers/diagnostics.d.ts

@@ -1,3 +0,0 @@
-import type * as monaco from 'monaco-editor';
-export declare const WEML_MARKER_OWNER = "weml";
-export declare function validateWemlModel(m: typeof monaco, model: monaco.editor.ITextModel): monaco.editor.IMarkerData[];

package/dist/providers/documentSymbols.d.ts

@@ -1,2 +0,0 @@
-import type * as monaco from 'monaco-editor';
-export declare function createDocumentSymbolProvider(m: typeof monaco): monaco.languages.DocumentSymbolProvider;

package/dist/providers/hover.d.ts

@@ -1,2 +0,0 @@
-import type * as monaco from 'monaco-editor';
-export declare function createHoverProvider(_m: typeof monaco): monaco.languages.HoverProvider;

package/dist/schema/docs.d.ts

@@ -1,13 +0,0 @@
-import { AttributeSchema } from '../generated/schema';
-/** Mirrors `monaco.IMarkdownString` without taking a hard dependency on it. */
-export interface Markdown {
-    value: string;
-    isTrusted?: boolean;
-}
-export declare function tagMarkdown(tag: string): Markdown;
-export declare function attributeMarkdown(tag: string, attr: AttributeSchema): Markdown;
-export declare function enumValueMarkdown(enumRef: string, value: string): Markdown | undefined;
-export declare function enumValuesSummary(enumRef: string): string;
-export declare function metaFieldMarkdown(name: string): Markdown | undefined;
-export declare function entityMarkdown(reference: string): Markdown | undefined;
-export declare function textNodeMarkdown(): Markdown;

package/dist/schema/entities.d.ts

@@ -1,35 +0,0 @@
-export interface EntityInfo {
-    /** The character(s) the reference resolves to. */
-    char: string;
-    /** Human-readable name. */
-    name: string;
-}
-export declare const NAMED_ENTITIES: Record<string, EntityInfo>;
-export interface ResolvedEntity {
-    /** The full reference text, e.g. "&mdash;". */
-    reference: string;
-    /** The resolved character, or undefined for unknown named references. */
-    char?: string;
-    /** Human-readable name, when known. */
-    name?: string;
-    /** Unicode code point, when resolvable. */
-    codePoint?: number;
-}
-/** Resolves a character reference (with surrounding `&` and `;`) to its details. */
-export declare function resolveEntity(reference: string): ResolvedEntity | undefined;
-export declare const ENTITY_COMPLETION_PRIORITY: string[];
-/**
- * If the cursor sits inside a partial entity being typed (`&`, `&md`, `&#82` …),
- * returns the range to replace, including a trailing `;` if already present.
- * Returns undefined when there is no `&`-initiated token before the cursor.
- */
-export declare function getPartialEntityRange(text: string, offset: number): {
-    start: number;
-    end: number;
-} | undefined;
-/** Finds the character reference whose span contains `offset` within `text`. */
-export declare function findEntityAt(text: string, offset: number): {
-    reference: string;
-    start: number;
-    end: number;
-} | undefined;

package/dist/schema/snippets.d.ts

@@ -1,26 +0,0 @@
-/**
- * Build a `<tag ...>...</tag>` snippet body (including the opening `<`) for
- * the given tag, with required attributes and required descendants filled
- * in as placeholders. The `a` tag is special-cased: use
- * `buildAnchorLinkSnippet`/`buildAnchorIdSnippet` instead.
- */
-export declare function buildElementSnippet(tag: string): string;
-/**
- * Opening tag only, with required attributes as placeholders and no children or
- * line breaks (e.g. `<w-format type="$1">`). Used by tag completion so accepting
- * a suggestion inserts just the start tag; the closing tag is offered separately
- * by the `</` completion.
- */
-export declare function buildOpeningTag(tag: string): string;
-/** `<a href="...">` variant — a link to another resource, may contain inline content. */
-export declare function buildAnchorLinkSnippet(): string;
-/** `<a id="...">` variant — a named anchor, must be empty. */
-export declare function buildAnchorIdSnippet(): string;
-export interface CompositeSnippet {
-    label: string;
-    detail: string;
-    /** Parent tags whose child slot this snippet is offered for, in addition to the plain tag completion. */
-    parents: string[];
-    body: string;
-}
-export declare const COMPOSITE_SNIPPETS: CompositeSnippet[];

package/dist/schema/structureRules.d.ts

@@ -1,81 +0,0 @@
-export type NodeCategory = 'container' | 'block' | 'inline';
-export declare const CONTAINER_TAGS: readonly ["w-para", "w-heading", "w-para-group", "w-toc"];
-export declare const BLOCK_TAGS: readonly ["w-text-block", "figure", "w-list", "table", "hr"];
-export declare const INLINE_TAGS: readonly ["a", "br", "w-entity", "w-format", "w-lang", "w-non-egw", "w-note", "w-page", "w-sent"];
-export declare function categoryOf(tag: string): NodeCategory | undefined;
-/**
- * A group of sibling children that share the same allowed tags and count.
- * Every element child of a node must match exactly one group of its
- * StructureRule; a child that matches no group is "not allowed here".
- */
-export interface ChildGroup {
-    tags: string[];
-    min: number;
-    /** `null` means unbounded. */
-    max: number | null;
-    description: string;
-}
-export interface StructureRule {
-    children: ChildGroup[];
-    /** Whether non-whitespace text nodes are allowed as direct children. */
-    allowText?: boolean;
-    description: string;
-}
-export declare const STRUCTURE_RULES: Record<string, StructureRule>;
-export interface AttributeConstraint {
-    tag: string;
-    attribute: string;
-    kind: 'integer-range' | 'integer-min' | 'pattern';
-    min?: number;
-    max?: number;
-    /** Used when `kind === 'pattern'`. Empty values are always allowed. */
-    pattern?: RegExp;
-    message: string;
-}
-/** Matches an arabic (`12`) or roman (`iii`, `XIV`) number. */
-export declare const ARABIC_OR_ROMAN: RegExp;
-export declare const ATTRIBUTE_CONSTRAINTS: AttributeConstraint[];
-export interface MetaConstraint {
-    /** meta[name=...] this rule applies to. */
-    name: string;
-    kind: 'digits' | 'isbn';
-    message: string;
-}
-export declare const META_CONSTRAINTS: MetaConstraint[];
-/** True for an empty string or a string consisting only of arabic digits. */
-export declare function isDigitsOnly(value: string): boolean;
-/**
- * Validates an ISBN-10 or ISBN-13 by format and checksum. Hyphens and spaces
- * are ignored. An empty string is considered valid (field simply unset).
- */
-export declare function isValidIsbn(value: string): boolean;
-export interface HrefLinkType {
-    id: string;
-    label: string;
-    regex: RegExp;
-    description: string;
-    example: string;
-}
-export declare const HREF_LINK_TYPES: HrefLinkType[];
-export declare function isValidHref(href: string): boolean;
-export declare const DOCUMENT_RULES: {
-    html: {
-        requiredAttributes: string[];
-        dirEnumRef: string;
-        defaultDir: string;
-    };
-    head: {
-        requiredMeta: {
-            name: string;
-            description: string;
-        }[];
-        metaTypeName: string;
-        metaTypeEnumRef: string;
-    };
-};
-/**
- * Verifies that every tag name referenced by the rules above exists in the
- * generated TAGS map, so a docs rename that forgets to update this file is
- * caught at activation time instead of silently breaking completions.
- */
-export declare function checkStructureRules(): string[];

package/dist/toolbar/actions.d.ts

@@ -1,28 +0,0 @@
-import type * as monaco from 'monaco-editor';
-export 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). */
-export 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). */
-export declare function insertSnippetById(editor: monaco.editor.ICodeEditor, id: string): void;
-/** Renumbers every `<div>` id in document order to a sequential 1..n. */
-export 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.
- */
-export 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.
- */
-export declare function registerWemlEditorActions(m: typeof monaco, editor: monaco.editor.IStandaloneCodeEditor, options?: WemlActionOptions): monaco.IDisposable;

package/dist/toolbar/divRenumber.d.ts

@@ -1,12 +0,0 @@
-export 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.
- */
-export declare function planDivIdRenumber(text: string): IdEdit[];

package/dist/toolbar/toolbar.d.ts

@@ -1,27 +0,0 @@
-import type * as monaco from 'monaco-editor';
-import { WemlActionOptions } from './actions';
-export 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;
-}
-export 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.
- */
-export declare function createWemlToolbar(m: typeof monaco, editor: monaco.editor.IStandaloneCodeEditor, options?: WemlToolbarOptions): WemlToolbar;

package/dist/toolbar/wrap.d.ts

@@ -1,11 +0,0 @@
-/** Escapes text so it is inserted literally inside a SnippetString. */
-export declare function escapeSnippet(text: string): string;
-/**
- * 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.
- */
-export declare function buildWrapSnippet(tag: string, type: string | undefined, selection: string): string;