@raystack/chronicle 0.1.3 → 0.3.0

package/src/cli/utils/scaffold.ts

@@ -0,0 +1,137 @@
+import { execSync } from 'child_process'
+import { createRequire } from 'module'
+import fs from 'fs'
+import path from 'path'
+import chalk from 'chalk'
+import { PACKAGE_ROOT } from './resolve'
+
+const COPY_FILES = ['src', 'source.config.ts', 'tsconfig.json']
+
+function copyRecursive(src: string, dest: string) {
+  const stat = fs.statSync(src)
+  if (stat.isDirectory()) {
+    fs.mkdirSync(dest, { recursive: true })
+    for (const entry of fs.readdirSync(src)) {
+      copyRecursive(path.join(src, entry), path.join(dest, entry))
+    }
+  } else {
+    fs.copyFileSync(src, dest)
+  }
+}
+
+function ensureRemoved(targetPath: string) {
+  try {
+    fs.lstatSync(targetPath)
+    fs.rmSync(targetPath, { recursive: true, force: true })
+  } catch {
+    // nothing exists, proceed
+  }
+}
+
+export function detectPackageManager(): string {
+  if (process.env.npm_config_user_agent) {
+    return process.env.npm_config_user_agent.split('/')[0]
+  }
+  const cwd = process.cwd()
+  if (fs.existsSync(path.join(cwd, 'bun.lock')) || fs.existsSync(path.join(cwd, 'bun.lockb'))) return 'bun'
+  if (fs.existsSync(path.join(cwd, 'pnpm-lock.yaml'))) return 'pnpm'
+  if (fs.existsSync(path.join(cwd, 'yarn.lock'))) return 'yarn'
+  return 'npm'
+}
+
+function generateNextConfig(scaffoldPath: string) {
+  const config = `import { createMDX } from 'fumadocs-mdx/next'
+
+const withMDX = createMDX()
+
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+}
+
+export default withMDX(nextConfig)
+`
+  fs.writeFileSync(path.join(scaffoldPath, 'next.config.mjs'), config)
+}
+
+function createPackageJson(): Record<string, unknown> {
+  return {
+    name: 'chronicle-docs',
+    private: true,
+    dependencies: {
+      '@raystack/chronicle': `^${getChronicleVersion()}`,
+    },
+    devDependencies: {
+      '@raystack/tools-config': '0.56.0',
+      'openapi-types': '^12.1.3',
+      typescript: '5.9.3',
+      '@types/react': '^19.2.10',
+      '@types/node': '^25.1.0',
+    },
+  }
+}
+
+function ensureDeps() {
+  const cwd = process.cwd()
+  const cwdPkgJson = path.join(cwd, 'package.json')
+  const cwdNodeModules = path.join(cwd, 'node_modules')
+
+  if (fs.existsSync(cwdPkgJson) && fs.existsSync(cwdNodeModules)) {
+    // Case 1: existing project with deps installed
+    return
+  }
+
+  // Case 2: no package.json — create in cwd and install
+  if (!fs.existsSync(cwdPkgJson)) {
+    fs.writeFileSync(cwdPkgJson, JSON.stringify(createPackageJson(), null, 2) + '\n')
+  }
+
+  if (!fs.existsSync(cwdNodeModules)) {
+    const pm = detectPackageManager()
+    console.log(chalk.cyan(`Installing dependencies with ${pm}...`))
+    execSync(`${pm} install`, { cwd, stdio: 'inherit' })
+  }
+}
+
+export function getChronicleVersion(): string {
+  const pkgPath = path.join(PACKAGE_ROOT, 'package.json')
+  const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
+  return pkg.version
+}
+
+export function resolveNextCli(): string {
+  const chronicleRequire = createRequire(path.join(PACKAGE_ROOT, 'package.json'))
+  return chronicleRequire.resolve('next/dist/bin/next')
+}
+
+export function scaffoldDir(contentDir: string): string {
+  const scaffoldPath = path.join(process.cwd(), '.chronicle')
+
+  // Create .chronicle/ if not exists
+  if (!fs.existsSync(scaffoldPath)) {
+    fs.mkdirSync(scaffoldPath, { recursive: true })
+  }
+
+  // Copy package files
+  for (const name of COPY_FILES) {
+    const src = path.join(PACKAGE_ROOT, name)
+    const dest = path.join(scaffoldPath, name)
+    ensureRemoved(dest)
+    copyRecursive(src, dest)
+  }
+
+  // Generate next.config.mjs
+  generateNextConfig(scaffoldPath)
+
+  // Symlink content dir
+  const contentLink = path.join(scaffoldPath, 'content')
+  ensureRemoved(contentLink)
+  fs.symlinkSync(path.resolve(contentDir), contentLink)
+
+  // Ensure dependencies are available
+  ensureDeps()
+
+  console.log(chalk.gray(`Scaffold: ${scaffoldPath}`))
+
+  return scaffoldPath
+}

package/src/components/ui/search.module.css

@@ -102,3 +102,10 @@
 .item[data-selected="true"] .icon {
   color: var(--rs-color-foreground-accent-primary-hover);
 }
+
+.pageText :global(mark),
+.headingText :global(mark) {
+  background: transparent;
+  color: var(--rs-color-foreground-accent-primary);
+  font-weight: 600;
+}

package/src/components/ui/search.tsx

@@ -111,7 +111,7 @@ export function Search({ className }: SearchProps) {
                         <div className={styles.itemContent}>
                           {getResultIcon(result)}
                           <Text className={styles.pageText}>
-                            {stripMethod(result.content)}
+                            <HighlightedText html={stripMethod(result.content)} />
                           </Text>
                         </div>
                       </Command.Item>
@@ -132,7 +132,7 @@ export function Search({ className }: SearchProps) {
                         {result.type === "heading" ? (
                           <>
                             <Text className={styles.headingText}>
-                              {stripMethod(result.content)}
+                              <HighlightedText html={stripMethod(result.content)} />
                             </Text>
                             <Text className={styles.separator}>-</Text>
                             <Text className={styles.pageText}>
@@ -141,7 +141,7 @@ export function Search({ className }: SearchProps) {
                           </>
                         ) : (
                           <Text className={styles.pageText}>
-                            {stripMethod(result.content)}
+                            <HighlightedText html={stripMethod(result.content)} />
                           </Text>
                         )}
                       </div>
@@ -178,6 +178,10 @@ function stripMethod(content: string): string {
   return API_METHODS.has(first) ? content.slice(first.length + 1) : content;
 }
 
+function HighlightedText({ html, className }: { html: string; className?: string }) {
+  return <span className={className} dangerouslySetInnerHTML={{ __html: html }} />;
+}
+
 function getResultIcon(result: SortedResult): React.ReactNode {
   if (!result.url.startsWith("/apis/")) {
     return result.type === "page" ? (

package/src/lib/config.ts

@@ -11,11 +11,29 @@ const defaultConfig: ChronicleConfig = {
   search: { enabled: true, placeholder: 'Search...' },
 }
 
+function resolveConfigPath(): string | null {
+  // Check project root via env var
+  const projectRoot = process.env.CHRONICLE_PROJECT_ROOT
+  if (projectRoot) {
+    const rootPath = path.join(projectRoot, CONFIG_FILE)
+    if (fs.existsSync(rootPath)) return rootPath
+  }
+  // Check cwd
+  const cwdPath = path.join(process.cwd(), CONFIG_FILE)
+  if (fs.existsSync(cwdPath)) return cwdPath
+  // Check content dir
+  const contentDir = process.env.CHRONICLE_CONTENT_DIR
+  if (contentDir) {
+    const contentPath = path.join(contentDir, CONFIG_FILE)
+    if (fs.existsSync(contentPath)) return contentPath
+  }
+  return null
+}
+
 export function loadConfig(): ChronicleConfig {
-  const dir = process.env.CHRONICLE_CONTENT_DIR ?? process.cwd()
-  const configPath = path.join(dir, CONFIG_FILE)
+  const configPath = resolveConfigPath()
 
-  if (!fs.existsSync(configPath)) {
+  if (!configPath) {
     return defaultConfig
   }
 
@@ -33,5 +51,6 @@ export function loadConfig(): ChronicleConfig {
     footer: userConfig.footer,
     api: userConfig.api,
     llms: { enabled: false, ...userConfig.llms },
+    analytics: { enabled: false, ...userConfig.analytics },
   }
 }

package/src/lib/source.ts

@@ -1,4 +1,4 @@
-import { docs } from '../../.source/server'
+import { docs } from '@/.source/server'
 import { loader } from 'fumadocs-core/source'
 import type { PageTree, PageTreeItem, Frontmatter } from '@/types'
 

package/src/types/config.ts

@@ -1,6 +1,7 @@
 export interface ChronicleConfig {
   title: string
   description?: string
+  url?: string
   logo?: LogoConfig
   theme?: ThemeConfig
   navigation?: NavigationConfig
@@ -8,12 +9,22 @@ export interface ChronicleConfig {
   footer?: FooterConfig
   api?: ApiConfig[]
   llms?: LlmsConfig
+  analytics?: AnalyticsConfig
 }
 
 export interface LlmsConfig {
   enabled?: boolean
 }
 
+export interface AnalyticsConfig {
+  enabled?: boolean
+  googleAnalytics?: GoogleAnalyticsConfig
+}
+
+export interface GoogleAnalyticsConfig {
+  measurementId: string
+}
+
 export interface ApiConfig {
   name: string
   spec: string

package/src/types/content.ts

@@ -5,6 +5,7 @@ export interface Frontmatter {
   description?: string
   order?: number
   icon?: string
+  lastModified?: string
 }
 
 export interface Page {

package/tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "composite": false,
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "inlineSources": false,
+    "isolatedModules": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "jsx": "react-jsx",
+    "module": "ESNext",
+    "target": "es6",
+    "outDir": "dist",
+    "rootDir": ".",
+    "baseUrl": ".",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "moduleResolution": "bundler",
+    "paths": {
+      "@/*": ["./src/*"],
+      "@/.source/*": ["./.source/*"]
+    }
+  },
+  "include": ["src", ".source", "source.config.ts"],
+  "exclude": ["node_modules", "dist"]
+}