@mermaid-js/language-service 0.0.0-stage → 13.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 - 2022 Knut Sveidqvist
+
+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

@@ -1,3 +1,44 @@
-# Temporary Holding Version
+# @mermaid-js/language-service
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An editor-agnostic language service for Mermaid: diagnostics, go to definition, references, rename, hover, completion (front-matter `config:` included), folding, semantic tokens, and a cursor ↔ AST map for live previews. It has no runtime dependencies. `@mermaid-js/core` is a peer, and each diagram's language support (its _facet_) is an optional peer that loads on `preload()`.
+
+Use it directly, or through an adapter: `@mermaid-js/language-server` for any LSP editor, `@mermaid-js/language-service-codemirror` for CodeMirror 6, `@mermaid-js/language-service-monaco` for Monaco.
+
+## Setup
+
+```sh
+npm install @mermaid-js/language-service @mermaid-js/core @mermaid-js/diagram-flowchart
+```
+
+```ts
+import { createLanguageService } from '@mermaid-js/language-service';
+
+const service = createLanguageService();
+await service.preload(); // load the facets before the first update
+
+const doc = service.update('file:///a.mmd', text); // synchronous, complete, immutable
+doc.diagnostics();
+doc.completions(offset);
+doc.rename(offset, 'NewName'); // { edits } or { refused: reason }
+doc.lineFoldingRanges(); // folds by line, as editors show them
+doc.lineSemanticTokens(); // tokens cut per line
+```
+
+Call `preload()` (or `preload({ types: ['flowchart'] })`) once, before the first `update`. A type whose facet is not loaded gets a `LANGUAGE_NOT_LOADED` diagnostic and generic features only; a facet that fails to load gets `LANGUAGE_LOAD_FAILED`, and one whose parser throws gets `LANGUAGE_FACET_FAILED`. `preload` never rejects.
+
+Positions are UTF-16 offsets into the whole text (front matter included). `doc.lines()` converts to 0-based line and column.
+
+## Third-party diagram types
+
+Pass their rows to `createLanguageService({ facets: [{ type, id, detector, load }] })`. A facet is written against the types this package re-exports (`LanguageFacet`, `ParseResult`, `ProbeResult`, `DocumentView`, `HoverTarget`, …). The shared golden suite runs from `@mermaid-js/language-service/testing` (Node only).
+
+The language server does not load third-party facets by default: a client opts in with `initializationOptions: { mermaid: { plugins: true } }` (D157), so opening an untrusted folder runs none of its code.
+
+## Bundlers
+
+- **Optional peers.** The first-party facets are dynamic imports of optional peers, such as `@mermaid-js/diagram-flowchart/language`. Bundlers resolve them at build time: install the diagram packages you want, or mark the missing ones external. Otherwise the build can fail instead of the service reporting `LANGUAGE_LOAD_FAILED`.
+- **No top-level `await` of `preload()` in a Vite entry.** The facet and config-schema chunks import shared code from the entry chunk. An entry that awaits them at top level never finishes loading, with no error. Wrap the setup in a function: `async function start() { await service.preload(); … } void start();`.
+
+## Limitations
+
+- Language support exists for flowchart, sequence, class, state and ER diagrams. Other types get generic features: comments, directives, and front-matter config.

package/package.json

@@ -1,6 +1,69 @@
 {
   "name": "@mermaid-js/language-service",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "13.0.0-alpha.0",
+  "description": "Editor-agnostic Mermaid language service: diagnostics, navigation, rename, folding, semantic tokens.",
+  "type": "module",
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./testing": {
+      "types": "./dist/testing/index.d.ts",
+      "default": "./dist/testing/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "peerDependencies": {
+    "@mermaid-js/diagram-class": "13.0.0-alpha.0",
+    "@mermaid-js/core": "13.0.0-alpha.0",
+    "@mermaid-js/diagram-flowchart": "13.0.0-alpha.0",
+    "@mermaid-js/diagram-pie": "13.0.0-alpha.0",
+    "@mermaid-js/diagram-er": "13.0.0-alpha.0",
+    "@mermaid-js/diagram-journey": "13.0.0-alpha.0",
+    "@mermaid-js/diagram-quadrant": "13.0.0-alpha.0",
+    "@mermaid-js/diagram-sequence": "13.0.0-alpha.0",
+    "@mermaid-js/diagram-state": "13.0.0-alpha.0",
+    "@mermaid-js/diagram-timeline": "13.0.0-alpha.0"
+  },
+  "peerDependenciesMeta": {
+    "@mermaid-js/diagram-class": {
+      "optional": true
+    },
+    "@mermaid-js/diagram-er": {
+      "optional": true
+    },
+    "@mermaid-js/diagram-flowchart": {
+      "optional": true
+    },
+    "@mermaid-js/diagram-journey": {
+      "optional": true
+    },
+    "@mermaid-js/diagram-pie": {
+      "optional": true
+    },
+    "@mermaid-js/diagram-quadrant": {
+      "optional": true
+    },
+    "@mermaid-js/diagram-sequence": {
+      "optional": true
+    },
+    "@mermaid-js/diagram-state": {
+      "optional": true
+    },
+    "@mermaid-js/diagram-timeline": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && tsc -p tsconfig.testing.json",
+    "typecheck": "tsc -p tsconfig.json"
+  }
+}