@purestack/ts-highlight 0.0.0-stage → 1.1.15

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ahmed Yasin Koculu
+
+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,31 @@
-# Temporary Holding Version
+# @purestack/ts-highlight
 
-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.
+Syntax-highlighting backends and the default PureStack highlighting plugin.
+
+```ts
+import { highlightPlugin } from '@purestack/ts-highlight'
+
+const plugin = highlightPlugin()
+```
+
+Included automatically by `ts-ssg`. The plugin selects `mdx.highlighter`,
+initializes the selected engine once per build/session, and respects
+`mdx.disableHighlighter`. Fenced, inline, imported, and Regor markup examples
+all use the same highlighter. Language aliases, inferred file extensions,
+tagged TypeScript templates, and light/dark Shiki themes are preserved.
+
+Pass `createShiki(options)` or `createHighlightJs()` to customize the native
+backend. Both may return an instance synchronously or asynchronously; the
+unused factory is never called. The Shiki options contain the default
+languages and themes. For highlight.js, prefer a new instance with explicitly
+registered grammars to avoid changing the shared registry.
+
+`createMdxHighlighter`, `createHljsHighlighter`, `DEFAULT_MDX_CODE_LANGS`, and
+`DEFAULT_MDX_CODE_THEMES` are exported for standalone use. The shared
+`MdxCodeHighlighter` contract is exported by `ts-common` and `ts-ssg`.
+
+To replace the backend entirely, supply `markdown.createHighlighter(config)`
+from an ordinary plugin. It takes precedence over the default provider, which
+is not initialized. Per-language `markdown.resolveHighlighter` callbacks take
+precedence over either provider and remain available when default highlighting
+is disabled. Disable automatic plugins to omit this provider altogether.

package/dist/ts-highlight.d.mts

@@ -0,0 +1,35 @@
+/*! @purestack/ts-highlight v1.1.15 | (c) 2026 Ahmed Yasin Koculu | MIT License */
+
+import { MdxCodeHighlighter, SiteMdxConfig } from "@purestack/ts-common";
+import { HLJSApi } from "highlight.js";
+import { Highlighter, createHighlighter } from "shiki";
+//#region packages/ts-highlight/src/shiki.d.ts
+type MdxShikiFactory = (options: Parameters<typeof createHighlighter>[0]) => Highlighter | Promise<Highlighter>;
+interface MdxCodeThemes {
+  light: string;
+  dark: string;
+}
+type MdxCodeLangs = string[];
+export declare const DEFAULT_MDX_CODE_THEMES: MdxCodeThemes;
+export declare const DEFAULT_MDX_CODE_LANGS: MdxCodeLangs;
+export declare function createMdxHighlighter(themes?: MdxCodeThemes, langs?: MdxCodeLangs, create?: MdxShikiFactory): Promise<MdxCodeHighlighter>;
+//#endregion
+//#region packages/ts-highlight/src/highlightjs.d.ts
+export declare function createHljsHighlighter(highlighter?: HLJSApi): MdxCodeHighlighter;
+//#endregion
+//#region packages/ts-highlight/src/index.d.ts
+export interface HighlightPluginOptions {
+  createShiki?: MdxShikiFactory;
+  createHighlightJs?: () => HLJSApi | Promise<HLJSApi>;
+}
+/** The standard highlighter, replaceable through markdown.createHighlighter. */
+export declare function highlightPlugin(options?: HighlightPluginOptions): {
+  name: string;
+  defaults: boolean;
+  markdown: {
+    createHighlighter(config: Partial<SiteMdxConfig>): Promise<import("@purestack/ts-common").MdxCodeHighlighter | undefined>;
+  };
+};
+//#endregion
+export type { MdxCodeLangs, MdxCodeThemes, MdxShikiFactory };
+//# sourceMappingURL=ts-highlight.d.mts.map

package/dist/ts-highlight.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-highlight.d.mts","names":[],"sources":["../src/shiki.ts","../src/highlightjs.ts","../src/index.ts"],"mappings":";;;;KAOY,mBACV,SAAS,kBAAkB,0BACxB,cAAc,QAAQ;UAEV;EACf;EACA;;KAGU;qBAEC,yBAAyB;qBAKzB,wBAAwB;wBAIf,qBACpB,SAAQ,eACR,QAAO,cACP,SAAQ,kBACP,QAAQ;;;wBCjBK,sBACd,cAAa,UACZ;;;iBCDc;EACf,cAAc;EACd,0BAA0B,UAAU,QAAQ;;;wBAI9B,gBAAgB,UAAS;EAErC;EACA;EACA;IACQ,kBAAiB,QAAS,QAAQ,iBAAc,uCAAA"}

package/dist/ts-highlight.mjs

@@ -0,0 +1,87 @@
+/*! @purestack/ts-highlight v1.1.15 | (c) 2026 Ahmed Yasin Koculu | MIT License */
+
+import { DEFAULT_CODE_LANGUAGES, normalizeCodeLanguage } from "@purestack/ts-common";
+import hljs from "highlight.js";
+import { createHighlighter } from "shiki";
+
+//#region packages/ts-highlight/src/highlightjs.ts
+const hljsLanguages = /* @__PURE__ */ new Map([
+	["jsonc", "json"],
+	["mdx", "markdown"],
+	["objective-c", "objectivec"],
+	["ts-tags", "typescript"]
+]);
+function createHljsHighlighter(highlighter = hljs) {
+	return { codeToHtml: (code, lang) => {
+		const normalizedLang = normalizeCodeLanguage(lang ?? "");
+		const highlightLang = hljsLanguages.get(normalizedLang) ?? normalizedLang;
+		if (highlightLang && highlighter.getLanguage(highlightLang)) {
+			const highlighted = highlighter.highlight(code, {
+				language: highlightLang,
+				ignoreIllegals: true
+			});
+			return `<pre class="hljs"><code class="hljs language-${highlighted.language}">${highlighted.value}</code></pre>`;
+		}
+		const escaped = escapeHtml(code);
+		return `<pre class="hljs"><code class="hljs${normalizedLang ? ` language-${normalizedLang}` : ""}">${escaped}</code></pre>`;
+	} };
+}
+function escapeHtml(value) {
+	return value.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;");
+}
+
+//#endregion
+//#region packages/ts-highlight/src/shiki.ts
+const DEFAULT_MDX_CODE_THEMES = {
+	light: "github-light",
+	dark: "github-dark"
+};
+const DEFAULT_MDX_CODE_LANGS = DEFAULT_CODE_LANGUAGES;
+const TYPESCRIPT_WITH_TAGS_LANG = "ts-tags";
+async function createMdxHighlighter(themes = DEFAULT_MDX_CODE_THEMES, langs = DEFAULT_MDX_CODE_LANGS, create = createHighlighter) {
+	const highlighter = await create({
+		themes: dedupe([themes.light, themes.dark]),
+		langs: resolveLoadedLanguages(langs)
+	});
+	return { codeToHtml: (code, lang) => {
+		return highlighter.codeToHtml(code, {
+			lang: resolveHighlightLanguage(lang),
+			themes: {
+				light: themes.light,
+				dark: themes.dark
+			},
+			defaultColor: false
+		});
+	} };
+}
+function resolveLoadedLanguages(langs) {
+	const resolved = dedupe(langs.map(normalizeCodeLanguage));
+	if (resolved.includes("typescript") && !resolved.includes(TYPESCRIPT_WITH_TAGS_LANG)) resolved.push(TYPESCRIPT_WITH_TAGS_LANG);
+	return resolved;
+}
+function resolveHighlightLanguage(lang) {
+	const normalized = normalizeCodeLanguage(lang ?? "text");
+	return normalized === "typescript" ? TYPESCRIPT_WITH_TAGS_LANG : normalized || "text";
+}
+function dedupe(values) {
+	return Array.from(new Set(values.filter((value) => value.length > 0)));
+}
+
+//#endregion
+//#region packages/ts-highlight/src/index.ts
+/** The standard highlighter, replaceable through markdown.createHighlighter. */
+function highlightPlugin(options = {}) {
+	return {
+		name: "purestack:highlight",
+		defaults: true,
+		markdown: { async createHighlighter(config) {
+			if (config.disableHighlighter) return void 0;
+			if (config.highlighter === "highlightjs") return createHljsHighlighter(await options.createHighlightJs?.());
+			return createMdxHighlighter(void 0, void 0, options.createShiki);
+		} }
+	};
+}
+
+//#endregion
+export { DEFAULT_MDX_CODE_LANGS, DEFAULT_MDX_CODE_THEMES, createHljsHighlighter, createMdxHighlighter, highlightPlugin };
+//# sourceMappingURL=ts-highlight.mjs.map

package/dist/ts-highlight.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-highlight.mjs","names":[],"sources":["../src/highlightjs.ts","../src/shiki.ts","../src/index.ts"],"sourcesContent":["import {\n  type MdxCodeHighlighter,\n  normalizeCodeLanguage,\n} from '@purestack/ts-common'\nimport hljs, { type HLJSApi } from 'highlight.js'\n\n// Use highlight.js names, or the closest grammar for Shiki-only languages.\nconst hljsLanguages = new Map([\n  ['jsonc', 'json'],\n  ['mdx', 'markdown'],\n  ['objective-c', 'objectivec'],\n  ['ts-tags', 'typescript'],\n])\n\nexport function createHljsHighlighter(\n  highlighter: HLJSApi = hljs,\n): MdxCodeHighlighter {\n  return {\n    codeToHtml: (code: string, lang?: string) => {\n      const normalizedLang = normalizeCodeLanguage(lang ?? '')\n      const highlightLang = hljsLanguages.get(normalizedLang) ?? normalizedLang\n      if (highlightLang && highlighter.getLanguage(highlightLang)) {\n        const highlighted = highlighter.highlight(code, {\n          language: highlightLang,\n          ignoreIllegals: true,\n        })\n        return `<pre class=\"hljs\"><code class=\"hljs language-${highlighted.language}\">${highlighted.value}</code></pre>`\n      }\n\n      const escaped = escapeHtml(code)\n      const langClass = normalizedLang ? ` language-${normalizedLang}` : ''\n      return `<pre class=\"hljs\"><code class=\"hljs${langClass}\">${escaped}</code></pre>`\n    },\n  }\n}\n\nfunction escapeHtml(value: string): string {\n  return value\n    .replaceAll('&', '&amp;')\n    .replaceAll('<', '&lt;')\n    .replaceAll('>', '&gt;')\n}\n","import {\n  DEFAULT_CODE_LANGUAGES,\n  type MdxCodeHighlighter,\n  normalizeCodeLanguage,\n} from '@purestack/ts-common'\nimport { createHighlighter, type Highlighter } from 'shiki'\n\nexport type MdxShikiFactory = (\n  options: Parameters<typeof createHighlighter>[0],\n) => Highlighter | Promise<Highlighter>\n\nexport interface MdxCodeThemes {\n  light: string\n  dark: string\n}\n\nexport type MdxCodeLangs = string[]\n\nexport const DEFAULT_MDX_CODE_THEMES: MdxCodeThemes = {\n  light: 'github-light',\n  dark: 'github-dark',\n}\n\nexport const DEFAULT_MDX_CODE_LANGS: MdxCodeLangs = DEFAULT_CODE_LANGUAGES\n\nconst TYPESCRIPT_WITH_TAGS_LANG = 'ts-tags'\n\nexport async function createMdxHighlighter(\n  themes: MdxCodeThemes = DEFAULT_MDX_CODE_THEMES,\n  langs: MdxCodeLangs = DEFAULT_MDX_CODE_LANGS,\n  create: MdxShikiFactory = createHighlighter,\n): Promise<MdxCodeHighlighter> {\n  const themeList = dedupe([themes.light, themes.dark])\n  const langList = resolveLoadedLanguages(langs)\n  const highlighter = await create({\n    themes: themeList,\n    langs: langList,\n  })\n\n  return {\n    codeToHtml: (code: string, lang?: string) => {\n      return highlighter.codeToHtml(code, {\n        lang: resolveHighlightLanguage(lang),\n        themes: { light: themes.light, dark: themes.dark },\n        defaultColor: false,\n      })\n    },\n  }\n}\n\nfunction resolveLoadedLanguages(langs: string[]) {\n  const resolved = dedupe(langs.map(normalizeCodeLanguage))\n  if (\n    resolved.includes('typescript') &&\n    !resolved.includes(TYPESCRIPT_WITH_TAGS_LANG)\n  ) {\n    resolved.push(TYPESCRIPT_WITH_TAGS_LANG)\n  }\n  return resolved\n}\n\nfunction resolveHighlightLanguage(lang: string | undefined) {\n  const normalized = normalizeCodeLanguage(lang ?? 'text')\n  return normalized === 'typescript'\n    ? TYPESCRIPT_WITH_TAGS_LANG\n    : normalized || 'text'\n}\n\nfunction dedupe(values: string[]) {\n  return Array.from(new Set(values.filter((value) => value.length > 0)))\n}\n","import type { SiteMdxConfig } from '@purestack/ts-common'\nimport type { HLJSApi } from 'highlight.js'\nimport { createHljsHighlighter } from './highlightjs'\nimport { createMdxHighlighter, type MdxShikiFactory } from './shiki'\n\nexport { createHljsHighlighter } from './highlightjs'\nexport {\n  createMdxHighlighter,\n  DEFAULT_MDX_CODE_LANGS,\n  DEFAULT_MDX_CODE_THEMES,\n  type MdxCodeLangs,\n  type MdxCodeThemes,\n  type MdxShikiFactory,\n} from './shiki'\n\nexport interface HighlightPluginOptions {\n  createShiki?: MdxShikiFactory\n  createHighlightJs?: () => HLJSApi | Promise<HLJSApi>\n}\n\n/** The standard highlighter, replaceable through markdown.createHighlighter. */\nexport function highlightPlugin(options: HighlightPluginOptions = {}) {\n  return {\n    name: 'purestack:highlight',\n    defaults: true,\n    markdown: {\n      async createHighlighter(config: Partial<SiteMdxConfig>) {\n        if (config.disableHighlighter) return undefined\n        if (config.highlighter === 'highlightjs')\n          return createHljsHighlighter(await options.createHighlightJs?.())\n        return createMdxHighlighter(undefined, undefined, options.createShiki)\n      },\n    },\n  }\n}\n"],"mappings":";;;;;AAOA,MAAM,gCAAgB,IAAI,IAAI;CAC5B,CAAC,SAAS,MAAM;CAChB,CAAC,OAAO,UAAU;CAClB,CAAC,eAAe,YAAY;CAC5B,CAAC,WAAW,YAAY;AAC1B,CAAC;AAED,SAAgB,sBACd,cAAuB,MACH;CACpB,OAAO,EACL,aAAa,MAAc,SAAkB;EAC3C,MAAM,iBAAiB,sBAAsB,QAAQ,EAAE;EACvD,MAAM,gBAAgB,cAAc,IAAI,cAAc,KAAK;EAC3D,IAAI,iBAAiB,YAAY,YAAY,aAAa,GAAG;GAC3D,MAAM,cAAc,YAAY,UAAU,MAAM;IAC9C,UAAU;IACV,gBAAgB;GAClB,CAAC;GACD,OAAO,gDAAgD,YAAY,SAAS,IAAI,YAAY,MAAM;EACpG;EAEA,MAAM,UAAU,WAAW,IAAI;EAE/B,OAAO,sCADW,iBAAiB,aAAa,mBAAmB,GACZ,IAAI,QAAQ;CACrE,EACF;AACF;AAEA,SAAS,WAAW,OAAuB;CACzC,OAAO,MACJ,WAAW,KAAK,OAAO,CAAC,CACxB,WAAW,KAAK,MAAM,CAAC,CACvB,WAAW,KAAK,MAAM;AAC3B;;;;ACvBA,MAAa,0BAAyC;CACpD,OAAO;CACP,MAAM;AACR;AAEA,MAAa,yBAAuC;AAEpD,MAAM,4BAA4B;AAElC,eAAsB,qBACpB,SAAwB,yBACxB,QAAsB,wBACtB,SAA0B,mBACG;CAG7B,MAAM,cAAc,MAAM,OAAO;EAC/B,QAHgB,OAAO,CAAC,OAAO,OAAO,OAAO,IAAI,CAGjC;EAChB,OAHe,uBAAuB,KAGxB;CAChB,CAAC;CAED,OAAO,EACL,aAAa,MAAc,SAAkB;EAC3C,OAAO,YAAY,WAAW,MAAM;GAClC,MAAM,yBAAyB,IAAI;GACnC,QAAQ;IAAE,OAAO,OAAO;IAAO,MAAM,OAAO;GAAK;GACjD,cAAc;EAChB,CAAC;CACH,EACF;AACF;AAEA,SAAS,uBAAuB,OAAiB;CAC/C,MAAM,WAAW,OAAO,MAAM,IAAI,qBAAqB,CAAC;CACxD,IACE,SAAS,SAAS,YAAY,KAC9B,CAAC,SAAS,SAAS,yBAAyB,GAE5C,SAAS,KAAK,yBAAyB;CAEzC,OAAO;AACT;AAEA,SAAS,yBAAyB,MAA0B;CAC1D,MAAM,aAAa,sBAAsB,QAAQ,MAAM;CACvD,OAAO,eAAe,eAClB,4BACA,cAAc;AACpB;AAEA,SAAS,OAAO,QAAkB;CAChC,OAAO,MAAM,KAAK,IAAI,IAAI,OAAO,QAAQ,UAAU,MAAM,SAAS,CAAC,CAAC,CAAC;AACvE;;;;;ACjDA,SAAgB,gBAAgB,UAAkC,CAAC,GAAG;CACpE,OAAO;EACL,MAAM;EACN,UAAU;EACV,UAAU,EACR,MAAM,kBAAkB,QAAgC;GACtD,IAAI,OAAO,oBAAoB,OAAO;GACtC,IAAI,OAAO,gBAAgB,eACzB,OAAO,sBAAsB,MAAM,QAAQ,oBAAoB,CAAC;GAClE,OAAO,qBAAqB,QAAW,QAAW,QAAQ,WAAW;EACvE,EACF;CACF;AACF"}

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "@purestack/ts-highlight",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.1.15",
+  "packageManager": "yarn@4.9.2",
+  "module": "./dist/ts-highlight.mjs",
+  "types": "./dist/ts-highlight.d.mts",
+  "type": "module",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PureStackStudio/PureStack.git",
+    "directory": "packages/ts-highlight"
+  },
+  "homepage": "https://purestack.studio",
+  "bugs": {
+    "url": "https://github.com/PureStackStudio/PureStack/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/ts-highlight.d.mts",
+      "import": "./dist/ts-highlight.mjs"
+    }
+  },
+  "license": "MIT",
+  "files": [
+    "dist/*.mjs",
+    "dist/*.mjs.map",
+    "dist/*.d.mts",
+    "dist/*.d.mts.map",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "lint": "biome check ./src --formatter-enabled=false --write",
+    "test": "vitest"
+  },
+  "dependencies": {
+    "@purestack/ts-common": "^1.1.15",
+    "highlight.js": "^11.11.1",
+    "shiki": "^3.22.0"
+  }
 }