boltdocs 2.5.5 → 2.5.6

package/src/node/cli/doctor.ts

@@ -1,243 +0,0 @@
-import path from 'path'
-import fs from 'fs'
-import fastGlob from 'fast-glob'
-import { resolveConfig } from '../config'
-import { parseFrontmatter, normalizePath } from '../utils'
-import * as ui from './ui'
-
-/**
- * Interface representing a documentation hygiene issue.
- */
-interface Issue {
-  level: 'high' | 'warning' | 'low'
-  message: string
-  suggestion?: string
-}
-
-/**
- * Logic for the `boltdocs doctor` command.
- * Scans the documentation directory for broken links, missing frontmatter,
- * and orphaned translations.
- *
- * @param root - The project root directory
- */
-export async function doctorAction(root: string = process.cwd()) {
-  const { colors } = ui
-  ui.info(
-    `${colors.bold}Running documentation health check...${colors.reset}\n`,
-  )
-  const start = performance.now()
-
-  try {
-    const config = await resolveConfig('docs', root)
-    const docsDir = path.resolve(root, 'docs')
-
-    if (!fs.existsSync(docsDir)) {
-      ui.error(`Documentation directory not found at ${docsDir}`)
-      process.exit(1)
-    }
-
-    const files = await fastGlob(['**/*.md', '**/*.mdx'], {
-      cwd: docsDir,
-      absolute: true,
-      suppressErrors: true,
-    })
-
-    let highCount = 0
-    let warningCount = 0
-    let lowCount = 0
-    const issuesMap = new Map<string, Issue[]>()
-
-    const addIssue = (file: string, issue: Issue) => {
-      const relPath = path.relative(docsDir, file)
-      let issues = issuesMap.get(relPath)
-      if (!issues) {
-        issues = []
-        issuesMap.set(relPath, issues)
-      }
-      issues.push(issue)
-      if (issue.level === 'high') highCount++
-      else if (issue.level === 'warning') warningCount++
-      else if (issue.level === 'low') lowCount++
-    }
-
-    const basePath = '/docs'
-
-    // 1. Scan for Frontmatter, Links, and Content Issues
-    for (const file of files) {
-      const { data, content } = parseFrontmatter(file)
-
-      // Frontmatter Validation
-      if (!data.title) {
-        addIssue(file, {
-          level: 'warning',
-          message: 'Missing "title" in frontmatter.',
-          suggestion:
-            'Add `title: Your Title` to the YAML frontmatter at the top of the file.',
-        })
-      }
-
-      if (!data.description) {
-        addIssue(file, {
-          level: 'low',
-          message: 'Missing "description" in frontmatter.',
-          suggestion:
-            'Adding a description helps with SEO and search previews.',
-        })
-      }
-
-      // Link Validation
-      const linkRegex = /\[.*?\]\((.*?)\)/g
-      const htmlLinkRegex = /<a\s+[^>]*href=["']([^"']+)["'][^>]*>/g
-      const links = [
-        ...content.matchAll(linkRegex),
-        ...content.matchAll(htmlLinkRegex),
-      ]
-
-      for (const match of links) {
-        let link = match[1]
-        if (
-          !link ||
-          link.startsWith('http') ||
-          link.startsWith('https') ||
-          link.startsWith('#') ||
-          link.startsWith('mailto:') ||
-          link.startsWith('tel:')
-        ) {
-          continue
-        }
-
-        link = link.split('#')[0]
-        if (!link) continue
-
-        let targetPath: string
-        if (link.startsWith('/')) {
-          let pathAfterBase = link
-          if (link.startsWith(basePath + '/') || link === basePath) {
-            pathAfterBase = link.substring(basePath.length)
-          }
-          targetPath = path.join(docsDir, pathAfterBase)
-        } else {
-          targetPath = path.resolve(path.dirname(file), link)
-        }
-
-        const extensions = ['', '.md', '.mdx', '/index.md', '/index.mdx']
-        let exists = false
-        for (const ext of extensions) {
-          const finalPath = targetPath + ext
-          if (fs.existsSync(finalPath) && fs.statSync(finalPath).isFile()) {
-            exists = true
-            break
-          }
-        }
-
-        if (!exists) {
-          addIssue(file, {
-            level: 'high',
-            message: `Broken internal link: "${link}"`,
-            suggestion: `Ensure the file exists at "${targetPath}". If it's a directory, ensure it has an "index.md" or "index.mdx".`,
-          })
-        }
-      }
-    }
-
-    // 2. Scan for Orphaned Translations
-    if (config.i18n) {
-      const { defaultLocale, locales } = config.i18n
-      const otherLocales = Object.keys(locales).filter(
-        (l) => l !== defaultLocale,
-      )
-
-      for (const file of files) {
-        const relPath = normalizePath(path.relative(docsDir, file))
-        const parts = relPath.split('/')
-
-        if (parts[0] === defaultLocale) {
-          const pathAfterLocale = parts.slice(1).join('/')
-          for (const locale of otherLocales) {
-            const localeParts = [locale, ...parts.slice(1)]
-            const targetLocaleFile = path.join(docsDir, ...localeParts)
-
-            if (!fs.existsSync(targetLocaleFile)) {
-              addIssue(file, {
-                level: 'warning',
-                message: `Missing translation for locale "${locale}"`,
-                suggestion: `Create a translated version of this file at "${locale}/${pathAfterLocale}".`,
-              })
-            }
-          }
-        }
-      }
-    }
-
-    // Final Reporting
-    if (issuesMap.size === 0) {
-      ui.success('All documentation files are healthy!\n')
-    } else {
-      for (const [file, issues] of issuesMap.entries()) {
-        console.log(`📄 ${colors.bold}${file}${colors.reset}`)
-
-        const sortedIssues = issues.sort((a, b) => {
-          const order = { high: 1, warning: 2, low: 3 }
-          return order[a.level] - order[b.level]
-        })
-
-        for (const issue of sortedIssues) {
-          let prefix = ''
-          let color = ''
-          if (issue.level === 'high') {
-            prefix = '❌'
-            color = colors.red
-          } else if (issue.level === 'warning') {
-            prefix = '⚠️'
-            color = colors.yellow
-          } else {
-            prefix = 'ℹ️'
-            color = colors.cyan
-          }
-
-          console.log(
-            `   ${color}${prefix} ${issue.level.toUpperCase()}:${colors.reset} ${issue.message}`,
-          )
-          if (issue.suggestion) {
-            console.log(
-              `      ${colors.gray}💡 Suggestion: ${issue.suggestion}${colors.reset}`,
-            )
-          }
-        }
-        console.log('')
-      }
-
-      console.log(`${colors.bold}Summary:${colors.reset}`)
-      console.log(
-        `   ${colors.red}${highCount} high-level errors${colors.reset}`,
-      )
-      console.log(`   ${colors.yellow}${warningCount} warnings${colors.reset}`)
-      console.log(
-        `   ${colors.cyan}${lowCount} minor improvements${colors.reset}\n`,
-      )
-
-      if (highCount > 0) {
-        ui.error(
-          'HIGH ERROR: Fix these to ensure your documentation builds correctly.',
-        )
-      }
-      if (warningCount > 0 || lowCount > 0) {
-        ui.info(
-          'TIP: Address warnings and suggestions for premium quality docs.',
-        )
-      }
-      console.log('')
-    }
-
-    const duration = performance.now() - start
-    ui.info(`Finished in ${duration.toFixed(2)}ms\n`)
-
-    if (highCount > 0) {
-      process.exit(1)
-    }
-  } catch (e) {
-    ui.error('Failed to run doctor check:', e)
-    process.exit(1)
-  }
-}

package/src/node/cli/index.ts

@@ -1,9 +0,0 @@
-/**
- * Boltdocs CLI Actions Module.
- * This module exports all command-line actions used by the Boltdocs tool.
- */
-
-export * from './dev'
-export * from './build'
-export * from './doctor'
-export * from './ui'

package/src/node/cli/ui.ts

@@ -1,54 +0,0 @@
-/**
- * ANSI Escape sequences for terminal coloring and styling.
- * Used to provide a premium and consistent CLI experience.
- */
-export const colors = {
-  reset: '\x1b[0m',
-  bold: '\x1b[1m',
-  red: '\x1b[31m',
-  green: '\x1b[32m',
-  yellow: '\x1b[33m',
-  blue: '\x1b[34m',
-  cyan: '\x1b[36m',
-  gray: '\x1b[90m',
-}
-
-/**
- * Formats a message with the boltdocs prefix and provided styling.
- *
- * @param message - The content to log
- * @param style - Optional ANSI style prefix
- * @returns The formatted string
- */
-export function formatLog(message: string, style: string = ''): string {
-  return `${style}${colors.bold}[boltdocs]${colors.reset} ${message}${colors.reset}`
-}
-
-/**
- * Logs a standard informational message to the console.
- *
- * @param message - The message to display
- */
-export function info(message: string) {
-  console.log(formatLog(message))
-}
-
-/**
- * Logs an error message to the console with red styling.
- *
- * @param message - The error description
- * @param error - Optional error object for stack tracing
- */
-export function error(message: string, error?: any) {
-  console.error(formatLog(message, colors.red))
-  if (error) console.error(error)
-}
-
-/**
- * Logs a success message to the console with green styling.
- *
- * @param message - The success description
- */
-export function success(message: string) {
-  console.log(formatLog(message, colors.green))
-}

package/src/node/cli-entry.ts

@@ -1,24 +0,0 @@
-#!/usr/bin/env node
-import cac from 'cac'
-import {
-  devAction,
-  buildAction,
-  previewAction,
-  doctorAction,
-} from './cli/index'
-
-const cli = cac('boltdocs')
-
-cli.command('[root]', 'Start development server').alias('dev').action(devAction)
-
-cli.command('build [root]', 'Build for production').action(buildAction)
-
-cli.command('preview [root]', 'Preview production build').action(previewAction)
-
-cli.command('doctor [root]', 'Check documentation health').action(doctorAction)
-
-cli.help()
-// This will be replaced at build time or package publishing, but hardcoded to 2.0.0 for now
-cli.version('2.0.0')
-
-cli.parse()