@coldsmirk/inkstone-core 0.8.2-canary.0

package/README.md

@@ -0,0 +1,41 @@
+# @coldsmirk/inkstone-core
+
+The shared [Shiki](https://shiki.style/) highlighter service behind inkstone: one fine-grained, lazily-created singleton (catppuccin latte / macchiato, JS regex engine) that serves the editors, static code rendering, and markdown surfaces alike — one instance, consistent colors everywhere.
+
+Part of [inkstone](https://github.com/coldsmirk/inkstone). The editor layers ([`@coldsmirk/inkstone-monaco`](https://www.npmjs.com/package/@coldsmirk/inkstone-monaco), [`@coldsmirk/inkstone-codemirror`](https://www.npmjs.com/package/@coldsmirk/inkstone-codemirror)) and the React components ([`@coldsmirk/inkstone-react`](https://www.npmjs.com/package/@coldsmirk/inkstone-react)) consume this package; use it directly when a non-editor surface needs the same highlighting.
+
+## What you get
+
+- **`getHighlighter()`** — the process-wide `HighlighterCore` promise. JavaScript / TypeScript / JSON / SQL grammars and the catppuccin theme pair load by default.
+- **`configureHighlighter(config)`** — extend or replace the default grammar / theme set, once, before any editor mounts. `DEFAULT_HIGHLIGHTER_LANGS` is exported so extension is additive.
+- **`shikiThemeId(dark)`** plus the `INKSTONE_LIGHT_THEME` / `INKSTONE_DARK_THEME` constants — the theme names to pass wherever a Shiki theme id is expected.
+
+## Install
+
+```bash
+pnpm add @coldsmirk/inkstone-core
+```
+
+`shiki` is a regular dependency and installs automatically. Node.js >= 22 for build / SSR hosts.
+
+## Quick start
+
+```ts
+import { configureHighlighter, DEFAULT_HIGHLIGHTER_LANGS, getHighlighter, shikiThemeId } from "@coldsmirk/inkstone-core";
+import yaml from "@shikijs/langs/yaml";
+
+// Optional: add grammars/themes beyond the defaults — once, before any editor mounts.
+configureHighlighter({ langs: [...DEFAULT_HIGHLIGHTER_LANGS, yaml] });
+
+const highlighter = await getHighlighter();
+const html = highlighter.codeToHtml("const x = 1;", {
+  lang: "javascript",
+  theme: shikiThemeId(true) // dark → catppuccin macchiato
+});
+```
+
+The same instance is the right one for non-editor surfaces (markdown code blocks, JSON inspectors, Mantine's `@mantine/code-highlight` adapter) — sharing it keeps their colors identical to the editors'.
+
+## License
+
+UNLICENSED — proprietary. All rights reserved; no use, copying, or redistribution without the author's permission.

package/dist/index.cjs

@@ -0,0 +1,80 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+//#endregion
+let _shikijs_langs_javascript = require("@shikijs/langs/javascript");
+_shikijs_langs_javascript = __toESM(_shikijs_langs_javascript, 1);
+let _shikijs_langs_json = require("@shikijs/langs/json");
+_shikijs_langs_json = __toESM(_shikijs_langs_json, 1);
+let _shikijs_langs_sql = require("@shikijs/langs/sql");
+_shikijs_langs_sql = __toESM(_shikijs_langs_sql, 1);
+let _shikijs_langs_typescript = require("@shikijs/langs/typescript");
+_shikijs_langs_typescript = __toESM(_shikijs_langs_typescript, 1);
+let _shikijs_themes_catppuccin_latte = require("@shikijs/themes/catppuccin-latte");
+_shikijs_themes_catppuccin_latte = __toESM(_shikijs_themes_catppuccin_latte, 1);
+let _shikijs_themes_catppuccin_macchiato = require("@shikijs/themes/catppuccin-macchiato");
+_shikijs_themes_catppuccin_macchiato = __toESM(_shikijs_themes_catppuccin_macchiato, 1);
+let shiki_core = require("shiki/core");
+let shiki_engine_javascript = require("shiki/engine/javascript");
+//#region src/shiki.ts
+const INKSTONE_LIGHT_THEME = "catppuccin-latte";
+const INKSTONE_DARK_THEME = "catppuccin-macchiato";
+const DEFAULT_HIGHLIGHTER_LANGS = [
+	_shikijs_langs_javascript.default,
+	_shikijs_langs_typescript.default,
+	_shikijs_langs_json.default,
+	_shikijs_langs_sql.default
+];
+let config = {};
+let promise = null;
+function configureHighlighter(options) {
+	if (promise) throw new Error("configureHighlighter must be called before the first getHighlighter()");
+	config = {
+		...config,
+		...options
+	};
+}
+function getHighlighter() {
+	promise ??= (0, shiki_core.createHighlighterCore)({
+		themes: [
+			_shikijs_themes_catppuccin_latte.default,
+			_shikijs_themes_catppuccin_macchiato.default,
+			...config.themes ?? []
+		],
+		langs: config.langs ?? [...DEFAULT_HIGHLIGHTER_LANGS],
+		engine: (0, shiki_engine_javascript.createJavaScriptRegexEngine)()
+	}).catch((error) => {
+		promise = null;
+		throw error;
+	});
+	return promise;
+}
+function shikiThemeId(dark) {
+	return dark ? INKSTONE_DARK_THEME : INKSTONE_LIGHT_THEME;
+}
+//#endregion
+exports.DEFAULT_HIGHLIGHTER_LANGS = DEFAULT_HIGHLIGHTER_LANGS;
+exports.INKSTONE_DARK_THEME = INKSTONE_DARK_THEME;
+exports.INKSTONE_LIGHT_THEME = INKSTONE_LIGHT_THEME;
+exports.configureHighlighter = configureHighlighter;
+exports.getHighlighter = getHighlighter;
+exports.shikiThemeId = shikiThemeId;

package/dist/index.d.cts

@@ -0,0 +1,55 @@
+import { HighlighterCore, HighlighterCore as HighlighterCore$1, LanguageInput, ThemeInput } from "shiki/core";
+
+//#region src/shiki.d.ts
+/**
+ * Shiki theme id inkstone editors use in light mode.
+ */
+declare const INKSTONE_LIGHT_THEME = "catppuccin-latte";
+/**
+ * Shiki theme id inkstone editors use in dark mode.
+ */
+declare const INKSTONE_DARK_THEME = "catppuccin-macchiato";
+/**
+ * The grammars the shared highlighter loads when {@link configureHighlighter} is not called:
+ * JavaScript / TypeScript / JSON / SQL — the set the coldsmirk apps actually edit and render.
+ * Spread these when adding a grammar: `configureHighlighter({ langs: [...DEFAULT_HIGHLIGHTER_LANGS, yaml] })`.
+ */
+declare const DEFAULT_HIGHLIGHTER_LANGS: readonly LanguageInput[];
+interface HighlighterConfig {
+  /**
+   * Grammars to load, replacing {@link DEFAULT_HIGHLIGHTER_LANGS}.
+   */
+  langs?: LanguageInput[];
+  /**
+   * Extra themes loaded alongside the built-in catppuccin pair (which is always loaded —
+   * the editor components select it by id).
+   */
+  themes?: ThemeInput[];
+}
+/**
+ * Configure the shared highlighter before its first use. The highlighter is a process-wide
+ * singleton (editors, static rendering, and markdown surfaces all share it for consistent
+ * colors), so configuration is process-global too and must happen before the first
+ * {@link getHighlighter} call — afterwards the instance is already built and this throws.
+ */
+declare function configureHighlighter(options: HighlighterConfig): void;
+/**
+ * The shared Shiki highlighter, built lazily on first call.
+ *
+ * Fine-grained build: only the configured grammars and the two catppuccin themes are bundled,
+ * whereas the convenient `createHighlighter` generates a lazy chunk for *every* Shiki theme and
+ * language. The JS regex engine avoids the Oniguruma WASM — smaller, no extra network request,
+ * ideal for offline deployments (Tauri webviews, rust-embed consoles).
+ *
+ * A failed build is not cached: the slot resets so a later call retries (and
+ * {@link configureHighlighter} becomes callable again), instead of replaying one transient
+ * failure — a chunk 404 after a redeploy, a flaky network — for the rest of the session.
+ */
+declare function getHighlighter(): Promise<HighlighterCore$1>;
+/**
+ * The Shiki theme id for a color scheme — {@link INKSTONE_DARK_THEME} when `dark`, else
+ * {@link INKSTONE_LIGHT_THEME}.
+ */
+declare function shikiThemeId(dark: boolean): string;
+//#endregion
+export { DEFAULT_HIGHLIGHTER_LANGS, type HighlighterConfig, type HighlighterCore, INKSTONE_DARK_THEME, INKSTONE_LIGHT_THEME, configureHighlighter, getHighlighter, shikiThemeId };

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+import { HighlighterCore, HighlighterCore as HighlighterCore$1, LanguageInput, ThemeInput } from "shiki/core";
+
+//#region src/shiki.d.ts
+/**
+ * Shiki theme id inkstone editors use in light mode.
+ */
+declare const INKSTONE_LIGHT_THEME = "catppuccin-latte";
+/**
+ * Shiki theme id inkstone editors use in dark mode.
+ */
+declare const INKSTONE_DARK_THEME = "catppuccin-macchiato";
+/**
+ * The grammars the shared highlighter loads when {@link configureHighlighter} is not called:
+ * JavaScript / TypeScript / JSON / SQL — the set the coldsmirk apps actually edit and render.
+ * Spread these when adding a grammar: `configureHighlighter({ langs: [...DEFAULT_HIGHLIGHTER_LANGS, yaml] })`.
+ */
+declare const DEFAULT_HIGHLIGHTER_LANGS: readonly LanguageInput[];
+interface HighlighterConfig {
+  /**
+   * Grammars to load, replacing {@link DEFAULT_HIGHLIGHTER_LANGS}.
+   */
+  langs?: LanguageInput[];
+  /**
+   * Extra themes loaded alongside the built-in catppuccin pair (which is always loaded —
+   * the editor components select it by id).
+   */
+  themes?: ThemeInput[];
+}
+/**
+ * Configure the shared highlighter before its first use. The highlighter is a process-wide
+ * singleton (editors, static rendering, and markdown surfaces all share it for consistent
+ * colors), so configuration is process-global too and must happen before the first
+ * {@link getHighlighter} call — afterwards the instance is already built and this throws.
+ */
+declare function configureHighlighter(options: HighlighterConfig): void;
+/**
+ * The shared Shiki highlighter, built lazily on first call.
+ *
+ * Fine-grained build: only the configured grammars and the two catppuccin themes are bundled,
+ * whereas the convenient `createHighlighter` generates a lazy chunk for *every* Shiki theme and
+ * language. The JS regex engine avoids the Oniguruma WASM — smaller, no extra network request,
+ * ideal for offline deployments (Tauri webviews, rust-embed consoles).
+ *
+ * A failed build is not cached: the slot resets so a later call retries (and
+ * {@link configureHighlighter} becomes callable again), instead of replaying one transient
+ * failure — a chunk 404 after a redeploy, a flaky network — for the rest of the session.
+ */
+declare function getHighlighter(): Promise<HighlighterCore$1>;
+/**
+ * The Shiki theme id for a color scheme — {@link INKSTONE_DARK_THEME} when `dark`, else
+ * {@link INKSTONE_LIGHT_THEME}.
+ */
+declare function shikiThemeId(dark: boolean): string;
+//#endregion
+export { DEFAULT_HIGHLIGHTER_LANGS, type HighlighterConfig, type HighlighterCore, INKSTONE_DARK_THEME, INKSTONE_LIGHT_THEME, configureHighlighter, getHighlighter, shikiThemeId };

package/dist/index.js

@@ -0,0 +1,46 @@
+import langJavascript from "@shikijs/langs/javascript";
+import langJson from "@shikijs/langs/json";
+import langSql from "@shikijs/langs/sql";
+import langTypescript from "@shikijs/langs/typescript";
+import catppuccinLatte from "@shikijs/themes/catppuccin-latte";
+import catppuccinMacchiato from "@shikijs/themes/catppuccin-macchiato";
+import { createHighlighterCore } from "shiki/core";
+import { createJavaScriptRegexEngine } from "shiki/engine/javascript";
+//#region src/shiki.ts
+const INKSTONE_LIGHT_THEME = "catppuccin-latte";
+const INKSTONE_DARK_THEME = "catppuccin-macchiato";
+const DEFAULT_HIGHLIGHTER_LANGS = [
+	langJavascript,
+	langTypescript,
+	langJson,
+	langSql
+];
+let config = {};
+let promise = null;
+function configureHighlighter(options) {
+	if (promise) throw new Error("configureHighlighter must be called before the first getHighlighter()");
+	config = {
+		...config,
+		...options
+	};
+}
+function getHighlighter() {
+	promise ??= createHighlighterCore({
+		themes: [
+			catppuccinLatte,
+			catppuccinMacchiato,
+			...config.themes ?? []
+		],
+		langs: config.langs ?? [...DEFAULT_HIGHLIGHTER_LANGS],
+		engine: createJavaScriptRegexEngine()
+	}).catch((error) => {
+		promise = null;
+		throw error;
+	});
+	return promise;
+}
+function shikiThemeId(dark) {
+	return dark ? INKSTONE_DARK_THEME : INKSTONE_LIGHT_THEME;
+}
+//#endregion
+export { DEFAULT_HIGHLIGHTER_LANGS, INKSTONE_DARK_THEME, INKSTONE_LIGHT_THEME, configureHighlighter, getHighlighter, shikiThemeId };

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@coldsmirk/inkstone-core",
+  "version": "0.8.2-canary.0",
+  "description": "Shared Shiki highlighter service for the inkstone editor toolkit: one fine-grained singleton (catppuccin themes, JS regex engine) reused by Monaco, static rendering, and markdown surfaces.",
+  "keywords": [
+    "shiki",
+    "syntax-highlighting",
+    "editor",
+    "catppuccin",
+    "highlighter"
+  ],
+  "homepage": "https://github.com/coldsmirk/inkstone/tree/main/packages/core#readme",
+  "bugs": "https://github.com/coldsmirk/inkstone/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coldsmirk/inkstone.git",
+    "directory": "packages/core"
+  },
+  "license": "UNLICENSED",
+  "author": {
+    "name": "Venus"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "clean": "rimraf dist",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@shikijs/langs": "^4.3.1",
+    "@shikijs/themes": "^4.3.1",
+    "shiki": "^4.3.1"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      ".": {
+        "import": {
+          "types": "./dist/index.d.ts",
+          "default": "./dist/index.js"
+        },
+        "require": {
+          "types": "./dist/index.d.cts",
+          "default": "./dist/index.cjs"
+        }
+      },
+      "./package.json": "./package.json"
+    }
+  }
+}