@gaijin/highlightjs-blk 0.0.0-stage → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gaijin Entertainment
+
+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,33 @@
-# Temporary Holding Version
+# @gaijin/highlightjs-blk
 
-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.
+A [highlight.js](https://highlightjs.org/) 11 grammar for BLK, the DataBlock text format of the
+[Dagor Engine](https://github.com/GaijinEntertainment/DagorEngine). The language name is `blk`.
+
+## Usage
+
+```sh
+npm install highlight.js @gaijin/highlightjs-blk
+```
+
+```js
+import hljs from 'highlight.js/lib/core';
+import blk from '@gaijin/highlightjs-blk';
+
+hljs.registerLanguage('blk', blk);
+const html = hljs.highlight(code, {language: 'blk'}).value;
+```
+
+In a web page, load `dist/blk.min.js` after highlight.js. The script registers the grammar on the global `hljs`:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@gaijin/highlightjs-blk/dist/blk.min.js"></script>
+```
+
+## References
+
+- [GaijinEntertainment/tree-sitter-blk](https://github.com/GaijinEntertainment/tree-sitter-blk), the tree-sitter
+  grammar that this grammar follows.
+
+## License
+
+MIT. See [LICENSE](LICENSE).

package/dist/blk.d.ts

@@ -0,0 +1,4 @@
+import { HLJSApi, Language } from "highlight.js";
+//#region src/blk.d.ts
+export default function blk(hljs: HLJSApi): Language;
+//#endregion

package/dist/blk.js

@@ -0,0 +1,201 @@
+//#region src/blk.ts
+const TEXT_TYPES = ["t"];
+const BOOLEAN_TYPES = ["b"];
+const NUMBER_TYPES = [
+	"i64",
+	"ip2",
+	"ip3",
+	"ip4",
+	"p2",
+	"p3",
+	"p4",
+	"i",
+	"c",
+	"r",
+	"m"
+];
+const TYPE_WORDS = [
+	...NUMBER_TYPES,
+	...TEXT_TYPES,
+	...BOOLEAN_TYPES
+];
+const BOOLEAN_WORDS = [
+	"yes",
+	"no",
+	"true",
+	"false",
+	"on",
+	"off"
+];
+const NAME = "[A-Za-z0-9_.~-]+";
+const QUOTE = "(?:\"\"\"|'''|\"|')";
+const INCLUDE_WORD = "[iI][nN][cC][lL][uU][dD][eE]";
+function typeName(types) {
+	return `${QUOTE}?~?(?:${types.join("|")})${QUOTE}?`;
+}
+function unquotedValue(stops) {
+	const slash = "\\/(?![/*])";
+	const last = `(?:[^\\s;}/${stops}]|${slash})`;
+	return `${`(?:[^\\s;}/"'${stops}]|${slash})`}(?:${`(?:[^;}\\r\\n/${stops}]|${slash}|${`\\/\\*(?:(?!\\*\\/)[^\\r\\n])*\\*\\/(?=[ \\t]*${last})`})`}*${last})?`;
+}
+function blk(hljs) {
+	const STRING = {
+		scope: "string",
+		contains: [{
+			begin: /~[\s\S]/,
+			relevance: 0
+		}],
+		variants: [
+			{
+				begin: /"""/,
+				end: /"""/
+			},
+			{
+				begin: /'''/,
+				end: /'''/
+			},
+			{
+				begin: /"/,
+				end: /"|(?=\n)/
+			},
+			{
+				begin: /'/,
+				end: /'|(?=\n)/
+			}
+		]
+	};
+	const BLOCK_COMMENT = {
+		scope: "comment",
+		begin: /\/\*/,
+		end: /\*\//,
+		contains: ["self"]
+	};
+	const COMMENT_AFTER_UNQUOTED = {
+		scope: "comment",
+		begin: /(?<=[^\s;=[\]"'{}][ \t]*)\/\*/,
+		end: /\*\//
+	};
+	const value = (equals, scope, end = /(?=[;}\r\n]|\s*\/\/)/) => ({
+		begin: equals,
+		end,
+		contains: [
+			{
+				...COMMENT_AFTER_UNQUOTED,
+				endsParent: true
+			},
+			BLOCK_COMMENT,
+			{
+				...STRING,
+				endsParent: true
+			},
+			{
+				scope,
+				begin: new RegExp(unquotedValue(""))
+			}
+		]
+	});
+	const typedEquals = (types) => new RegExp(`(?<=:[ \\t]*${typeName(types)}[ \\t]*(?:;[ \\t]*)?)=`);
+	const ELEMENT = unquotedValue("\\]");
+	const ARRAY = {
+		begin: /(?<=\[\][ \t]*=\s*)\[/,
+		end: /\]/,
+		contains: [
+			hljs.C_LINE_COMMENT_MODE,
+			COMMENT_AFTER_UNQUOTED,
+			BLOCK_COMMENT,
+			STRING,
+			{
+				scope: "literal",
+				begin: new RegExp(`(?:${BOOLEAN_WORDS.join("|")})(?=[ \\t]*(?:[;}\\]\\r\\n]|\\/[/*]|$))`)
+			},
+			{
+				scope: "number",
+				begin: new RegExp(`(?=[-+.0-9])${ELEMENT}`)
+			},
+			{
+				scope: "string",
+				begin: new RegExp(ELEMENT)
+			}
+		]
+	};
+	const TYPE = {
+		begin: /:[ \t]*/,
+		end: /(?=\[|=|;|\s|\n|$)/,
+		contains: [{
+			scope: "type",
+			begin: new RegExp(`(?<![A-Za-z0-9_])${QUOTE}?~?(?:${TYPE_WORDS.join("|")})(?![A-Za-z0-9_])${QUOTE}?`)
+		}]
+	};
+	const INCLUDE = {
+		begin: new RegExp(`(?<![A-Za-z0-9_.~-])(?:(${QUOTE})${INCLUDE_WORD}\\1|${INCLUDE_WORD}(?![A-Za-z0-9_.~-]))(?![ \\t]*(?:[{:]|=[ \\t]*(?:[^\\s"']|"[^"\\n]*"|'[^'\\n]*')))`),
+		beginScope: "keyword",
+		end: /(?=[;}])/,
+		contains: [
+			{ begin: /(?<=["'])[ \t]*;/ },
+			BLOCK_COMMENT,
+			hljs.C_LINE_COMMENT_MODE,
+			{
+				...STRING,
+				endsParent: true
+			},
+			{
+				scope: "string",
+				begin: new RegExp(unquotedValue("")),
+				endsParent: true
+			}
+		]
+	};
+	return {
+		name: "BLK",
+		contains: [
+			BLOCK_COMMENT,
+			hljs.C_LINE_COMMENT_MODE,
+			INCLUDE,
+			{
+				scope: "meta",
+				begin: new RegExp(`${QUOTE}~?@[^"'\\n]*?${QUOTE}`)
+			},
+			{
+				scope: "built_in",
+				begin: new RegExp(`${QUOTE}~?_[^"'\\n]*?${QUOTE}(?=\\s*(?:;\\s*)?\\{)`)
+			},
+			{
+				scope: "built_in",
+				begin: new RegExp(`${QUOTE}~?_[^"'\\n]*?${QUOTE}(?=\\s*(?:;\\s*)?[:=])`)
+			},
+			{
+				scope: "title",
+				begin: new RegExp(`${QUOTE}~?[^"'\\n]*?${QUOTE}(?=\\s*(?:;\\s*)?\\{)`)
+			},
+			{
+				scope: "attr",
+				begin: new RegExp(`${QUOTE}~?[^"'\\n]*?${QUOTE}(?=\\s*(?:;\\s*)?[:=])`)
+			},
+			{
+				scope: "built_in",
+				begin: new RegExp(`_${NAME}(?=\\s*\\{)`)
+			},
+			{
+				scope: "title",
+				begin: new RegExp(`(?!_)${NAME}(?=\\s*\\{)`)
+			},
+			{
+				scope: "built_in",
+				begin: new RegExp(`_${NAME}(?=\\s*[:=])`)
+			},
+			{
+				scope: "attr",
+				begin: new RegExp(`(?!_)${NAME}(?=\\s*[:=])`)
+			},
+			TYPE,
+			ARRAY,
+			value(typedEquals(TEXT_TYPES), "string"),
+			value(typedEquals(BOOLEAN_TYPES), "literal"),
+			value(typedEquals(NUMBER_TYPES), "number"),
+			value(/(?<!\[\][ \t]*)=/, "string", /(?=[;}]|\s*\/\/)|(?<!=[ \t]*)(?=[\r\n])/),
+			STRING
+		]
+	};
+}
+//#endregion
+export { blk as default };

package/dist/blk.min.js

@@ -0,0 +1,2 @@
+var hljsBlk=(function(){let e=[`t`],t=[`b`],n=[`i64`,`ip2`,`ip3`,`ip4`,`p2`,`p3`,`p4`,`i`,`c`,`r`,`m`],r=[...n,...e,...t],i=[`yes`,`no`,`true`,`false`,`on`,`off`],a=`[A-Za-z0-9_.~-]+`,o=`(?:"""|'''|"|')`,s=`[iI][nN][cC][lL][uU][dD][eE]`;function c(e){return`${o}?~?(?:${e.join(`|`)})${o}?`}function l(e){let t=`\\/(?![/*])`,n=`(?:[^\\s;}/${e}]|${t})`;return`${`(?:[^\\s;}/"'${e}]|${t})`}(?:${`(?:[^;}\\r\\n/${e}]|${t}|${`\\/\\*(?:(?!\\*\\/)[^\\r\\n])*\\*\\/(?=[ \\t]*${n})`})`}*${n})?`}function u(u){let d={scope:`string`,contains:[{begin:/~[\s\S]/,relevance:0}],variants:[{begin:/"""/,end:/"""/},{begin:/'''/,end:/'''/},{begin:/"/,end:/"|(?=\n)/},{begin:/'/,end:/'|(?=\n)/}]},f={scope:`comment`,begin:/\/\*/,end:/\*\//,contains:[`self`]},p={scope:`comment`,begin:/(?<=[^\s;=[\]"'{}][ \t]*)\/\*/,end:/\*\//},m=(e,t,n=/(?=[;}\r\n]|\s*\/\/)/)=>({begin:e,end:n,contains:[{...p,endsParent:!0},f,{...d,endsParent:!0},{scope:t,begin:new RegExp(l(``))}]}),h=e=>RegExp(`(?<=:[ \\t]*${c(e)}[ \\t]*(?:;[ \\t]*)?)=`),g=l(`\\]`),_={begin:/(?<=\[\][ \t]*=\s*)\[/,end:/\]/,contains:[u.C_LINE_COMMENT_MODE,p,f,d,{scope:`literal`,begin:RegExp(`(?:${i.join(`|`)})(?=[ \\t]*(?:[;}\\]\\r\\n]|\\/[/*]|$))`)},{scope:`number`,begin:RegExp(`(?=[-+.0-9])${g}`)},{scope:`string`,begin:new RegExp(g)}]},v={begin:/:[ \t]*/,end:/(?=\[|=|;|\s|\n|$)/,contains:[{scope:`type`,begin:RegExp(`(?<![A-Za-z0-9_])${o}?~?(?:${r.join(`|`)})(?![A-Za-z0-9_])${o}?`)}]},y={begin:RegExp(`(?<![A-Za-z0-9_.~-])(?:(${o})${s}\\1|${s}(?![A-Za-z0-9_.~-]))(?![ \\t]*(?:[{:]|=[ \\t]*(?:[^\\s"']|"[^"\\n]*"|'[^'\\n]*')))`),beginScope:`keyword`,end:/(?=[;}])/,contains:[{begin:/(?<=["'])[ \t]*;/},f,u.C_LINE_COMMENT_MODE,{...d,endsParent:!0},{scope:`string`,begin:new RegExp(l(``)),endsParent:!0}]};return{name:`BLK`,contains:[f,u.C_LINE_COMMENT_MODE,y,{scope:`meta`,begin:RegExp(`${o}~?@[^"'\\n]*?${o}`)},{scope:`built_in`,begin:RegExp(`${o}~?_[^"'\\n]*?${o}(?=\\s*(?:;\\s*)?\\{)`)},{scope:`built_in`,begin:RegExp(`${o}~?_[^"'\\n]*?${o}(?=\\s*(?:;\\s*)?[:=])`)},{scope:`title`,begin:RegExp(`${o}~?[^"'\\n]*?${o}(?=\\s*(?:;\\s*)?\\{)`)},{scope:`attr`,begin:RegExp(`${o}~?[^"'\\n]*?${o}(?=\\s*(?:;\\s*)?[:=])`)},{scope:`built_in`,begin:RegExp(`_${a}(?=\\s*\\{)`)},{scope:`title`,begin:RegExp(`(?!_)${a}(?=\\s*\\{)`)},{scope:`built_in`,begin:RegExp(`_${a}(?=\\s*[:=])`)},{scope:`attr`,begin:RegExp(`(?!_)${a}(?=\\s*[:=])`)},v,_,m(h(e),`string`),m(h(t),`literal`),m(h(n),`number`),m(/(?<!\[\][ \t]*)=/,`string`,/(?=[;}]|\s*\/\/)|(?<!=[ \t]*)(?=[\r\n])/),d]}}return u})();
+hljs.registerLanguage("blk", hljsBlk);

package/package.json

@@ -1,6 +1,45 @@
 {
-  "name": "@gaijin/highlightjs-blk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@gaijin/highlightjs-blk",
+	"version": "1.1.0",
+	"description": "highlight.js grammar for BLK, the DataBlock text format of the Dagor Engine",
+	"keywords": [
+		"blk",
+		"dagor",
+		"highlight.js",
+		"highlightjs",
+		"syntax"
+	],
+	"homepage": "https://github.com/GaijinEntertainment/dagor-hljs/tree/main/packages/blk#readme",
+	"bugs": {
+		"url": "https://github.com/GaijinEntertainment/dagor-hljs/issues"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "Gaijin Entertainment"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/GaijinEntertainment/dagor-hljs.git",
+		"directory": "packages/blk"
+	},
+	"files": [
+		"dist"
+	],
+	"type": "module",
+	"sideEffects": false,
+	"exports": {
+		".": {
+			"types": "./dist/blk.d.ts",
+			"default": "./dist/blk.js"
+		}
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "vp pack"
+	},
+	"peerDependencies": {
+		"highlight.js": "^11.12.0"
+	}
+}