@brillout/docpress 0.5.40 → 0.6.1

package/utils/assert.ts

@@ -0,0 +1,51 @@
+export { assert }
+export { assertUsage }
+export { assertWarning }
+
+function assert(condition: unknown, debugInfo?: unknown): asserts condition {
+  if (condition) {
+    return
+  }
+  const hasDebugInfo = debugInfo !== undefined
+  if (hasDebugInfo) {
+    console.log(debugInfo)
+    if (typeof debugInfo === 'object') {
+      debugInfo = JSON.stringify(debugInfo)
+    }
+  }
+  let errMsg = '[DocPress] Bug. Contact DocPress maintainer.'
+  if (hasDebugInfo) {
+    errMsg += ' Debug info: ' + String(debugInfo)
+  }
+  const err = new Error(errMsg)
+  if (isBrowserAndDev()) {
+    alert(err.stack)
+  }
+  throw err
+}
+
+function assertUsage(condition: unknown, msg: string): asserts condition {
+  if (condition) {
+    return
+  }
+  const err = new Error('[DocPress][Wrong Usage] ' + msg)
+  if (isBrowserAndDev()) {
+    alert(err.stack)
+  }
+  throw err
+}
+
+function isBrowserAndDev() {
+  return typeof window !== 'undefined' && window?.location?.port !== ''
+}
+
+function assertWarning(condition: unknown, msg: string): asserts condition {
+  if (condition) {
+    return
+  }
+  msg = '[DocPress][Warning] ' + msg
+  console.warn(msg)
+  if (isBrowserAndDev()) {
+    alert(msg)
+  }
+}

package/utils/client.ts

@@ -0,0 +1,2 @@
+export * from './assert'
+export * from './isBrowser'

package/utils/determineSectionUrlHash.ts

@@ -0,0 +1,44 @@
+import { assert } from './assert.js'
+
+export { determineSectionUrlHash }
+export { determineSectionTitle }
+
+function determineSectionUrlHash(title: string): string | null {
+  title = title.toLowerCase()
+  title = removeAccentsAndDiacritics(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)
+    .join('-')
+
+  // E.g. section is composed of only non-latin characters
+  if (urlHash === '') return null
+
+  return urlHash
+}
+
+// Remove accents/diacritics in a string in JavaScript
+// https://stackoverflow.com/questions/990904/remove-accents-diacritics-in-a-string-in-javascript/37511463#37511463
+function removeAccentsAndDiacritics(str: string): string {
+  return str.normalize('NFD').replace(/[\u0300-\u036f]/g, '')
+}
+
+function determineSectionTitle(urlWithHash: string): string {
+  assert(urlWithHash.includes('#'), { urlWithHash })
+  const urlHash = urlWithHash.split('#')[1]
+  const title = urlHash
+    .split('-')
+    .map((word, i) => {
+      if (i === 0) {
+        return capitalizeFirstLetter(word)
+      }
+      return word
+    })
+    .join(' ')
+  return title
+}
+
+function capitalizeFirstLetter(word: string): string {
+  return word[0].toUpperCase() + word.slice(1)
+}

package/utils/filesystemPathHandling.ts

@@ -0,0 +1,42 @@
+export { toPosixPath }
+export { assertPosixPath }
+export { toSystemPath }
+
+import assert from 'assert'
+
+const sepPosix = '/'
+const sepWin32 = '\\'
+
+function toPosixPath(path: string) {
+  if (isPosix()) {
+    assertPosixPath(path)
+    return path
+  }
+  if (isWin32()) {
+    const pathPosix = path.split(sepWin32).join(sepPosix)
+    assertPosixPath(pathPosix)
+    return pathPosix
+  }
+  assert(false)
+}
+
+function assertPosixPath(path: string) {
+  assert(path && !path.includes(sepWin32), `Wrongly formatted path: ${path}`)
+}
+
+function toSystemPath(path: string) {
+  if (isPosix()) {
+    return toPosixPath(path)
+  }
+  if (isWin32()) {
+    return path.split(sepPosix).join(sepWin32)
+  }
+  assert(false)
+}
+
+function isWin32() {
+  return process.platform === 'win32'
+}
+function isPosix() {
+  return !isWin32()
+}

package/utils/filter.ts

@@ -0,0 +1,12 @@
+export { filter }
+
+// https://stackoverflow.com/questions/66341757/typescript-how-to-filter-the-object
+function filter<T extends object>(obj: T, predicate: <K extends keyof T>(value: T[K], key: K) => boolean): T {
+  const result: { [K in keyof T]?: T[K] } = {}
+  ;(Object.keys(obj) as Array<keyof T>).forEach((name) => {
+    if (predicate(obj[name], name)) {
+      result[name] = obj[name]
+    }
+  })
+  return result as T
+}

package/utils/isBrowser.ts

@@ -0,0 +1,5 @@
+export { isBrowser }
+
+function isBrowser() {
+  return typeof window !== 'undefined'
+}

package/utils/jsxToTextContent.ts

@@ -0,0 +1,11 @@
+import { assert } from './assert'
+
+export { jsxToTextContent }
+
+// https://stackoverflow.com/questions/34204975/react-is-there-something-similar-to-node-textcontent/60564620#60564620
+function jsxToTextContent(node: JSX.Element | string): string {
+  if (['string', 'number'].includes(typeof node)) return String(node)
+  if (node instanceof Array) return node.map(jsxToTextContent).join('')
+  if (typeof node === 'object' && node) return jsxToTextContent(node.props.children)
+  assert(false)
+}

package/utils/objectAssign.ts

@@ -0,0 +1,9 @@
+export { objectAssign }
+
+// Same as `Object.assign()` but with type inference
+function objectAssign<Obj extends Object, ObjAddendum>(
+  obj: Obj,
+  objAddendum: ObjAddendum
+): asserts obj is Obj & ObjAddendum {
+  Object.assign(obj, objAddendum)
+}

package/utils/server.ts

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

package/vite.config.ts

@@ -0,0 +1,36 @@
+import mdx from '@mdx-js/rollup'
+import react from '@vitejs/plugin-react-swc'
+import vike from 'vike/plugin'
+import { UserConfig } from 'vite'
+import { markdownHeadingsVitePlugin } from './markdownHeadingsVitePlugin.js'
+import rehypePrettyCode from 'rehype-pretty-code'
+import remarkGfm from 'remark-gfm'
+
+const root = process.cwd()
+const prettyCode = [rehypePrettyCode, { theme: 'github-light' }]
+const rehypePlugins: any = [prettyCode]
+const remarkPlugins = [remarkGfm]
+
+const config: UserConfig = {
+  root,
+  plugins: [
+    markdownHeadingsVitePlugin(),
+    mdx({ rehypePlugins, remarkPlugins }),
+    // @vitejs/plugin-react-swc needs to be added *after* the mdx plugins
+    react(),
+    vike({
+      prerender: {
+        noExtraDir: true
+      },
+      includeAssetsImportedByServer: true
+    })
+  ],
+  optimizeDeps: { include: ['@mdx-js/react', 'react-dom'] },
+  // @ts-ignore
+  ssr: {
+    noExternal: ['@brillout/docpress']
+  },
+  clearScreen: false
+}
+
+export default config

package/bin.js

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-import './dist/cli/index.js'

package/dist/chunk-2ZTPUQGS.js

@@ -1,58 +0,0 @@
-// src/utils/assert.ts
-function assert(condition, debugInfo) {
-  if (condition) {
-    return;
-  }
-  const hasDebugInfo = debugInfo !== void 0;
-  if (hasDebugInfo) {
-    console.log(debugInfo);
-    if (typeof debugInfo === "object") {
-      debugInfo = JSON.stringify(debugInfo);
-    }
-  }
-  let errMsg = "[DocPress] Bug. Contact DocPress maintainer.";
-  if (hasDebugInfo) {
-    errMsg += " Debug info: " + String(debugInfo);
-  }
-  const err = new Error(errMsg);
-  if (isBrowserAndDev()) {
-    alert(err.stack);
-  }
-  throw err;
-}
-function assertUsage(condition, msg) {
-  if (condition) {
-    return;
-  }
-  const err = new Error("[DocPress][Wrong Usage] " + msg);
-  if (isBrowserAndDev()) {
-    alert(err.stack);
-  }
-  throw err;
-}
-function isBrowserAndDev() {
-  var _a;
-  return typeof window !== "undefined" && ((_a = window == null ? void 0 : window.location) == null ? void 0 : _a.port) !== "";
-}
-function assertWarning(condition, msg) {
-  if (condition) {
-    return;
-  }
-  msg = "[DocPress][Warning] " + msg;
-  console.warn(msg);
-  if (isBrowserAndDev()) {
-    alert(msg);
-  }
-}
-
-// src/utils/isBrowser.ts
-function isBrowser() {
-  return typeof window !== "undefined";
-}
-
-export {
-  assert,
-  assertUsage,
-  assertWarning,
-  isBrowser
-};

package/dist/chunk-3QC7HYIF.js

@@ -1,7 +0,0 @@
-var __freeze = Object.freeze;
-var __defProp = Object.defineProperty;
-var __template = (cooked, raw) => __freeze(__defProp(cooked, "raw", { value: __freeze(raw || cooked.slice()) }));
-
-export {
-  __template
-};

package/dist/chunk-MGOI4AFO.js

@@ -1,165 +0,0 @@
-import {
-  Emoji
-} from "./chunk-UN23G34B.js";
-import {
-  assert
-} from "./chunk-2ZTPUQGS.js";
-
-// src/components/RepoLink.tsx
-import React2 from "react";
-
-// src/renderer/usePageContext.tsx
-import React, { useContext } from "react";
-var Context = React.createContext(void 0);
-function PageContextProvider({
-  pageContext,
-  children
-}) {
-  return /* @__PURE__ */ React.createElement(Context.Provider, {
-    value: pageContext
-  }, children);
-}
-function usePageContext() {
-  const pageContext = useContext(Context);
-  return pageContext;
-}
-
-// src/components/RepoLink.tsx
-function isRepoLink(href) {
-  return ["/examples/", "/docs/", "/boilerplates/", ".github/", "/test/"].some((start) => href.startsWith(start));
-}
-function RepoLink({ path, text, editMode }) {
-  const pageContext = usePageContext();
-  assert(isRepoLink(path), { path });
-  text = text || path;
-  if (!path.startsWith("/")) {
-    path = "/" + path;
-  }
-  const viewMode = path.endsWith("/") || editMode ? "tree" : "blob";
-  const { githubRepository } = pageContext.config.projectInfo;
-  assert(githubRepository.startsWith("https://github.com/"));
-  const href = `${githubRepository}/${viewMode}/main${path}`;
-  return /* @__PURE__ */ React2.createElement("a", {
-    href
-  }, text);
-}
-
-// src/parseTitle.ts
-import React3 from "react";
-function getHeadingsWithProcessedTitle(config) {
-  const headingsWithoutBreadcrumb = config.headings.map(
-    (heading) => {
-      const titleProcessed = parseTitle(heading.title);
-      const titleInNav = heading.titleInNav || heading.title;
-      let titleInNavProcessed;
-      titleInNavProcessed = parseTitle(titleInNav);
-      if ("titleEmoji" in heading) {
-        assert(heading.titleEmoji);
-        titleInNavProcessed = withEmoji(heading.titleEmoji, titleInNavProcessed);
-      }
-      const headingProcessed = {
-        ...heading,
-        title: titleProcessed,
-        titleInNav: titleInNavProcessed
-      };
-      return headingProcessed;
-    }
-  );
-  const headingsProcessed = [];
-  headingsWithoutBreadcrumb.forEach((heading) => {
-    const headingsBreadcrumb = getHeadingsBreadcrumb(heading, headingsProcessed);
-    headingsProcessed.push({
-      ...heading,
-      headingsBreadcrumb
-    });
-  });
-  const headingsDetachedProcessed = config.headingsDetached.map((headingsDetached) => {
-    const { url, title } = headingsDetached;
-    assert(
-      headingsProcessed.find((heading) => heading.url === url) === void 0,
-      `remove ${headingsDetached.url} from headingsDetached`
-    );
-    const titleProcessed = typeof title === "string" ? parseTitle(title) : title;
-    return {
-      ...headingsDetached,
-      level: 2,
-      title: titleProcessed,
-      titleInNav: titleProcessed,
-      headingsBreadcrumb: null
-    };
-  });
-  assertHeadingsUrl([...headingsProcessed, ...headingsDetachedProcessed]);
-  return { headingsProcessed, headingsDetachedProcessed };
-}
-function getHeadingsBreadcrumb(heading, headings) {
-  const headingsBreadcrumb = [];
-  let levelCurrent = heading.level;
-  headings.slice().reverse().forEach((parentCandidate) => {
-    const isParent = parentCandidate.level < levelCurrent;
-    if (isParent) {
-      levelCurrent = parentCandidate.level;
-      headingsBreadcrumb.push(parentCandidate);
-    }
-  });
-  return headingsBreadcrumb;
-}
-function assertHeadingsUrl(headings) {
-  headings.forEach((heading) => {
-    if (heading.url) {
-      const { url } = heading;
-      assert(url.startsWith("/"));
-    }
-  });
-}
-function parseTitle(title) {
-  const parts = [];
-  let current;
-  title.split("").forEach((letter) => {
-    if (letter === "`") {
-      if ((current == null ? void 0 : current.nodeType) === "code") {
-        parts.push(current);
-        current = void 0;
-      } else {
-        if (current) {
-          parts.push(current);
-        }
-        current = { nodeType: "code", content: "" };
-      }
-    } else {
-      if (!current) {
-        current = { nodeType: "text", content: "" };
-      }
-      current.content += letter;
-    }
-  });
-  if (current) {
-    parts.push(current);
-  }
-  const titleJsx = React3.createElement(
-    React3.Fragment,
-    {},
-    ...parts.map(
-      (part, i) => React3.createElement(part.nodeType === "code" ? "code" : React3.Fragment, { key: i }, part.content)
-    )
-  );
-  return titleJsx;
-}
-function withEmoji(name, title) {
-  const style = { fontSize: "1.4em" };
-  return React3.createElement(
-    "span",
-    { style },
-    Emoji({ name }),
-    " ",
-    React3.createElement("span", { style: { fontSize: "1rem" } }, title)
-  );
-}
-
-export {
-  PageContextProvider,
-  usePageContext,
-  isRepoLink,
-  RepoLink,
-  getHeadingsWithProcessedTitle,
-  parseTitle
-};

package/dist/chunk-NVJING6T.js

@@ -1,91 +0,0 @@
-// src/components/features/FeatureList.tsx
-import React from "react";
-
-// src/components/features/chevron.svg
-var chevron_default = "/assets/chevron-R2IYJD62.svg";
-
-// src/components/features/FeatureList.tsx
-function FeatureList({ features }) {
-  const numberOfFeatures = features.length;
-  const numberOfRows = Math.ceil(numberOfFeatures / 2);
-  return /* @__PURE__ */ React.createElement("div", {
-    id: "features"
-  }, Array.from({ length: numberOfRows }, (_, i) => {
-    const feature1Id = 2 * i + 0;
-    const feature2Id = 2 * i + 1;
-    const feature1 = features[feature1Id];
-    const feature2 = features[feature2Id];
-    const className = ["features-row", feature2 ? "" : "single-column"].filter(Boolean).join(" ");
-    return /* @__PURE__ */ React.createElement("div", {
-      className,
-      key: i
-    }, /* @__PURE__ */ React.createElement(Feature, {
-      ...{ ...feature1, featureId: feature1Id }
-    }), feature2 && /* @__PURE__ */ React.createElement(Feature, {
-      ...{ ...feature2, featureId: feature2Id }
-    }));
-  }));
-}
-function Feature({ title, desc, learnMore, isSecondaryFeature, featureId }) {
-  const name = `feature-${featureId}`;
-  const rightSide = featureId % 2 === 1;
-  return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(FeatureHead, {
-    name,
-    hasLearnMore: !!learnMore,
-    isSecondaryFeature
-  }, " ", /* @__PURE__ */ React.createElement("h2", null, title), desc), !!learnMore && /* @__PURE__ */ React.createElement(LearnMore, {
-    name,
-    rightSide
-  }, learnMore));
-}
-function FeatureHead({
-  children,
-  name,
-  hasLearnMore,
-  isSecondaryFeature,
-  className = ""
-}) {
-  return /* @__PURE__ */ React.createElement("summary", {
-    className: [
-      className,
-      "feature",
-      "colorize-on-hover",
-      hasLearnMore && "has-learn-more",
-      isSecondaryFeature && "secondary-feature"
-    ].filter(Boolean).join(" "),
-    id: name && `feature-${name}`,
-    style: { cursor: hasLearnMore && "pointer" || void 0 }
-  }, children, hasLearnMore && /* @__PURE__ */ React.createElement("div", {
-    style: { textAlign: "center", marginTop: "1em" }
-  }, /* @__PURE__ */ React.createElement("button", {
-    type: "button",
-    style: {
-      textAlign: "center",
-      padding: "0 7px",
-      paddingTop: 3,
-      paddingBottom: 1,
-      display: "inline-block",
-      fontSize: "10px",
-      textTransform: "uppercase",
-      letterSpacing: "1px",
-      fontWeight: 600
-    }
-  }, /* @__PURE__ */ React.createElement("span", {
-    className: "decolorize-5"
-  }, "Learn more"), /* @__PURE__ */ React.createElement("br", null), /* @__PURE__ */ React.createElement("img", {
-    className: "decolorize-4 chevron",
-    src: chevron_default,
-    height: "7",
-    style: { marginTop: 2 }
-  }))));
-}
-function LearnMore({ children, name, rightSide }) {
-  return /* @__PURE__ */ React.createElement("aside", {
-    className: "learn-more " + (rightSide ? "right-side" : ""),
-    id: `learn-more-${name}`
-  }, children);
-}
-
-export {
-  FeatureList
-};