ci: update dependency marked (#2815)

Author: mhaertwig

docs/tsconfig.json

@@ -1,7 +1,6 @@
 {
   "compileOnSave": false,
   "compilerOptions": {
-    "rootDir": "../",
     "outDir": "../dist/out-tsc",
     "forceConsistentCasingInFileNames": true,
     "allowSyntheticDefaultImports": true,

package.json

@@ -96,7 +96,6 @@
     "@types/jasmine": "6.0.0",
     "@types/jasminewd2": "2.0.13",
     "@types/mapbox__point-geometry": "0.1.4",
-    "@types/marked": "^2.0.2",
     "@types/minimatch": "^5.1.2",
     "@types/node": "22.19.20",
     "@types/semver": "^7.3.9",
@@ -131,7 +130,7 @@
     "karma-sourcemap-loader": "0.4.0",
     "lint-staged": "17.0.7",
     "magic-string": "0.30.21",
-    "marked": "^2.0.3",
+    "marked": "^18.0.0",
     "minimatch": "^3.1.4",
     "npm-run-all2": "9.0.1",
     "octokit": "5.0.5",
@@ -147,6 +146,7 @@
     "sass": "1.100.0",
     "semver": "7.8.3",
     "shelljs": "0.10.0",
+    "slugify": "^1.6.6",
     "source-map-support": "^0.5.21",
     "standard-version": "9.5.0",
     "stylelint": "17.13.0",

pnpm-lock.yaml

@@ -2,7 +2,6 @@ import { Package } from 'dgeni';
 import { ReadTypeScriptModules } from 'dgeni-packages/typescript/processors/readTypeScriptModules';
 import { Host } from 'dgeni-packages/typescript/services/ts-host/host';
 import { TypeFormatFlags } from 'typescript';
-import { HighlightNunjucksExtension } from './nunjucks-tags/highlight';
 import { patchLogService } from './patch-log-service';
 import { AsyncFunctionsProcessor } from './processors/async-functions';
 import { categorizer } from './processors/categorizer';
@@ -166,6 +165,4 @@ apiDocsPackage.config(function (templateFinder: any, templateEngine: any) {
     variableStart: '{$',
     variableEnd: '$}',
   };
-
-  templateEngine.tags.push(new HighlightNunjucksExtension());
 });

tools/dgeni/docs-package.ts

@@ -17,10 +17,7 @@ <h4 id="{$ constant.name $}" class="docs-header-link docs-api-h4 docs-api-consta
 
 <div class="docs-markdown">
 <pre class="docs-markdown-pre">
-<code class="docs-markdown-code">
-{%- highlight "typescript" -%}
-  const {$ constant.name | safe $}: {$ constant.type | safe $};
-{%- end_highlight -%}
-</code>
+<code class="docs-markdown-code">const {$ constant.name | safe $}: {$ constant.type | safe $};</code>
+
 </pre>
 </div>

tools/dgeni/nunjucks-tags/highlight.ts

@@ -17,10 +17,6 @@ <h4 id="{$ alias.name $}" class="docs-header-link docs-api-h4 docs-api-type-alia
 
 <div class="docs-markdown">
 <pre class="docs-markdown-pre">
-<code class="docs-markdown-code">
-{%- highlight "typescript" -%}
-  type {$ alias.name | safe $} = {$ alias.typeDefinition | safe $};
-{%- end_highlight -%}
-</code>
+<code class="docs-markdown-code">type {$ alias.name | safe $} = {$ alias.typeDefinition | safe $};</code>
 </pre>
 </div>

tools/dgeni/templates/constant.template.html

@@ -5,7 +5,7 @@ package(default_visibility = ["//visibility:public"])
 
 ts_project(
     name = "sources",
-    srcs = glob(["**/*.ts"]),
+    srcs = glob(["**/*.mts"]),
     tsconfig = "//tools:tsconfig",
     deps = [
         "//:node_modules/@types/fs-extra",
@@ -20,5 +20,5 @@ js_binary(
     data = [
         ":sources",
     ],
-    entry_point = ":highlight-files.js",
+    entry_point = ":highlight-files.mjs",
 )

tools/dgeni/templates/type-alias.template.html

@@ -0,0 +1,22 @@
+import highlightJs from 'highlight.js';
+
+/** Map of language aliases not recognized by highlight.js to supported equivalents. */
+const languageAliases: Record<string, string> = {
+  angular: 'html',
+  ts: 'typescript',
+};
+
+/**
+ * Transforms a given code block into its corresponding HTML output. We do this using
+ * highlight.js because it allows us to show colored code blocks in our documentation.
+ */
+export function highlightCodeBlock(code: string, language?: string) {
+  if (language) {
+    const normalizedLanguage = languageAliases[language.toLowerCase()] ?? language.toLowerCase();
+    if (highlightJs.getLanguage(normalizedLanguage)) {
+      return highlightJs.highlight(code, { language: normalizedLanguage }).value;
+    }
+  }
+
+  return code;
+}