highlightjs-verse 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Abdelrahman Abdelaal
+
+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,128 @@
+# highlightjs-verse
+
+[![npm version](https://img.shields.io/npm/v/highlightjs-verse.svg)](https://www.npmjs.com/package/highlightjs-verse)
+[![CI](https://github.com/abdelrahman-mohammad/highlightjs-verse/actions/workflows/ci.yml/badge.svg)](https://github.com/abdelrahman-mohammad/highlightjs-verse/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+[Verse](https://dev.epicgames.com/documentation/en-us/uefn/verse-language-reference) language grammar and theme for [highlight.js](https://highlightjs.org/).
+
+Verse is the programming language for [Unreal Editor for Fortnite (UEFN)](https://dev.epicgames.com/documentation/en-us/uefn/unreal-editor-for-fortnite-documentation) by Epic Games. This package adds Verse syntax highlighting support to highlight.js with colors matching Epic's official VS Code extension.
+
+## Install
+
+```bash
+npm install highlightjs-verse highlight.js
+```
+
+## Usage
+
+### ES Modules (React, Vue, Vite, webpack)
+
+```js
+import hljs from 'highlight.js/lib/core';
+import verse from 'highlightjs-verse';
+import 'highlightjs-verse/styles/verse-dark.css';
+
+hljs.registerLanguage('verse', verse);
+
+// Highlight a code string
+const result = hljs.highlight(code, { language: 'verse' });
+
+// Or highlight a DOM element
+hljs.highlightElement(document.querySelector('code'));
+```
+
+### CommonJS (Node.js, SSR)
+
+```js
+const hljs = require('highlight.js/lib/core');
+const verse = require('highlightjs-verse');
+
+hljs.registerLanguage('verse', verse);
+
+// Server-side render highlighted HTML
+const html = hljs.highlight(verseCode, { language: 'verse' }).value;
+```
+
+### Browser / CDN
+
+```html
+<!-- highlight.js core -->
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/highlight.js@11/styles/default.min.css">
+<script src="https://cdn.jsdelivr.net/npm/highlight.js@11/highlight.min.js"></script>
+
+<!-- Verse support (auto-registers, no extra JS needed) -->
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/highlightjs-verse@1/styles/verse-dark.css">
+<script src="https://cdn.jsdelivr.net/npm/highlightjs-verse@1/dist/verse.min.js"></script>
+```
+
+The browser build auto-registers the language — just include the script and go:
+
+```html
+<pre><code class="language-verse">
+MyDevice := class(creative_device):
+    @editable
+    Greeting : string = "Hello, Verse!"
+
+    OnBegin<override>()<suspends> : void =
+        Print(Greeting)
+</code></pre>
+```
+
+### Markdown renderers
+
+Works with any markdown renderer that supports highlight.js (markdown-it, marked, rehype, etc.):
+
+```js
+import markdownit from 'markdown-it';
+import hljs from 'highlight.js/lib/core';
+import verse from 'highlightjs-verse';
+
+hljs.registerLanguage('verse', verse);
+
+const md = markdownit({
+    highlight: (str, lang) => {
+        if (lang === 'verse') {
+            return hljs.highlight(str, { language: 'verse' }).value;
+        }
+        return '';
+    }
+});
+```
+
+Now ` ```verse ` code fences in markdown are syntax highlighted.
+
+## What Gets Highlighted
+
+| Token | Examples | Color |
+|---|---|---|
+| Block comments | `<# nested #>` | Green `#77B06B` |
+| Line comments | `# comment` | Green `#77B06B` |
+| Strings | `"Hello {Name}"` | Tan `#C09077` |
+| String interpolation | `{expr}` inside strings | Gold `#B89047` |
+| Escape sequences | `\n`, `\t`, `\"` | Gold `#B89047` |
+| Numbers | `42`, `0xFF`, `3.14e2` | Light green `#c2ddb4` |
+| Control keywords | `return`, `yield`, `break` | Blue `#569cd6` |
+| Block keywords | `with`, `do`, `then`, `else` | Slate blue `#8499b7` |
+| Declaration keywords | `var`, `set`, `ref`, `in` | Slate blue `#8499b7` |
+| Type specifiers | `class`, `struct`, `interface` | Blue `#569cd6` |
+| Operators | `+`, `->`, `=>`, `:=` | Teal `#77AFAF` |
+| Logical operators | `and`, `or`, `not` | Teal `#77AFAF` |
+| Functions/definitions | `MyFunc(...)`, `Name : type` | Purple `#e5c2ff` |
+| Paths | `/Fortnite.com/Devices` | Blue `#569cd6` |
+| Literals | `true`, `false` | Blue `#569cd6` |
+| Punctuation | `:`, `;`, `,`, `@` | Slate blue `#8499b7` |
+
+## Theme
+
+The `verse-dark` theme ships as a standalone CSS file at `styles/verse-dark.css`. Colors are sourced from Epic Games' official [VS Code Verse extension](https://marketplace.visualstudio.com/items?itemName=epicgames.verse) (`verse-dark.tmTheme.json`).
+
+The theme uses a transparent background, so it layers on top of whatever code block styling your site already has. Pair it with highlight.js's built-in dark themes, or use your own.
+
+## Requirements
+
+- highlight.js >= 11.0.0 (peer dependency)
+
+## License
+
+[MIT](LICENSE)

package/dist/verse.es.min.js

@@ -0,0 +1 @@
+var E=(n,e)=>()=>(e||n((e={exports:{}}).exports,e),e.exports);var I=E((O,b)=>{function _(n){var e={keyword:"return yield break continue",built_in:"with do until catch then else of at over when where while next",type:"var set ref alias live in is",literal:"true false"},a={scope:"comment",begin:"<#",end:"#>",contains:["self"],relevance:10},r={scope:"comment",begin:"(?<!<)#(?!>)",end:"$",contains:[a],relevance:0},c={scope:"char.escape",match:`\\\\[rnt'"\\\\{}#<>&~]`,relevance:0},t={scope:"subst",begin:"\\{",end:"\\}",keywords:e,contains:[]},s={scope:"string",begin:'"',end:'"|$',contains:[c,t],relevance:0},i={scope:"string",variants:[{match:`'\\\\[rnt'"\\\\{}#<>&~]'`},{match:"'[^'\\\\]'"},{match:"\\b0[ou][0-9A-Fa-f]+\\b"}],relevance:0},o={scope:"number",variants:[{match:"\\b0x[0-9A-Fa-f]+\\b"},{match:"\\b[0-9]+(?:\\.[0-9]+)?(?:e[+-]?[0-9]+)?\\b"}],relevance:0},v={scope:"link",match:"/[A-Za-z_][A-Za-z0-9_.@/-]*",relevance:5},h={scope:"title.function",match:/[A-Za-z_]\w*(?:'[^']*')?(?=\s*(?:\(|<(?!#)\w))/,relevance:0},m={scope:"title.function",match:/[A-Za-z_]\w*(?:'[^']*')?(?=\s*(?::\s*[A-Za-z_({/\[]|:=))/,relevance:0},u={match:/\b(class|struct|interface|enum|module|trait|unique|abstract|concrete|final|internal|public|private|protected|override|transacts|varies|computes|converges|decides|no_rollback|suspends|native|epic_internal)\b/,scope:"keyword",relevance:5},d={match:/\b(using)\b/,scope:"keyword",relevance:10},l={scope:"operator",match:"<>|<=|>=|=>|->|\\.\\.|[+\\-*/]=|[+\\-*/=<>|]",relevance:0},A={match:/\b(and|or|not)\b/,scope:"operator",relevance:0},p={scope:"punctuation",match:":=|[@&:;,]",relevance:0};return t.contains=[a,r,s,i,o,v,c,p,l],{name:"Verse",aliases:["verse"],case_insensitive:!1,keywords:e,contains:[a,r,s,i,o,v,d,u,h,m,A,p,l]}}b.exports=_});export default I();

package/dist/verse.min.js

@@ -0,0 +1,2 @@
+var hljsDefineVerse=(()=>{var E=(n,e)=>()=>(e||n((e={exports:{}}).exports,e),e.exports);var I=E((O,b)=>{function _(n){var e={keyword:"return yield break continue",built_in:"with do until catch then else of at over when where while next",type:"var set ref alias live in is",literal:"true false"},a={scope:"comment",begin:"<#",end:"#>",contains:["self"],relevance:10},r={scope:"comment",begin:"(?<!<)#(?!>)",end:"$",contains:[a],relevance:0},c={scope:"char.escape",match:`\\\\[rnt'"\\\\{}#<>&~]`,relevance:0},t={scope:"subst",begin:"\\{",end:"\\}",keywords:e,contains:[]},s={scope:"string",begin:'"',end:'"|$',contains:[c,t],relevance:0},i={scope:"string",variants:[{match:`'\\\\[rnt'"\\\\{}#<>&~]'`},{match:"'[^'\\\\]'"},{match:"\\b0[ou][0-9A-Fa-f]+\\b"}],relevance:0},o={scope:"number",variants:[{match:"\\b0x[0-9A-Fa-f]+\\b"},{match:"\\b[0-9]+(?:\\.[0-9]+)?(?:e[+-]?[0-9]+)?\\b"}],relevance:0},v={scope:"link",match:"/[A-Za-z_][A-Za-z0-9_.@/-]*",relevance:5},h={scope:"title.function",match:/[A-Za-z_]\w*(?:'[^']*')?(?=\s*(?:\(|<(?!#)\w))/,relevance:0},m={scope:"title.function",match:/[A-Za-z_]\w*(?:'[^']*')?(?=\s*(?::\s*[A-Za-z_({/\[]|:=))/,relevance:0},u={match:/\b(class|struct|interface|enum|module|trait|unique|abstract|concrete|final|internal|public|private|protected|override|transacts|varies|computes|converges|decides|no_rollback|suspends|native|epic_internal)\b/,scope:"keyword",relevance:5},d={match:/\b(using)\b/,scope:"keyword",relevance:10},l={scope:"operator",match:"<>|<=|>=|=>|->|\\.\\.|[+\\-*/]=|[+\\-*/=<>|]",relevance:0},A={match:/\b(and|or|not)\b/,scope:"operator",relevance:0},p={scope:"punctuation",match:":=|[@&:;,]",relevance:0};return t.contains=[a,r,s,i,o,v,c,p,l],{name:"Verse",aliases:["verse"],case_insensitive:!1,keywords:e,contains:[a,r,s,i,o,v,d,u,h,m,A,p,l]}}b.exports=_});return I();})();
+if(typeof hljs!=="undefined"){hljs.registerLanguage("verse",hljsDefineVerse);}

package/package.json

@@ -0,0 +1,53 @@
+{
+    "name": "highlightjs-verse",
+    "version": "1.0.0",
+    "description": "Verse (Epic Games UEFN) language grammar and theme for highlight.js",
+    "main": "src/languages/verse.js",
+    "module": "dist/verse.es.min.js",
+    "exports": {
+        ".": {
+            "import": "./dist/verse.es.min.js",
+            "require": "./src/languages/verse.js",
+            "default": "./src/languages/verse.js"
+        },
+        "./styles/*": "./styles/*"
+    },
+    "files": [
+        "src/",
+        "dist/",
+        "styles/"
+    ],
+    "scripts": {
+        "build": "node build.mjs",
+        "test": "jest",
+        "prepublishOnly": "npm run build"
+    },
+    "peerDependencies": {
+        "highlight.js": ">=11.0.0"
+    },
+    "devDependencies": {
+        "esbuild": "^0.25.0",
+        "highlight.js": "^11.11.1",
+        "jest": "^30.3.0"
+    },
+    "keywords": [
+        "verse",
+        "uefn",
+        "epic-games",
+        "fortnite",
+        "highlight.js",
+        "highlightjs",
+        "syntax",
+        "syntax-highlighting"
+    ],
+    "author": "Abdelrahman Abdelaal",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/abdelrahman-mohammad/highlightjs-verse.git"
+    },
+    "bugs": {
+        "url": "https://github.com/abdelrahman-mohammad/highlightjs-verse/issues"
+    },
+    "homepage": "https://github.com/abdelrahman-mohammad/highlightjs-verse#readme"
+}

package/src/languages/verse.js

@@ -0,0 +1,212 @@
+/**
+ * Verse language definition for highlight.js
+ *
+ * Based on Epic Games' TextMate grammar (verse.json) and verse-dark.tmTheme.json
+ * from the VS Code Verse extension (epicgames.verse).
+ *
+ * Scope -> color mapping (verse-dark):
+ *   keyword.control      (#569cd6 blue)      -> hljs keyword
+ *   keyword.declaration  (#8499b7 slate blue) -> hljs built_in / type
+ *   keyword.operator     (#77AFAF teal)       -> hljs operator
+ *   entity.name.function (#e5c2ff purple)     -> hljs title.function
+ *   variable             (#b9d6ff light blue) -> hljs variable
+ *   punctuation.definition.tag (#8499b7 slate) -> hljs punctuation
+ *   constant.language    (#569cd6 blue)       -> hljs link (paths)
+ *   constant.numeric     (#c2ddb4 light green) -> hljs number
+ *   comment              (#77B06B green)       -> hljs comment
+ *   string               (#C09077 tan)         -> hljs string
+ *   constant.character.escape (#B89047 gold)   -> hljs char.escape
+ *
+ * @see https://dev.epicgames.com/documentation/en-us/uefn/verse-language-reference
+ */
+function hljsDefineVerse(hljs) {
+    // --- Keywords --------------------------------------------------------
+    // Grouped by TextMate scope for correct color mapping:
+    //   keyword  -> keyword.control.verse  (#569cd6 blue)
+    //   built_in -> keyword.declaration.verse (#8499b7 slate blue)
+    //   type     -> keyword.declaration.verse (#8499b7 slate blue)
+    //   literal  -> constant.language (#569cd6 blue)
+    var KEYWORDS = {
+        keyword: 'return yield break continue',
+        built_in: 'with do until catch then else of at over when where while next',
+        type: 'var set ref alias live in is',
+        literal: 'true false'
+    };
+
+    // --- Block comment: <# ... #> (nestable) -----------------------------
+    var BLOCK_COMMENT = {
+        scope: 'comment',
+        begin: '<#',
+        end: '#>',
+        contains: ['self'],
+        relevance: 10
+    };
+
+    // --- Line comment: # to EOL (not part of <# or #>) ------------------
+    // Official grammar: (?<!<)#(?!>) with nested BlockCmt support
+    var LINE_COMMENT = {
+        scope: 'comment',
+        begin: '(?<!<)#(?!>)',
+        end: '$',
+        contains: [BLOCK_COMMENT],
+        relevance: 0
+    };
+
+    // --- Escape sequences inside strings/chars ---------------------------
+    // Official: \\(\<(?!#)|[rnt'\\"\\{}#<>&~]|$)
+    var ESCAPE = {
+        scope: 'char.escape',
+        match: '\\\\[rnt\'"\\\\{}#<>&~]',
+        relevance: 0
+    };
+
+    // --- String interpolation: {expr} inside strings ---------------------
+    // Official scope: constant.character.escape for { and }
+    var INTERPOLATION = {
+        scope: 'subst',
+        begin: '\\{',
+        end: '\\}',
+        keywords: KEYWORDS,
+        contains: []  // filled below to allow recursion
+    };
+
+    // --- Double-quoted string: "..." -------------------------------------
+    var STRING = {
+        scope: 'string',
+        begin: '"',
+        end: '"|$',
+        contains: [ESCAPE, INTERPOLATION],
+        relevance: 0
+    };
+
+    // --- Character literals: 'x', '\n', 0o/0u hex -----------------------
+    // Official: CharLit0 ('x'), CharLit1 ('\n'), Char8 (0o_), Char32 (0u_)
+    var CHAR_LITERAL = {
+        scope: 'string',
+        variants: [
+            { match: "'\\\\[rnt'\"\\\\{}#<>&~]'" },
+            { match: "'[^'\\\\]'" },
+            { match: '\\b0[ou][0-9A-Fa-f]+\\b' }
+        ],
+        relevance: 0
+    };
+
+    // --- Numbers: 0x hex, decimal, float, optional unit ------------------
+    // Official: 0x hex, then (?!0o|0u)[0-9]+ with optional .frac, exp, unit
+    var NUMBER = {
+        scope: 'number',
+        variants: [
+            { match: '\\b0x[0-9A-Fa-f]+\\b' },
+            { match: '\\b[0-9]+(?:\\.[0-9]+)?(?:e[+-]?[0-9]+)?\\b' }
+        ],
+        relevance: 0
+    };
+
+    // --- Paths: /Package/Module/Type -------------------------------------
+    // Official scope: constant.language.path.verse -> blue via constant.language
+    var PATH = {
+        scope: 'link',
+        match: '/[A-Za-z_][A-Za-z0-9_.@/-]*',
+        relevance: 5
+    };
+
+    // --- Function / method call: name( or name<spec> ---------------------
+    // Official scope: entity.name.function.verse (#e5c2ff purple)
+    // Matches identifiers before ( or <word (not <# which starts a comment)
+    var FUNCTION_CALL = {
+        scope: 'title.function',
+        match: /[A-Za-z_]\w*(?:'[^']*')?(?=\s*(?:\(|<(?!#)\w))/,
+        relevance: 0
+    };
+
+    // --- Definition: name : type or name := -----------------------------
+    // Approximates DefineIdent1/DefineIdent2 from official grammar.
+    // Official scope: entity.name.function.verse (#e5c2ff purple)
+    var DEFINITION = {
+        scope: 'title.function',
+        match: /[A-Za-z_]\w*(?:'[^']*')?(?=\s*(?::\s*[A-Za-z_({/\[]|:=))/,
+        relevance: 0
+    };
+
+    // --- Class/struct/interface/enum specifiers ---------------------------
+    // Not separate keywords in the official grammar (just identifiers),
+    // but highlighting these as keywords improves readability.
+    var TYPE_SPECIFIER = {
+        match: /\b(class|struct|interface|enum|module|trait|unique|abstract|concrete|final|internal|public|private|protected|override|transacts|varies|computes|converges|decides|no_rollback|suspends|native|epic_internal)\b/,
+        scope: 'keyword',
+        relevance: 5
+    };
+
+    // --- Using statement -------------------------------------------------
+    var USING = {
+        match: /\b(using)\b/,
+        scope: 'keyword',
+        relevance: 10
+    };
+
+    // --- Operators -------------------------------------------------------
+    // Official scopes: keyword.operator.verse, keyword.operator.arithmetic,
+    // keyword.operator.comparison -> all #77AFAF teal
+    var OPERATOR = {
+        scope: 'operator',
+        match: '<>|<=|>=|=>|->|\\.\\.|[+\\-*/]=|[+\\-*/=<>|]',
+        relevance: 0
+    };
+
+    // --- Logical operator keywords ---------------------------------------
+    // Official scope: keyword.operator.logical.verse (#77AFAF teal)
+    var LOGICAL_OPERATOR = {
+        match: /\b(and|or|not)\b/,
+        scope: 'operator',
+        relevance: 0
+    };
+
+    // --- Definition punctuation ------------------------------------------
+    // Official scope: punctuation.definition.tag (#8499b7 slate blue)
+    // := is definition assignment, @ is decorator/attribute, & is reference
+    var PUNCTUATION = {
+        scope: 'punctuation',
+        match: ':=|[@&:;,]',
+        relevance: 0
+    };
+
+    // Fill interpolation contents (recursive references)
+    INTERPOLATION.contains = [
+        BLOCK_COMMENT,
+        LINE_COMMENT,
+        STRING,
+        CHAR_LITERAL,
+        NUMBER,
+        PATH,
+        ESCAPE,
+        PUNCTUATION,
+        OPERATOR
+    ];
+
+    // Base text color set to #b9d6ff (variable/identifier) in CSS,
+    // so unmatched identifiers naturally appear light blue.
+    // Keywords override via the keywords property on root.
+    return {
+        name: 'Verse',
+        aliases: ['verse'],
+        case_insensitive: false,
+        keywords: KEYWORDS,
+        contains: [
+            BLOCK_COMMENT,
+            LINE_COMMENT,
+            STRING,
+            CHAR_LITERAL,
+            NUMBER,
+            PATH,
+            USING,
+            TYPE_SPECIFIER,
+            FUNCTION_CALL,
+            DEFINITION,
+            LOGICAL_OPERATOR,
+            PUNCTUATION,
+            OPERATOR
+        ]
+    };
+}
+
+module.exports = hljsDefineVerse;

package/styles/verse-dark.css

@@ -0,0 +1,111 @@
+/**
+ * Verse Dark theme for highlight.js
+ *
+ * Colors sourced from Epic Games' verse-dark.tmTheme.json
+ * (VS Code Verse extension). Background is transparent so
+ * the dashboard's existing code-block styles remain in control.
+ */
+
+/* Base — light blue (variable/identifier) as default text color.
+   Official theme: editor.foreground is #D4D4D4, but identifiers
+   (variable.verse) are #b9d6ff. Since most code text IS identifiers,
+   using the identifier color as default gives the closest match. */
+.hljs {
+    color: #b9d6ff;
+    background: transparent;
+}
+
+/* Comments — green (official theme: no italic) */
+.hljs-comment {
+    color: #77B06B;
+}
+
+/* Strings — tan */
+.hljs-string {
+    color: #C09077;
+}
+
+/* Escape characters — gold */
+.hljs-char\.escape {
+    color: #B89047;
+}
+
+/* String interpolation — gold */
+.hljs-subst {
+    color: #B89047;
+}
+
+/* Numbers — light green */
+.hljs-number {
+    color: #c2ddb4;
+}
+
+/* Keywords (control flow) — blue */
+.hljs-keyword {
+    color: #569cd6;
+}
+
+/* Built-in / block keywords — slate blue */
+.hljs-built_in {
+    color: #8499b7;
+}
+
+/* Declaration keywords (var, set, ref, etc.) — slate blue */
+.hljs-type {
+    color: #8499b7;
+}
+
+/* Operators — teal */
+.hljs-operator {
+    color: #77AFAF;
+}
+
+/* Defined names / functions — light purple */
+.hljs-title,
+.hljs-title\.function {
+    color: #e5c2ff;
+}
+
+/* Paths (/Package/Module) — blue */
+.hljs-link {
+    color: #569cd6;
+    text-decoration: none;
+}
+
+/* Literals (true/false) — blue */
+.hljs-literal {
+    color: #569cd6;
+}
+
+/* Punctuation (: ; ,) — slate blue */
+.hljs-punctuation {
+    color: #8499b7;
+}
+
+/* Variables / referenced identifiers — light blue */
+.hljs-variable {
+    color: #b9d6ff;
+}
+
+/* Tags (markup) — muted purple */
+.hljs-tag {
+    color: #6F77A6;
+}
+
+.hljs-name {
+    color: #8499b7;
+}
+
+/* Section headers in output (relevance metadata) */
+.hljs-section {
+    color: #e5c2ff;
+}
+
+/* Emphasis within comments */
+.hljs-emphasis {
+    font-style: italic;
+}
+
+.hljs-strong {
+    font-weight: bold;
+}