monaco-editor-gdscript 1.0.0

package/LICENSE.md

@@ -0,0 +1,8 @@
+Copyright 2026 Mike Rötgers
+
+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,103 @@
+# monaco-editor-gdscript
+
+GDScript (Godot 4.x) syntax highlighting for the [Monaco Editor](https://microsoft.github.io/monaco-editor/).
+
+[![npm version](https://img.shields.io/npm/v/monaco-editor-gdscript.svg)](https://www.npmjs.com/package/monaco-editor-gdscript)
+[![license](https://img.shields.io/npm/l/monaco-editor-gdscript.svg)](https://github.com/MikeRoetgers/monaco-editor-gdscript/blob/main/LICENSE.md)
+
+## Why? VSCode has gdscript syntax highlighting.
+
+VScode uses the Monaco Editor internally but utilizes TextMate grammars to provide syntax highlighting whereas the standalone Monaco Editor uses the Monarch tokenizer system.
+
+## Installation
+
+```bash
+npm install monaco-editor-gdscript
+```
+
+This package requires `monaco-editor` as a peer dependency (`>=0.30.0`). If you do not already have it installed:
+
+```bash
+npm install monaco-editor
+```
+
+## Usage
+
+### Side-effect import
+
+The simplest way to register GDScript is a bare import. When the module loads, it detects the global `monaco` object and registers the language automatically.
+
+```js
+import 'monaco-editor-gdscript';
+
+const editor = monaco.editor.create(document.getElementById('container'), {
+    value: 'func _ready():\n\tprint("Hello, Godot!")',
+    language: 'gdscript',
+});
+```
+
+> **Note:** Auto-registration relies on a global `monaco` object, which is typically only available when using Monaco's AMD loader or a CDN build. Modern bundlers (webpack, Vite, esbuild) do **not** create a global `monaco`, so the side-effect import will silently do nothing. If you use a bundler, use the explicit `register()` pattern below instead.
+
+### Explicit registration
+
+If you need more control over when registration happens, or if `monaco` is not available as a global, use the named `register` export and pass your Monaco instance directly.
+
+```js
+import { register } from 'monaco-editor-gdscript';
+import * as monaco from 'monaco-editor';
+
+register(monaco);
+
+const editor = monaco.editor.create(document.getElementById('container'), {
+    value: 'func _ready():\n\tprint("Hello, Godot!")',
+    language: 'gdscript',
+});
+```
+
+### Advanced usage
+
+The underlying Monarch language definition and language configuration objects are also exported for consumers who want to customize or extend them. This is useful if you need to register GDScript under a different language ID, or if you want to extend the tokenizer rules before registering.
+
+```js
+import { language, conf } from 'monaco-editor-gdscript';
+```
+
+## What's included
+
+- **Syntax highlighting** via Monaco's Monarch tokenizer covering all GDScript 4.x syntax
+- **Language configuration**: bracket matching, auto-closing pairs, comment toggling (`#`), indentation rules, and folding
+
+### Highlighted elements
+
+- **Keywords** -- `func`, `var`, `class`, `if`, `for`, `match`, `signal`, `enum`, `await`, etc.
+- **Built-in types** -- `Vector2`, `String`, `Array`, `Dictionary`, `PackedByteArray`, etc.
+- **Annotations** -- `@export`, `@onready`, `@tool`, etc.
+- **Built-in constants** -- `true`, `false`, `null`, `PI`, `TAU`, `INF`, `NAN`
+- **Built-in functions** -- `preload`, `print`, `len`, `range`, `clamp`, `lerp`, etc.
+- **Strings** -- single-quoted, double-quoted, triple-quoted multiline, and StringName literals (`&"..."`)
+- **Comments** (`#`) and **doc comments** (`##`)
+- **Numbers** -- integers, floats, hex (`0xFF`), binary (`0b1010`), with underscore separators
+- **Node paths** (`$Node/Path`) and **unique nodes** (`%UniqueNode`)
+- **`self` / `super`** -- highlighted as language variables
+- **Operators** -- `->`, `:=`, and all standard operators
+
+## What's NOT included
+
+- Autocomplete / IntelliSense
+- Go-to-definition / hover info
+- Error checking / diagnostics
+- GDShader support
+- Godot scene file (`.tscn`) support
+
+The scope of this package is intentionally limited to syntax highlighting and basic editor configuration. It does not provide language-server features or support for file formats other than `.gd`.
+
+## License
+
+[MIT](LICENSE.md)
+
+## References
+
+- [Monaco Editor](https://microsoft.github.io/monaco-editor/)
+- [Monaco Monarch documentation](https://microsoft.github.io/monaco-editor/monarch.html)
+- [GDScript reference (Godot 4.x)](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_basics.html)
+- [Godot Engine](https://godotengine.org/)

package/dist/index.d.mts

@@ -0,0 +1,12 @@
+import * as monaco_editor from 'monaco-editor';
+import { languages } from 'monaco-editor';
+
+declare const language: languages.IMonarchLanguage;
+
+declare const conf: languages.LanguageConfiguration;
+
+declare function register(monacoInstance: {
+    languages: typeof monaco_editor.languages;
+}): void;
+
+export { conf, language, register };

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import * as monaco_editor from 'monaco-editor';
+import { languages } from 'monaco-editor';
+
+declare const language: languages.IMonarchLanguage;
+
+declare const conf: languages.LanguageConfiguration;
+
+declare function register(monacoInstance: {
+    languages: typeof monaco_editor.languages;
+}): void;
+
+export { conf, language, register };

package/dist/index.js

@@ -0,0 +1,279 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  conf: () => conf,
+  language: () => language,
+  register: () => register
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/gdscript.ts
+var language = {
+  defaultToken: "",
+  tokenPostfix: ".gdscript",
+  keywords: [
+    "if",
+    "elif",
+    "else",
+    "for",
+    "while",
+    "match",
+    "when",
+    "break",
+    "continue",
+    "pass",
+    "return",
+    "func",
+    "class",
+    "class_name",
+    "extends",
+    "is",
+    "var",
+    "const",
+    "enum",
+    "signal",
+    "static",
+    "await",
+    "yield",
+    "and",
+    "or",
+    "not",
+    "in",
+    "as",
+    "void",
+    "breakpoint"
+  ],
+  builtinTypes: [
+    "bool",
+    "int",
+    "float",
+    "String",
+    "StringName",
+    "NodePath",
+    "Vector2",
+    "Vector2i",
+    "Vector3",
+    "Vector3i",
+    "Vector4",
+    "Vector4i",
+    "Color",
+    "Rect2",
+    "Rect2i",
+    "Transform2D",
+    "Transform3D",
+    "Basis",
+    "Quaternion",
+    "Projection",
+    "AABB",
+    "Plane",
+    "RID",
+    "Array",
+    "Dictionary",
+    "Callable",
+    "Signal",
+    "PackedByteArray",
+    "PackedInt32Array",
+    "PackedInt64Array",
+    "PackedFloat32Array",
+    "PackedFloat64Array",
+    "PackedStringArray",
+    "PackedVector2Array",
+    "PackedVector3Array",
+    "PackedVector4Array",
+    "PackedColorArray"
+  ],
+  builtinConstants: [
+    "true",
+    "false",
+    "null"
+  ],
+  numericConstants: [
+    "PI",
+    "TAU",
+    "INF",
+    "NAN"
+  ],
+  builtinFunctions: [
+    "preload",
+    "load",
+    "print",
+    "print_rich",
+    "print_verbose",
+    "prints",
+    "printt",
+    "printerr",
+    "push_error",
+    "push_warning",
+    "str",
+    "len",
+    "range",
+    "type_of",
+    "typeof",
+    "is_instance_of",
+    "is_instance_valid",
+    "abs",
+    "sign",
+    "ceil",
+    "floor",
+    "round",
+    "clamp",
+    "lerp",
+    "min",
+    "max",
+    "pow",
+    "sqrt",
+    "log",
+    "exp",
+    "sin",
+    "cos",
+    "tan",
+    "asin",
+    "acos",
+    "atan",
+    "atan2",
+    "deg_to_rad",
+    "rad_to_deg",
+    "randf",
+    "randi",
+    "randfn",
+    "randf_range",
+    "randi_range",
+    "seed",
+    "randomize",
+    "get_node",
+    "get_node_or_null",
+    "has_node",
+    "instance_from_id",
+    "is_same",
+    "weakref"
+  ],
+  selfSuper: [
+    "self",
+    "super"
+  ],
+  tokenizer: {
+    root: [
+      // 1. Doc comments (## ...) — must be before regular comments
+      [/##.*$/, "comment.doc"],
+      // 2. Regular comments (# ...)
+      [/#.*$/, "comment"],
+      // 3. Annotations (@export, @onready, etc.)
+      [/@[a-zA-Z_]\w*/, "annotation"],
+      // 4. StringName literals (&"...") — MUST come before regular strings
+      [/&"([^"\\]|\\.)*"/, "string.special"],
+      // 5. Triple-quoted strings (multiline) — must be before single-line strings
+      [/"""/, "string", "@tripleDoubleString"],
+      [/'''/, "string", "@tripleSingleString"],
+      // 6. Regular strings
+      [/"([^"\\]|\\.)*"/, "string"],
+      [/'([^'\\]|\\.)*'/, "string"],
+      // 7. NodePath shorthand ($"Node/Path" and $Node/Path)
+      [/\$"([^"\\]|\\.)*"/, "variable.other"],
+      [/\$[\w/]+/, "variable.other"],
+      // 8. Unique node shorthand (%NodeName)
+      [/%\w+/, "variable.other"],
+      // 9. Numbers (hex, binary, float, integer)
+      [/0x[0-9a-fA-F_]+/, "number.hex"],
+      [/0b[01_]+/, "number.binary"],
+      [/\d[\d_]*\.[\d_]*([eE][\-+]?\d[\d_]*)?/, "number.float"],
+      [/\d[\d_]*([eE][\-+]?\d[\d_]*)?/, "number"],
+      // 10. Identifiers — case-switch against keyword lists
+      [/[a-zA-Z_]\w*/, {
+        cases: {
+          "@keywords": "keyword",
+          "@builtinTypes": "type",
+          "@builtinConstants": "constant.language",
+          "@numericConstants": "constant.numeric",
+          "@builtinFunctions": "support.function",
+          "@selfSuper": "variable.language",
+          "@default": "identifier"
+        }
+      }],
+      // 11. Operators
+      [/->/, "keyword.operator"],
+      [/:=/, "keyword.operator"],
+      [/[=!<>]=?|[+\-*\/%&|^~]/, "operator"],
+      // 12. Brackets
+      [/[{}()\[\]]/, "@brackets"],
+      // 13. Delimiters
+      [/[;,.:?]/, "delimiter"]
+    ],
+    // States for multiline strings
+    tripleDoubleString: [
+      [/"""/, "string", "@pop"],
+      [/./, "string"]
+    ],
+    tripleSingleString: [
+      [/'''/, "string", "@pop"],
+      [/./, "string"]
+    ]
+  }
+};
+
+// src/configuration.ts
+var conf = {
+  comments: {
+    lineComment: "#"
+  },
+  brackets: [
+    ["(", ")"],
+    ["[", "]"],
+    ["{", "}"]
+  ],
+  autoClosingPairs: [
+    { open: "(", close: ")" },
+    { open: "[", close: "]" },
+    { open: "{", close: "}" },
+    { open: '"', close: '"', notIn: ["string"] },
+    { open: "'", close: "'", notIn: ["string"] }
+  ],
+  surroundingPairs: [
+    { open: "(", close: ")" },
+    { open: "[", close: "]" },
+    { open: "{", close: "}" },
+    { open: '"', close: '"' },
+    { open: "'", close: "'" }
+  ],
+  indentationRules: {
+    increaseIndentPattern: /^\s*(func|class|if|elif|else|for|while|match|when)\b.*:\s*(#.*)?$/,
+    decreaseIndentPattern: /^\s*(elif|else|when)\b/
+  },
+  folding: {
+    offSide: true
+  }
+};
+
+// src/index.ts
+function register(monacoInstance) {
+  monacoInstance.languages.register({ id: "gdscript", extensions: [".gd"] });
+  monacoInstance.languages.setMonarchTokensProvider("gdscript", language);
+  monacoInstance.languages.setLanguageConfiguration("gdscript", conf);
+}
+if (typeof monaco !== "undefined" && monaco && typeof monaco.languages !== "undefined") {
+  register(monaco);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  conf,
+  language,
+  register
+});

package/dist/index.mjs

@@ -0,0 +1,250 @@
+// src/gdscript.ts
+var language = {
+  defaultToken: "",
+  tokenPostfix: ".gdscript",
+  keywords: [
+    "if",
+    "elif",
+    "else",
+    "for",
+    "while",
+    "match",
+    "when",
+    "break",
+    "continue",
+    "pass",
+    "return",
+    "func",
+    "class",
+    "class_name",
+    "extends",
+    "is",
+    "var",
+    "const",
+    "enum",
+    "signal",
+    "static",
+    "await",
+    "yield",
+    "and",
+    "or",
+    "not",
+    "in",
+    "as",
+    "void",
+    "breakpoint"
+  ],
+  builtinTypes: [
+    "bool",
+    "int",
+    "float",
+    "String",
+    "StringName",
+    "NodePath",
+    "Vector2",
+    "Vector2i",
+    "Vector3",
+    "Vector3i",
+    "Vector4",
+    "Vector4i",
+    "Color",
+    "Rect2",
+    "Rect2i",
+    "Transform2D",
+    "Transform3D",
+    "Basis",
+    "Quaternion",
+    "Projection",
+    "AABB",
+    "Plane",
+    "RID",
+    "Array",
+    "Dictionary",
+    "Callable",
+    "Signal",
+    "PackedByteArray",
+    "PackedInt32Array",
+    "PackedInt64Array",
+    "PackedFloat32Array",
+    "PackedFloat64Array",
+    "PackedStringArray",
+    "PackedVector2Array",
+    "PackedVector3Array",
+    "PackedVector4Array",
+    "PackedColorArray"
+  ],
+  builtinConstants: [
+    "true",
+    "false",
+    "null"
+  ],
+  numericConstants: [
+    "PI",
+    "TAU",
+    "INF",
+    "NAN"
+  ],
+  builtinFunctions: [
+    "preload",
+    "load",
+    "print",
+    "print_rich",
+    "print_verbose",
+    "prints",
+    "printt",
+    "printerr",
+    "push_error",
+    "push_warning",
+    "str",
+    "len",
+    "range",
+    "type_of",
+    "typeof",
+    "is_instance_of",
+    "is_instance_valid",
+    "abs",
+    "sign",
+    "ceil",
+    "floor",
+    "round",
+    "clamp",
+    "lerp",
+    "min",
+    "max",
+    "pow",
+    "sqrt",
+    "log",
+    "exp",
+    "sin",
+    "cos",
+    "tan",
+    "asin",
+    "acos",
+    "atan",
+    "atan2",
+    "deg_to_rad",
+    "rad_to_deg",
+    "randf",
+    "randi",
+    "randfn",
+    "randf_range",
+    "randi_range",
+    "seed",
+    "randomize",
+    "get_node",
+    "get_node_or_null",
+    "has_node",
+    "instance_from_id",
+    "is_same",
+    "weakref"
+  ],
+  selfSuper: [
+    "self",
+    "super"
+  ],
+  tokenizer: {
+    root: [
+      // 1. Doc comments (## ...) — must be before regular comments
+      [/##.*$/, "comment.doc"],
+      // 2. Regular comments (# ...)
+      [/#.*$/, "comment"],
+      // 3. Annotations (@export, @onready, etc.)
+      [/@[a-zA-Z_]\w*/, "annotation"],
+      // 4. StringName literals (&"...") — MUST come before regular strings
+      [/&"([^"\\]|\\.)*"/, "string.special"],
+      // 5. Triple-quoted strings (multiline) — must be before single-line strings
+      [/"""/, "string", "@tripleDoubleString"],
+      [/'''/, "string", "@tripleSingleString"],
+      // 6. Regular strings
+      [/"([^"\\]|\\.)*"/, "string"],
+      [/'([^'\\]|\\.)*'/, "string"],
+      // 7. NodePath shorthand ($"Node/Path" and $Node/Path)
+      [/\$"([^"\\]|\\.)*"/, "variable.other"],
+      [/\$[\w/]+/, "variable.other"],
+      // 8. Unique node shorthand (%NodeName)
+      [/%\w+/, "variable.other"],
+      // 9. Numbers (hex, binary, float, integer)
+      [/0x[0-9a-fA-F_]+/, "number.hex"],
+      [/0b[01_]+/, "number.binary"],
+      [/\d[\d_]*\.[\d_]*([eE][\-+]?\d[\d_]*)?/, "number.float"],
+      [/\d[\d_]*([eE][\-+]?\d[\d_]*)?/, "number"],
+      // 10. Identifiers — case-switch against keyword lists
+      [/[a-zA-Z_]\w*/, {
+        cases: {
+          "@keywords": "keyword",
+          "@builtinTypes": "type",
+          "@builtinConstants": "constant.language",
+          "@numericConstants": "constant.numeric",
+          "@builtinFunctions": "support.function",
+          "@selfSuper": "variable.language",
+          "@default": "identifier"
+        }
+      }],
+      // 11. Operators
+      [/->/, "keyword.operator"],
+      [/:=/, "keyword.operator"],
+      [/[=!<>]=?|[+\-*\/%&|^~]/, "operator"],
+      // 12. Brackets
+      [/[{}()\[\]]/, "@brackets"],
+      // 13. Delimiters
+      [/[;,.:?]/, "delimiter"]
+    ],
+    // States for multiline strings
+    tripleDoubleString: [
+      [/"""/, "string", "@pop"],
+      [/./, "string"]
+    ],
+    tripleSingleString: [
+      [/'''/, "string", "@pop"],
+      [/./, "string"]
+    ]
+  }
+};
+
+// src/configuration.ts
+var conf = {
+  comments: {
+    lineComment: "#"
+  },
+  brackets: [
+    ["(", ")"],
+    ["[", "]"],
+    ["{", "}"]
+  ],
+  autoClosingPairs: [
+    { open: "(", close: ")" },
+    { open: "[", close: "]" },
+    { open: "{", close: "}" },
+    { open: '"', close: '"', notIn: ["string"] },
+    { open: "'", close: "'", notIn: ["string"] }
+  ],
+  surroundingPairs: [
+    { open: "(", close: ")" },
+    { open: "[", close: "]" },
+    { open: "{", close: "}" },
+    { open: '"', close: '"' },
+    { open: "'", close: "'" }
+  ],
+  indentationRules: {
+    increaseIndentPattern: /^\s*(func|class|if|elif|else|for|while|match|when)\b.*:\s*(#.*)?$/,
+    decreaseIndentPattern: /^\s*(elif|else|when)\b/
+  },
+  folding: {
+    offSide: true
+  }
+};
+
+// src/index.ts
+function register(monacoInstance) {
+  monacoInstance.languages.register({ id: "gdscript", extensions: [".gd"] });
+  monacoInstance.languages.setMonarchTokensProvider("gdscript", language);
+  monacoInstance.languages.setLanguageConfiguration("gdscript", conf);
+}
+if (typeof monaco !== "undefined" && monaco && typeof monaco.languages !== "undefined") {
+  register(monaco);
+}
+export {
+  conf,
+  language,
+  register
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+    "name": "monaco-editor-gdscript",
+    "version": "1.0.0",
+    "description": "GDScript (Godot 4.x) language support for Monaco Editor",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.mjs",
+            "require": "./dist/index.js"
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "tsup src/index.ts --format cjs,esm --dts",
+        "test": "vitest run",
+        "prepublishOnly": "npm run build"
+    },
+    "peerDependencies": {
+        "monaco-editor": ">=0.30.0"
+    },
+    "devDependencies": {
+        "@types/jsdom": "^27.0.0",
+        "jsdom": "^28.0.0",
+        "monaco-editor": "^0.52.0",
+        "tsup": "^8.0.0",
+        "typescript": "^5.0.0",
+        "vitest": "^2.0.0"
+    },
+    "keywords": [
+        "monaco",
+        "monaco-editor",
+        "gdscript",
+        "godot",
+        "syntax-highlighting",
+        "monarch",
+        "language"
+    ],
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/MikeRoetgers/monaco-editor-gdscript"
+    }
+}