@brillout/docpress 0.15.10 → 0.15.11-commit-e615832

package/dist/utils/assert.js

@@ -2,8 +2,8 @@ export { assert };
 export { assertUsage };
 export { assertWarning };
 import { getGlobalObject } from './getGlobalObject.js';
-var devModeKey = '__docpress_dev_mode';
-var globalObject = getGlobalObject('utils/assert.ts', {
+const devModeKey = '__docpress_dev_mode';
+const globalObject = getGlobalObject('utils/assert.ts', {
     alreadyLogged: new Set(),
 });
 if (isBrowser()) {
@@ -18,7 +18,7 @@ if (isBrowser()) {
         .join(' '));
 }
 if (isDevMode()) {
-    window.onerror = function (err) {
+    window.onerror = (err) => {
         window.alert(err);
         window.onerror = null;
     };
@@ -27,25 +27,25 @@ function assert(condition, debugInfo) {
     if (condition) {
         return;
     }
-    var hasDebugInfo = debugInfo !== undefined;
+    const hasDebugInfo = debugInfo !== undefined;
     if (hasDebugInfo) {
         console.log(debugInfo);
         if (typeof debugInfo === 'object') {
             debugInfo = JSON.stringify(debugInfo);
         }
     }
-    var errMsg = '[DocPress] Bug. Contact DocPress maintainer.';
+    let errMsg = '[DocPress] Bug. Contact DocPress maintainer.';
     if (hasDebugInfo) {
         errMsg += ' Debug info: ' + String(debugInfo);
     }
-    var err = new Error(errMsg);
+    const err = new Error(errMsg);
     throw err;
 }
 function assertUsage(condition, msg) {
     if (condition) {
         return;
     }
-    var err = new Error('[DocPress][Wrong Usage] ' + msg);
+    const err = new Error('[DocPress][Wrong Usage] ' + msg);
     throw err;
 }
 function isBrowser() {
@@ -55,34 +55,32 @@ function isDevMode() {
     return isBrowser() && (!!window.localStorage[devModeKey] || isLocalhost());
 }
 function isLocalhost() {
-    var _a;
-    return ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.port) !== '';
+    return window?.location?.port !== '';
 }
 function toggleDevMode() {
     if (isLocalhost())
         throw new Error('On localhost DEV MODE is always on.');
-    var isEnabled = function () { return window.localStorage[devModeKey]; };
+    const isEnabled = () => window.localStorage[devModeKey];
     if (!isEnabled()) {
         window.localStorage[devModeKey] = 'true';
     }
     else {
         delete window.localStorage[devModeKey];
     }
-    console.log("DEV MODE ".concat(isEnabled() ? 'enabled' : 'disabled'));
+    console.log(`DEV MODE ${isEnabled() ? 'enabled' : 'disabled'}`);
 }
-function assertWarning(condition, msg, _a) {
-    var _b = _a === void 0 ? {} : _a, _c = _b.onlyOnce, onlyOnce = _c === void 0 ? true : _c, showStackTrace = _b.showStackTrace;
+function assertWarning(condition, msg, { onlyOnce = true, showStackTrace } = {}) {
     if (condition) {
         return;
     }
-    var err = new Error(msg);
+    const err = new Error(msg);
     if (!import.meta.env.DEV) {
         throw err;
     }
     else {
         if (onlyOnce) {
-            var alreadyLogged = globalObject.alreadyLogged;
-            var key = onlyOnce === true ? msg : onlyOnce;
+            const { alreadyLogged } = globalObject;
+            const key = onlyOnce === true ? msg : onlyOnce;
             if (alreadyLogged.has(key))
                 return;
             alreadyLogged.add(key);

package/dist/utils/cls.js

@@ -1,5 +1,5 @@
 export { cls };
 function cls(className) {
-    var classNames = Array.isArray(className) ? className : [className];
+    const classNames = Array.isArray(className) ? className : [className];
     return classNames.filter(Boolean).join(' ');
 }

package/dist/utils/determineSectionUrlHash.js

@@ -4,7 +4,7 @@ export { determineSectionTitle };
 function determineSectionUrlHash(title) {
     title = title.toLowerCase();
     title = removeAccentsAndDiacritics(title);
-    var urlHash = title
+    const urlHash = title
         // \u4E00-\u9FA5 are chinese characters, see https://github.com/brillout/docpress/pull/2
         .split(/[^a-z0-9\u4E00-\u9FA5]+/)
         .filter(Boolean)
@@ -20,11 +20,11 @@ function removeAccentsAndDiacritics(str) {
     return str.normalize('NFD').replace(/[\u0300-\u036f]/g, '');
 }
 function determineSectionTitle(urlWithHash) {
-    assert(urlWithHash.includes('#'), { urlWithHash: urlWithHash });
-    var urlHash = urlWithHash.split('#')[1];
-    var title = urlHash
+    assert(urlWithHash.includes('#'), { urlWithHash });
+    const urlHash = urlWithHash.split('#')[1];
+    const title = urlHash
         .split('-')
-        .map(function (word, i) {
+        .map((word, i) => {
         if (i === 0) {
             return capitalizeFirstLetter(word);
         }

package/dist/utils/filter.js

@@ -1,8 +1,8 @@
 export { filter };
 // https://stackoverflow.com/questions/66341757/typescript-how-to-filter-the-object
 function filter(obj, predicate) {
-    var result = {};
-    Object.keys(obj).forEach(function (name) {
+    const result = {};
+    Object.keys(obj).forEach((name) => {
         if (predicate(obj[name], name)) {
             result[name] = obj[name];
         }

package/dist/utils/getGlobalObject.js

@@ -2,8 +2,8 @@ export function getGlobalObject(
 // We use the filename as key; each `getGlobalObject()` call should live inside a file with a unique filename.
 key, defaultValue) {
     // @ts-ignore
-    var globalObjectsAll = (globalThis[projectKey] = globalThis[projectKey] || {});
-    var globalObject = (globalObjectsAll[key] = globalObjectsAll[key] || defaultValue);
+    const globalObjectsAll = (globalThis[projectKey] = globalThis[projectKey] || {});
+    const globalObject = (globalObjectsAll[key] = globalObjectsAll[key] || defaultValue);
     return globalObject;
 }
-var projectKey = '_docpress';
+const projectKey = '_docpress';

package/dist/vite.config.js

@@ -5,15 +5,25 @@ import { parsePageSections } from './parsePageSections.js';
 import rehypePrettyCode from 'rehype-pretty-code';
 import remarkGfm from 'remark-gfm';
 import { transformerNotationDiff } from '@shikijs/transformers';
-var root = process.cwd();
-var prettyCode = [rehypePrettyCode, { theme: 'github-light', transformers: [transformerNotationDiff()] }];
-var rehypePlugins = [prettyCode];
-var remarkPlugins = [remarkGfm];
-var config = {
-    root: root,
+import { rehypeMetaToProps } from './code-blocks/rehypeMetaToProps.js';
+import { remarkDetype } from './code-blocks/remarkDetype.js';
+import { shikiTransformerAutoLinks } from './code-blocks/shikiTransformerAutoLinks.js';
+const root = process.cwd();
+const prettyCode = [
+    rehypePrettyCode,
+    {
+        theme: 'github-light',
+        keepBackground: false,
+        transformers: [transformerNotationDiff(), shikiTransformerAutoLinks()],
+    },
+];
+const rehypePlugins = [prettyCode, [rehypeMetaToProps]];
+const remarkPlugins = [remarkGfm, remarkDetype];
+const config = {
+    root,
     plugins: [
         parsePageSections(),
-        mdx({ rehypePlugins: rehypePlugins, remarkPlugins: remarkPlugins }),
+        mdx({ rehypePlugins, remarkPlugins, providerImportSource: '@brillout/docpress' }),
         // @vitejs/plugin-react-swc needs to be added *after* the mdx plugins
         react(),
     ],

package/index.ts

@@ -1,21 +1,23 @@
-export {
-  CodeBlockTransformer,
-  Link,
-  RepoLink,
-  FileAdded,
-  FileRemoved,
-  ImportMeta,
-  Emoji,
-} from './components'
+/**********/
+/* PUBLIC */
+/**********/
+export { CodeBlockTransformer, Link, RepoLink, FileAdded, FileRemoved, ImportMeta, Emoji } from './components'
+export { TypescriptOnly } from './code-blocks/components/CodeSnippets'
 export { MenuToggle } from './Layout'
-
-// The only place usePageContext() is used at:
-// https://github.com/vikejs/vike/blob/0b1b109f64aafbed23a1c2ac2630e6146a270ec0/packages/vike.dev/components/CommunityNote.tsx#L4
-export { usePageContext } from './renderer/usePageContext'
-
 export * from './components/Note'
 export * from './icons/index'
 export { assert } from './utils/assert'
 export { parseMarkdownMini } from './parseMarkdownMini'
 export type { Config } from './types/Config'
 export type { HeadingDefinition, HeadingDetachedDefinition } from './types/Heading'
+// The only place usePageContext() is used at:
+// https://github.com/vikejs/vike/blob/0b1b109f64aafbed23a1c2ac2630e6146a270ec0/packages/vike.dev/components/CommunityNote.tsx#L4
+export { usePageContext } from './renderer/usePageContext'
+
+// The following are used internally by DocPress — users (should) never use these exports
+/************/
+/* INTERNAL */
+/************/
+// We provide our own `useMDXComponents()` to enable MDX component injection by setting `providerImportSource` to '@brillout/docpress'.
+// https://mdxjs.com/guides/injecting-components/
+export { useMDXComponents } from './code-blocks/hooks/useMDXComponents'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/docpress",
-  "version": "0.15.10",
+  "version": "0.15.11-commit-e615832",
   "type": "module",
   "dependencies": {
     "@brillout/picocolors": "^1.0.10",
@@ -11,9 +11,11 @@
     "@mdx-js/rollup": "3.0.1",
     "@shikijs/transformers": "1.2.0",
     "@vitejs/plugin-react-swc": "^3.10.2",
+    "detype": "^1.1.3",
     "rehype-pretty-code": "0.13.0",
     "remark-gfm": "4.0.0",
     "shiki": "1.2.0",
+    "unist-util-visit": "^5.0.0",
     "vite": "^6.3.5"
   },
   "peerDependencies": {
@@ -58,9 +60,12 @@
   },
   "devDependencies": {
     "@brillout/release-me": "^0.4.8",
+    "@types/hast": "^3.0.4",
+    "@types/mdast": "^4.0.4",
     "@types/node": "^22.5.5",
     "@types/react": "^18.3.8",
-    "@types/react-dom": "^18.3.0"
+    "@types/react-dom": "^18.3.0",
+    "mdast-util-mdx-jsx": "^3.2.0"
   },
   "repository": "https://github.com/brillout/docpress",
   "license": "MIT",

package/resolvePageContext.ts

@@ -13,7 +13,7 @@ import type {
   HeadingDetachedResolved,
   StringArray,
 } from './types/Heading'
-import { assert } from './utils/assert'
+import { assert, assertUsage } from './utils/assert'
 import { jsxToTextContent } from './utils/jsxToTextContent'
 import pc from '@brillout/picocolors'
 import { parseMarkdownMini } from './parseMarkdownMini'
@@ -149,6 +149,16 @@ function getActiveHeading(
   headingsDetachedResolved: HeadingDetachedResolved[],
   urlPathname: string,
 ) {
+  const URLs =
+    '\n' +
+    [...headingsResolved, ...headingsDetachedResolved]
+      .filter(Boolean)
+      .map((h) => h.url)
+      .sort()
+      .map((url) => `  ${url}`)
+      .join('\n')
+  const errNotFound = `URL ${pc.bold(urlPathname)} not found in following URLs:${URLs}`
+  const errFoundTwice = `URL ${pc.bold(urlPathname)} found twice in following URLs:${URLs}`
   let activeHeading: HeadingResolved | HeadingDetachedResolved | null = null
   let activeCategoryName = 'Miscellaneous'
   let headingCategory: string | undefined
@@ -158,6 +168,7 @@ function getActiveHeading(
       headingCategory = heading.title
     }
     if (heading.url === urlPathname) {
+      assertUsage(!activeHeading, errFoundTwice)
       activeHeading = heading
       assert(headingCategory)
       activeCategoryName = headingCategory
@@ -167,21 +178,14 @@ function getActiveHeading(
   }
   const isDetachedPage = !activeHeading
   if (!activeHeading) {
-    activeHeading = headingsDetachedResolved.find(({ url }) => urlPathname === url) ?? null
-  }
-  if (!activeHeading) {
-    throw new Error(
-      [
-        `URL ${pc.bold(urlPathname)} not found in following URLs:`,
-        [...headingsResolved, ...headingsDetachedResolved]
-          .filter(Boolean)
-          .map((h) => h.url)
-          .sort()
-          .map((url) => `  ${url}`)
-          .join('\n'),
-      ].join('\n'),
-    )
+    const found = headingsDetachedResolved.filter(({ url }) => urlPathname === url)
+    if (found.length > 0) {
+      assertUsage(found.length === 1, errFoundTwice)
+      assertUsage(!activeHeading, errFoundTwice)
+      activeHeading = found[0]!
+    }
   }
+  assertUsage(activeHeading, errNotFound)
   if (activeHeading.category) activeCategoryName = activeHeading.category
   return { activeHeading, isDetachedPage, activeCategoryName }
 }

package/tsconfig.json

@@ -2,7 +2,8 @@
   "compilerOptions": {
     "outDir": "./dist/",
     "jsx": "react",
-    "module": "ES2020",
+    "module": "ES2022",
+    "target": "ES2022",
     "moduleResolution": "Bundler",
     "lib": ["DOM", "DOM.Iterable", "ESNext"],
     "types": ["vite/client"],

package/vite.config.ts

@@ -7,17 +7,27 @@ import { parsePageSections } from './parsePageSections.js'
 import rehypePrettyCode from 'rehype-pretty-code'
 import remarkGfm from 'remark-gfm'
 import { transformerNotationDiff } from '@shikijs/transformers'
+import { rehypeMetaToProps } from './code-blocks/rehypeMetaToProps.js'
+import { remarkDetype } from './code-blocks/remarkDetype.js'
+import { shikiTransformerAutoLinks } from './code-blocks/shikiTransformerAutoLinks.js'
 
 const root = process.cwd()
-const prettyCode = [rehypePrettyCode, { theme: 'github-light', transformers: [transformerNotationDiff()] }]
-const rehypePlugins: any = [prettyCode]
-const remarkPlugins = [remarkGfm]
+const prettyCode = [
+  rehypePrettyCode,
+  {
+    theme: 'github-light',
+    keepBackground: false,
+    transformers: [transformerNotationDiff(), shikiTransformerAutoLinks()],
+  },
+]
+const rehypePlugins: any = [prettyCode, [rehypeMetaToProps]]
+const remarkPlugins = [remarkGfm, remarkDetype]
 
 const config: UserConfig = {
   root,
   plugins: [
     parsePageSections(),
-    mdx({ rehypePlugins, remarkPlugins }) as PluginOption,
+    mdx({ rehypePlugins, remarkPlugins, providerImportSource: '@brillout/docpress' }) as PluginOption,
     // @vitejs/plugin-react-swc needs to be added *after* the mdx plugins
     react(),
   ],