@mui/internal-docs-infra 0.12.1-canary.46 → 0.12.1-canary.48

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/internal-docs-infra",
-  "version": "0.12.1-canary.46",
+  "version": "0.12.1-canary.48",
   "author": "MUI Team",
   "description": "MUI Infra - internal documentation creation tools.",
   "license": "MIT",
@@ -36,7 +36,6 @@
     "@orama/orama": "^3.1.18",
     "@orama/plugin-qps": "^3.1.18",
     "@orama/stemmers": "^3.1.18",
-    "@orama/stopwords": "^3.1.18",
     "@wooorm/starry-night": "^3.11.0",
     "autoprefixer": "^10.5.5",
     "chalk": "^6.0.0",
@@ -815,5 +814,5 @@
   "bin": {
     "docs-infra": "./cli/index.mjs"
   },
-  "gitSha": "0534275eee6a8935af28abb295f1ed280d459e95"
+  "gitSha": "b296c98bc17f685db974504d2c00094a59d1698d"
 }

package/pipeline/parseSource/index.d.mts

@@ -1,2 +1,2 @@
-export * from "./parseSource.mjs";
+export { createParseSource, parsePlainText, parseSource, registerAllGrammars, registerGrammars, resetStarryNight } from "./parseSource.mjs";
 export { getGrammarFromLanguage, languageToGrammarMap, extensionMap } from "./grammarMaps.mjs";

package/pipeline/parseSource/index.mjs

@@ -1,2 +1,2 @@
-export * from "./parseSource.mjs";
+export { createParseSource, parsePlainText, parseSource, registerAllGrammars, registerGrammars, resetStarryNight } from "./parseSource.mjs";
 export { getGrammarFromLanguage, languageToGrammarMap, extensionMap } from "./grammarMaps.mjs";

package/pipeline/parseSource/parseSource.d.mts

@@ -1,4 +1,6 @@
+import { createStarryNight } from '@wooorm/starry-night';
 import type { ParseSource } from "../../CodeHighlighter/types.mjs";
+type StarryNight = Awaited<ReturnType<typeof createStarryNight>>;
 /**
  * Parses source into a line-guttered HAST **without** syntax highlighting — the
  * raw text wrapped in the same `.line`/`.frame` structure `parseSource` produces,
@@ -51,8 +53,16 @@ export declare function registerAllGrammars(): Promise<void>;
  * @returns A Promise that resolves to the initialized `parseSource` function
  */
 export declare const createParseSource: (initialScopes?: string[]) => Promise<ParseSource>;
+/**
+ * Returns the shared Starry Night instance after registering every grammar.
+ *
+ * Inline highlighting can follow code that initialized a lazy subset, so it must
+ * initialize the complete registry before using the shared instance.
+ */
+export declare function getStarryNightInstance(): Promise<StarryNight>;
 /**
  * Clears the global Starry Night singleton and registration state. Intended for
  * tests exercising lazy registration from a known-empty registry.
  */
-export declare function resetStarryNight(): void;
+export declare function resetStarryNight(): void;
+export {};

package/pipeline/parseSource/parseSource.mjs

@@ -232,6 +232,21 @@ export const createParseSource = async initialScopes => {
   return parseSource;
 };
 
+/**
+ * Returns the shared Starry Night instance after registering every grammar.
+ *
+ * Inline highlighting can follow code that initialized a lazy subset, so it must
+ * initialize the complete registry before using the shared instance.
+ */
+export async function getStarryNightInstance() {
+  await createParseSource();
+  const instance = getInstance();
+  if (!instance) {
+    throw new Error('Starry Night failed to initialize.');
+  }
+  return instance;
+}
+
 /**
  * Clears the global Starry Night singleton and registration state. Intended for
  * tests exercising lazy registration from a known-empty registry.

package/pipeline/transformHtmlCodeInline/transformHtmlCodeInline.mjs

@@ -1,29 +1,27 @@
-import { createStarryNight } from '@wooorm/starry-night';
 import { visit } from 'unist-util-visit';
-import { grammars } from "../parseSource/grammars.mjs";
-import { extensionMap } from "../parseSource/grammarMaps.mjs";
+import { getStarryNightInstance } from "../parseSource/parseSource.mjs";
+import { getGrammarFromLanguage } from "../parseSource/grammarMaps.mjs";
 import { extendSyntaxTokens } from "../parseSource/extendSyntaxTokens.mjs";
 import { getLanguageCapabilitiesFromScope } from "../parseSource/languageCapabilities.mjs";
 import { getHastTextContent } from "../hastUtils/index.mjs";
 import { removePrefixFromHighlightedNodes } from "./removePrefixFromHighlightedNodes.mjs";
 import { removeSuffixFromHighlightedNodes } from "./removeSuffixFromHighlightedNodes.mjs";
-const STARRY_NIGHT_KEY = '__docs_infra_starry_night_instance__';
+function getGrammarScope(node) {
+  const className = node.properties?.className;
+  if (!Array.isArray(className)) {
+    return undefined;
+  }
+  const languageClass = className.find(classNameValue => typeof classNameValue === 'string' && classNameValue.startsWith('language-'));
+  if (typeof languageClass !== 'string') {
+    return undefined;
+  }
+  return getGrammarFromLanguage(languageClass.replace('language-', ''));
+}
 
 /**
  * Options for the transformHtmlCodeInline plugin.
  */
 
-/**
- * Ensures Starry Night is initialized and returns the instance.
- * Uses a global singleton for efficiency across multiple plugin invocations.
- */
-async function getStarryNight() {
-  if (!globalThis[STARRY_NIGHT_KEY]) {
-    globalThis[STARRY_NIGHT_KEY] = await createStarryNight(grammars);
-  }
-  return globalThis[STARRY_NIGHT_KEY];
-}
-
 /**
  * A rehype plugin that applies inline syntax highlighting to code elements.
  * Unlike transformHtmlCodeBlock, this does NOT add line gutters or precomputed data.
@@ -39,7 +37,7 @@ export default function transformHtmlCodeInline(options = {}) {
     includePreElements = false
   } = options;
   return async tree => {
-    const starryNight = await getStarryNight();
+    const starryNight = await getStarryNightInstance();
     visit(tree, 'element', (node, _index, parent) => {
       // Only process code elements (inline code or code blocks without special handling)
       if (node.tagName !== 'code') {
@@ -78,41 +76,11 @@ export default function transformHtmlCodeInline(options = {}) {
       // out the keys via `splitObjectKeys`. The wrapping characters are stripped after highlighting.
       let objectWrap = false;
 
-      // Determine language from className (e.g., 'language-ts')
-      const className = node.properties?.className;
-      let fileType;
-      if (Array.isArray(className)) {
-        const langClass = className.find(c => typeof c === 'string' && c.startsWith('language-'));
-        if (langClass && typeof langClass === 'string') {
-          const lang = langClass.replace('language-', '');
-          // Map common language names to file extensions
-          const langToExt = {
-            ts: '.ts',
-            typescript: '.ts',
-            js: '.js',
-            javascript: '.js',
-            jsx: '.jsx',
-            tsx: '.tsx',
-            css: '.css',
-            html: '.html',
-            json: '.json',
-            md: '.md',
-            markdown: '.md',
-            sh: '.sh',
-            shell: '.sh',
-            bash: '.sh',
-            yaml: '.yaml',
-            yml: '.yaml'
-          };
-          fileType = langToExt[lang] || `.${lang}`;
-        }
-      }
-
       // Skip if no language specified or unsupported type
-      if (!fileType || !extensionMap[fileType]) {
+      const grammarScope = getGrammarScope(node);
+      if (!grammarScope) {
         return;
       }
-      const grammarScope = extensionMap[fileType];
       if (!highlightingPrefix && getLanguageCapabilitiesFromScope(grammarScope).semantics === 'js') {
         const trimmed = sourceToHighlight.trim();
         if (trimmed.length >= 2 && trimmed.startsWith('{') && trimmed.endsWith('}')) {
@@ -122,8 +90,8 @@ export default function transformHtmlCodeInline(options = {}) {
       }
 
       // Apply syntax highlighting
-      const highlighted = starryNight.highlight(sourceToHighlight, extensionMap[fileType]);
-      extendSyntaxTokens(highlighted, extensionMap[fileType]);
+      const highlighted = starryNight.highlight(sourceToHighlight, grammarScope);
+      extendSyntaxTokens(highlighted, grammarScope);
 
       // Replace the code element's children with the highlighted nodes
       if (highlighted.type === 'root' && highlighted.children) {

package/useSearch/types.d.mts

@@ -84,7 +84,7 @@ export interface UseSearchOptions {
   tolerance?: number;
   /** Maximum number of search results */
   limit?: number;
-  /** Enable stemming and stopwords (uses English by default) */
+  /** Enable stemming (uses English by default) */
   enableStemming?: boolean;
   /** Boost values for different result types and fields */
   boost?: Partial<Record<string, number>>;

package/useSearch/useSearch.mjs

@@ -4,17 +4,8 @@ import * as React from 'react';
 import { create, insertMultiple, search as oramaSearch } from '@orama/orama';
 import { pluginQPS } from '@orama/plugin-qps';
 import { stemmer, language } from '@orama/stemmers/english';
-import { stopwords as englishStopwords } from '@orama/stopwords/english';
 import { resolvePageUrl } from "../resolvePageUrl/index.mjs";
 
-// https://github.com/oramasearch/orama/blob/main/packages/stopwords/lib/en.js
-// Removed words that might be meaningful in a software documentation context
-const stopWords = englishStopwords.filter(word => word !== 'about' && word !== 'but' &&
-// start of button
-word !== 'for' &&
-// part of form
-word !== 'between' && word !== 'before' && word !== 'after' && word !== 'above' && word !== 'below' && word !== 'once' && word !== 'then' && word !== 'where' && word !== 'to' && word !== 'from' && word !== 'up' && word !== 'down' && word !== 'in' && word !== 'out' && word !== 'on' && word !== 'off' && word !== 'over' && word !== 'under');
-
 /**
  * Type for our search document structure
  */
@@ -354,8 +345,7 @@ export function useSearch(options) {
             stemming: true,
             language,
             stemmer,
-            stemmerSkipProperties: ['type', 'group', 'slug', 'sectionTitle', 'page', 'part', 'export', 'dataAttributes', 'cssVariables', 'props'],
-            stopWords
+            stemmerSkipProperties: ['type', 'group', 'slug', 'sectionTitle', 'page', 'part', 'export', 'dataAttributes', 'cssVariables', 'props']
           }
         } : undefined,
         plugins: [pluginQPS()]