@brillout/docpress 0.16.11 → 0.16.13

package/docsearch/SearchLink.tsx

@@ -1,8 +1,8 @@
 export { SearchLink }
 
 import React from 'react'
-import { openDocsearchModal } from './toggleDocsearchModal'
-import { iconMagnifyingGlass } from '../icons'
+import { openDocsearchModal } from './toggleDocsearchModal.js'
+import { iconMagnifyingGlass } from '../icons/index.js'
 
 type PropsAnchor = React.HTMLProps<HTMLAnchorElement>
 function SearchLink(props: PropsAnchor) {

package/docsearch/toggleDocsearchModal.ts

@@ -1,7 +1,7 @@
 export { closeDocsearchModal }
 export { openDocsearchModal }
 
-import { assert } from '../utils/client'
+import { assert } from '../utils/client.js'
 
 function closeDocsearchModal() {
   if (isClosed()) return

package/index.ts

@@ -1,17 +1,17 @@
 /**********/
 /* PUBLIC */
 /**********/
-export { CodeBlockTransformer, Link, RepoLink, FileAdded, FileRemoved, ImportMeta, Emoji } from './components'
-export { MenuToggle } from './Layout'
-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'
+export { CodeBlockTransformer, Link, RepoLink, FileAdded, FileRemoved, ImportMeta, Emoji } from './components/index.js'
+export { MenuToggle } from './Layout.js'
+export * from './components/Note.js'
+export * from './icons/index.js'
+export { assert } from './utils/assert.js'
+export { parseMarkdownMini } from './parseMarkdownMini.js'
+export type { Config } from './types/Config.js'
+export type { HeadingDefinition, HeadingDetachedDefinition } from './types/Heading.js'
 // 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 { usePageContext } from './renderer/usePageContext.js'
 
 // The following are used internally by DocPress — users (should) never use these exports
 /************/
@@ -19,4 +19,4 @@ export { usePageContext } from './renderer/usePageContext'
 /************/
 // 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'
+export { useMDXComponents } from './code-blocks/hooks/useMDXComponents.js'

package/initKeyBindings.ts

@@ -1,7 +1,7 @@
 export { initKeyBindings }
 
-import { closeDocsearchModal } from './docsearch/toggleDocsearchModal'
-import { closeMenuModal } from './MenuModal/toggleMenuModal'
+import { closeDocsearchModal } from './docsearch/toggleDocsearchModal.js'
+import { closeMenuModal } from './MenuModal/toggleMenuModal.js'
 
 function initKeyBindings() {
   window.addEventListener(

package/installSectionUrlHashs.ts

@@ -1,6 +1,6 @@
 export { installSectionUrlHashs }
 
-import { assert } from './utils/client'
+import { assert } from './utils/client.js'
 
 // TO-DO/eventually: use React instead of manually installing click handlers?
 function installSectionUrlHashs() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/docpress",
-  "version": "0.16.11",
+  "version": "0.16.13",
   "type": "module",
   "dependencies": {
     "@brillout/picocolors": "^1.0.10",

package/parsePageSections.ts

@@ -68,8 +68,8 @@ function transform(code: string) {
 
 function parsePageSection(line: string): PageSection & { headingHtml: string } {
   const [lineBegin, ...lineWords] = line.split(' ')
-  assert(lineBegin.split('#').join('') === '', { line, lineWords })
-  const pageSectionLevel = lineBegin.length
+  assert(lineBegin!.split('#').join('') === '', { line, lineWords })
+  const pageSectionLevel = lineBegin!.length
 
   const titleMdx = lineWords.join(' ')
   assert(!titleMdx.startsWith(' '), { line, lineWords })

package/renderer/getHydrationPromise.ts

@@ -1,8 +1,8 @@
 export { getHydrationPromise }
 export { setHydrationIsFinished }
 
-import { getGlobalObject } from '../utils/client'
-import { genPromise } from '../utils/genPromise'
+import { getGlobalObject } from '../utils/client.js'
+import { genPromise } from '../utils/genPromise.js'
 
 const globalObject = getGlobalObject<{
   hydrationPromise: Promise<void>

package/renderer/getPageElement.tsx

@@ -1,10 +1,10 @@
 export { getPageElement }
 
 import type { PageContext } from 'vike/types'
-import { PageContextProvider } from './usePageContext'
+import { PageContextProvider } from './usePageContext.js'
 import React from 'react'
-import { DocSearchInstall } from '../docsearch/DocSearchInstall'
-import { Layout } from '../Layout'
+import { DocSearchInstall } from '../docsearch/DocSearchInstall.js'
+import { Layout } from '../Layout.js'
 
 function getPageElement(pageContext: PageContext) {
   const { Page } = pageContext

package/renderer/initOnNavigation.ts

@@ -1,8 +1,8 @@
 export { initOnNavigation }
 
-import { isBrowser } from '../utils/isBrowser'
-import { closeMenuModal } from '../MenuModal/toggleMenuModal'
-import { unexpandNav } from '../Layout'
+import { isBrowser } from '../utils/isBrowser.js'
+import { closeMenuModal } from '../MenuModal/toggleMenuModal.js'
+import { unexpandNav } from '../Layout.js'
 
 function onNavigation() {
   closeMenuModal()

package/renderer/onCreatePageContext.ts

@@ -1,7 +1,7 @@
 export { onCreatePageContext }
 
 import type { PageContextServer } from 'vike/types'
-import { resolvePageContext } from '../resolvePageContext'
+import { resolvePageContext } from '../resolvePageContext.js'
 
 function onCreatePageContext(pageContext: PageContextServer) {
   pageContext.resolved = resolvePageContext(pageContext)

package/renderer/onRenderClient.tsx

@@ -3,16 +3,16 @@ export { onRenderClient }
 import React, { useEffect } from 'react'
 import type { PageContextClient } from 'vike/types'
 import ReactDOM from 'react-dom/client'
-import { getPageElement } from './getPageElement'
-import { closeMenuModal } from '../MenuModal/toggleMenuModal'
+import { getPageElement } from './getPageElement.js'
+import { closeMenuModal } from '../MenuModal/toggleMenuModal.js'
 import '../css/index.css'
-import { autoScrollNav } from '../autoScrollNav'
-import { installSectionUrlHashs } from '../installSectionUrlHashs'
-import { getGlobalObject } from '../utils/client'
-import { initKeyBindings } from '../initKeyBindings'
-import { initOnNavigation } from './initOnNavigation'
-import { setHydrationIsFinished } from './getHydrationPromise'
-import { addScript } from '../utils/addScript'
+import { autoScrollNav } from '../autoScrollNav.js'
+import { installSectionUrlHashs } from '../installSectionUrlHashs.js'
+import { getGlobalObject } from '../utils/client.js'
+import { initKeyBindings } from '../initKeyBindings.js'
+import { initOnNavigation } from './initOnNavigation.js'
+import { setHydrationIsFinished } from './getHydrationPromise.js'
+import { addScript } from '../utils/addScript.js'
 
 const globalObject = getGlobalObject<{
   root?: ReactDOM.Root

package/renderer/onRenderHtml.tsx

@@ -2,10 +2,10 @@ export { onRenderHtml }
 
 import ReactDOMServer from 'react-dom/server'
 import { escapeInject, dangerouslySkipEscape } from 'vike/server'
-import { assert, assertUsage } from '../utils/server'
-import { getPageElement } from './getPageElement'
+import { assert, assertUsage } from '../utils/server.js'
+import { getPageElement } from './getPageElement.js'
 import type { PageContextServer } from 'vike/types'
-import type { Config } from '../types/Config'
+import type { Config } from '../types/Config.js'
 
 async function onRenderHtml(pageContext: PageContextServer): Promise<any> {
   const page = getPageElement(pageContext)
@@ -108,11 +108,17 @@ function getOpenGraphTags(url: string, documentTitle: string, config: Config) {
 // - Single PNG:
 //   https://rubyonrails.org
 // - Favicon shown in browser is different than favicon shown in Google:
-//   https://evilmartians.com
-//   Shown in Google: <link rel="apple-touch-icon" href="/apple-touch-icon.png" /> or <link rel="manifest" href="/manifest.webmanifest" />
-//   Shown in Browser: <link rel="icon" href="/favicon.svg" type="image/svg+xml" />
-//   https://gemini.google.com/share/8bcf76a26783
-//   https://chatgpt.com/share/696930b6-4414-800d-9c55-598ac7fa1ccb
+//   - Resources:
+//     https://gemini.google.com/share/8bcf76a26783
+//     https://chatgpt.com/share/696930b6-4414-800d-9c55-598ac7fa1ccb
+//   - https://evilmartians.com
+//     Shown in Google: <link rel="apple-touch-icon" href="/apple-touch-icon.png" /> or <link rel="manifest" href="/manifest.webmanifest" />
+//     Shown in Browser: <link rel="icon" href="/favicon.svg" type="image/svg+xml" />
+//     Google preview is fake (it picks the browser one, not the Google one): https://t3.gstatic.com/faviconV2?client=SOCIAL&type=FAVICON&fallback_opts=TYPE,SIZE,URL&url=https://evilmartians.com&size=48
+//   - https://vike.dev
+//     Shown in Google: <link rel="apple-touch-icon" href="/apple-touch-icon.png" />
+//     Shown in Browser: <link rel="icon" href="/favicon.svg" type="image/svg+xml" />
+//     Google preview is fake (it picks the browser one, not the Google one): https://t3.gstatic.com/faviconV2?client=SOCIAL&type=FAVICON&fallback_opts=TYPE,SIZE,URL&url=https://vike.dev&size=48
 function getFaviconTags(config: Config) {
   const { faviconBrowser, faviconGoogle } = getFavicons(config)
   assert(faviconBrowser)

package/renderer/usePageContext.tsx

@@ -4,7 +4,7 @@ export { usePageContextLegacy }
 
 import React, { useContext } from 'react'
 import type { PageContext } from 'vike/types'
-import { getGlobalObject } from '../utils/getGlobalObject'
+import { getGlobalObject } from '../utils/getGlobalObject.js'
 
 const globalObject = getGlobalObject('usePageContext.ts', {
   Ctx: React.createContext<PageContext>(undefined as any),

package/resolvePageContext.ts

@@ -1,23 +1,23 @@
 export { resolvePageContext }
 export type Resolved = ReturnType<typeof resolvePageContext>
 
-import type { Config } from './types/Config'
-import type { NavItem } from './NavItemComponent'
-import type { LinkData } from './components'
+import type { Config } from './types/Config.js'
+import type { NavItem } from './NavItemComponent.js'
+import type { LinkData } from './components/index.js'
 import type { PageContextServer } from 'vike/types'
-import type { PageSection } from './parsePageSections'
+import type { PageSection } from './parsePageSections.js'
 import type {
   HeadingDefinition,
   HeadingDetachedDefinition,
   HeadingResolved,
   HeadingDetachedResolved,
   StringArray,
-} from './types/Heading'
-import { assert, assertUsage } from './utils/assert'
-import { jsxToTextContent } from './utils/jsxToTextContent'
+} from './types/Heading.js'
+import { assert, assertUsage } from './utils/assert.js'
+import { jsxToTextContent } from './utils/jsxToTextContent.js'
 import pc from '@brillout/picocolors'
-import { parseMarkdownMini } from './parseMarkdownMini'
-import { determineNavItemsColumnLayout } from './determineNavItemsColumnLayout'
+import { parseMarkdownMini } from './parseMarkdownMini.js'
+import { determineNavItemsColumnLayout } from './determineNavItemsColumnLayout.js'
 
 type PageSectionResolved = {
   url: string | null
@@ -152,8 +152,8 @@ function getActiveHeading(
   const URLs =
     '\n' +
     [...headingsResolved, ...headingsDetachedResolved]
-      .filter(Boolean)
       .map((h) => h.url)
+      .filter(Boolean)
       .sort()
       .map((url) => `  ${url}`)
       .join('\n')

package/tsconfig.json

@@ -1,17 +1,25 @@
 {
   "compilerOptions": {
-    "outDir": "./dist/",
-    "jsx": "react",
-    "module": "ES2022",
-    "target": "ES2022",
-    "moduleResolution": "Bundler",
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "types": ["vite/client"],
-    "esModuleInterop": true,
+    // Misc
     "skipLibCheck": true,
-    "allowSyntheticDefaultImports": true,
-    "declaration": true,
-    // "noUncheckedIndexedAccess": true,
-    "strict": true
+    "noErrorTruncation": true,
+    // Strictness
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    // Resolution
+    "esModuleInterop": true,
+    "moduleResolution": "Node16",
+    "jsx": "react",
+    // Libs
+    "lib": ["DOM", "DOM.Iterable", "ES2022"],
+    "types": ["node", "vite/client"],
+    // Output
+    "target": "ES2020",
+    "module": "Node16",
+    "outDir": "./dist/",
+    "rootDir": "./",
+    "declaration": true
   }
 }

package/types/Config.ts

@@ -1,6 +1,6 @@
 export type { Config }
 
-import type { HeadingDefinition, HeadingDetachedDefinition } from './Heading'
+import type { HeadingDefinition, HeadingDetachedDefinition } from './Heading.js'
 
 type Config = {
   name: string

package/utils/Emoji/Emoji.ts

@@ -1,9 +1,9 @@
 // Let's eventually remove this. Telefunc is still using this as of 2024-12.
 
 import React from 'react'
-import { assert } from '../assert'
+import { assert } from '../assert.js'
 
-import { iconMechanicalArm, iconShield, iconTypescript, iconEngine } from './assets'
+import { iconMechanicalArm, iconShield, iconTypescript, iconEngine } from './assets.js'
 
 export { Emoji }
 export type { EmojiName }

package/utils/Emoji/index.ts

@@ -1 +1 @@
-export * from './Emoji'
+export * from './Emoji.js'

package/utils/addScript.ts

@@ -1,6 +1,6 @@
 export { addScript }
 
-import { genPromise } from './genPromise'
+import { genPromise } from './genPromise.js'
 
 async function addScript(src: string) {
   const { promise, resolve, reject } = genPromise()

package/utils/client.ts

@@ -1,3 +1,3 @@
-export * from './assert'
-export * from './isBrowser'
-export * from './getGlobalObject'
+export * from './assert.js'
+export * from './isBrowser.js'
+export * from './getGlobalObject.js'

package/utils/determineSectionUrlHash.ts

@@ -26,7 +26,7 @@ function removeAccentsAndDiacritics(str: string): string {
 
 function determineSectionTitle(urlWithHash: string): string {
   assert(urlWithHash.includes('#'), { urlWithHash })
-  const urlHash = urlWithHash.split('#')[1]
+  const urlHash = urlWithHash.split('#')[1]!
   const title = urlHash
     .split('-')
     .map((word, i) => {
@@ -40,5 +40,5 @@ function determineSectionTitle(urlWithHash: string): string {
 }
 
 function capitalizeFirstLetter(word: string): string {
-  return word[0].toUpperCase() + word.slice(1)
+  return word[0]!.toUpperCase() + word.slice(1)
 }

package/utils/jsxToTextContent.ts

@@ -1,4 +1,4 @@
-import { assert } from './assert'
+import { assert } from './assert.js'
 
 export { jsxToTextContent }
 

package/utils/server.ts

@@ -1,7 +1,7 @@
-export * from './client'
-export * from './isBrowser'
-export * from './filter'
-export * from './determineSectionUrlHash'
-export * from './jsxToTextContent'
-export * from './objectAssign'
-export * from './Emoji'
+export * from './client.js'
+export * from './isBrowser.js'
+export * from './filter.js'
+export * from './determineSectionUrlHash.js'
+export * from './jsxToTextContent.js'
+export * from './objectAssign.js'
+export * from './Emoji/index.js'