@zpress/cli 0.1.4 → 0.2.0

package/dist/index.mjs

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
 import { cli, command } from "@kidd-cli/core";
-import { createPaths, generateAssets, loadConfig, loadManifest, resolveEntries, sync } from "@zpress/core";
+import { configError, createPaths, generateAssets, loadConfig, loadManifest, resolveEntries, sync } from "@zpress/core";
 import { z } from "zod";
+import node_path from "node:path";
 import { execFileSync, spawn } from "node:child_process";
 import { platform } from "node:os";
 import { build, dev, serve } from "@rspress/core";
@@ -9,7 +10,6 @@ import { createRspressConfig } from "@zpress/ui";
 import { match as external_ts_pattern_match } from "ts-pattern";
 import promises from "node:fs/promises";
 import node_fs from "node:fs";
-import node_path from "node:path";
 const DEFAULT_PORT = 6174;
 async function startDevServer(options) {
     const rspressConfig = createRspressConfig(options);
@@ -33,6 +33,14 @@ async function buildSite(options) {
         configFilePath: ''
     });
 }
+async function buildSiteForCheck(options) {
+    const rspressConfig = createRspressConfig(options);
+    await build({
+        docDirectory: options.paths.contentDir,
+        config: rspressConfig,
+        configFilePath: ''
+    });
+}
 async function serveSite(options) {
     const rspressConfig = createRspressConfig(options);
     await serve({
@@ -66,6 +74,170 @@ function openBrowser(url) {
         detached: true
     }).unref();
 }
+const ANSI_PATTERN = /\u001B\[[0-9;]*m/g;
+function stripAnsi(text) {
+    return text.replace(ANSI_PATTERN, '');
+}
+function runConfigCheck(params) {
+    const { config, loadError } = params;
+    if (loadError) return {
+        passed: false,
+        errors: [
+            loadError
+        ]
+    };
+    if (!config) return {
+        passed: false,
+        errors: [
+            configError('empty_sections', 'Config is missing')
+        ]
+    };
+    return {
+        passed: true,
+        errors: []
+    };
+}
+function chunkToString(chunk) {
+    if ('string' == typeof chunk) return chunk;
+    return Buffer.from(chunk).toString('utf8');
+}
+function toError(value) {
+    if (value instanceof Error) return value;
+    return new Error(String(value));
+}
+function createInterceptor(chunks) {
+    return function(chunk, encodingOrCb, maybeCb) {
+        const text = chunkToString(chunk);
+        chunks.push(text);
+        if ('function' == typeof encodingOrCb) encodingOrCb();
+        else if ('function' == typeof maybeCb) maybeCb();
+        return true;
+    };
+}
+async function captureOutput(fn) {
+    const chunks = [];
+    const originalStdoutWrite = process.stdout.write;
+    const originalStderrWrite = process.stderr.write;
+    process.stdout.write = createInterceptor(chunks);
+    process.stderr.write = createInterceptor(chunks);
+    try {
+        const result = await fn();
+        return {
+            result,
+            error: null,
+            captured: chunks.join('')
+        };
+    } catch (error) {
+        return {
+            result: null,
+            error: toError(error),
+            captured: chunks.join('')
+        };
+    } finally{
+        process.stdout.write = originalStdoutWrite;
+        process.stderr.write = originalStderrWrite;
+    }
+}
+function flushGroup(results, file, links) {
+    if (file && links.length > 0) return [
+        ...results,
+        {
+            file,
+            links
+        }
+    ];
+    return results;
+}
+function parseDeadlinks(stderr) {
+    const clean = stripAnsi(stderr);
+    const lines = clean.split('\n');
+    const headerPattern = /Dead links found in (.+?):\s*$/;
+    const linkPattern = /"\[\.\.]\(([^)]+)\)"/;
+    const acc = lines.reduce((state, line)=>{
+        const headerMatch = headerPattern.exec(line);
+        if (headerMatch) {
+            const file = headerMatch[1] ?? '';
+            return {
+                results: flushGroup(state.results, state.currentFile, state.currentLinks),
+                currentFile: file,
+                currentLinks: []
+            };
+        }
+        const linkMatch = linkPattern.exec(line);
+        if (linkMatch && state.currentFile) {
+            const link = linkMatch[1] ?? '';
+            return {
+                ...state,
+                currentLinks: [
+                    ...state.currentLinks,
+                    link
+                ]
+            };
+        }
+        return state;
+    }, {
+        results: [],
+        currentFile: null,
+        currentLinks: []
+    });
+    return flushGroup(acc.results, acc.currentFile, acc.currentLinks);
+}
+async function runBuildCheck(params) {
+    const { error, captured } = await captureOutput(()=>buildSiteForCheck({
+            config: params.config,
+            paths: params.paths
+        }));
+    if (error) {
+        const { repoRoot } = params.paths;
+        const deadlinks = parseDeadlinks(captured).map((info)=>({
+                file: node_path.relative(repoRoot, info.file),
+                links: info.links
+            }));
+        if (deadlinks.length > 0) return {
+            status: 'failed',
+            deadlinks
+        };
+        return {
+            status: 'error',
+            message: error.message
+        };
+    }
+    return {
+        status: 'passed'
+    };
+}
+const RED = '\u001B[31m';
+const DIM = '\u001B[2m';
+const RESET = '\u001B[0m';
+function formatDeadlinkGroup(info) {
+    const header = `  ${RED}✖${RESET} ${info.file}`;
+    const links = info.links.map((link)=>`      ${DIM}→${RESET} ${link}`);
+    return [
+        header,
+        ...links
+    ].join('\n');
+}
+function presentResults(params) {
+    const { configResult, buildResult, logger } = params;
+    if (configResult.passed) logger.success('Config valid');
+    else {
+        logger.error('Config validation failed:');
+        configResult.errors.map((err)=>{
+            logger.message(`  ${err.message}`);
+            return null;
+        });
+    }
+    if ('passed' === buildResult.status) logger.success('No broken links');
+    else if ('skipped' === buildResult.status) ;
+    else if ('error' === buildResult.status) logger.error(`Build failed: ${buildResult.message}`);
+    else {
+        const totalLinks = buildResult.deadlinks.reduce((sum, info)=>sum + info.links.length, 0);
+        logger.error(`Found ${totalLinks} broken link(s):`);
+        const block = buildResult.deadlinks.map(formatDeadlinkGroup).join('\n');
+        logger.message(block);
+    }
+    return configResult.passed && 'passed' === buildResult.status;
+}
 function cleanTargets(paths) {
     return [
         {
@@ -82,7 +254,7 @@ function cleanTargets(paths) {
         }
     ];
 }
-async function clean(paths) {
+async function clean_clean(paths) {
     const results = await Promise.all(cleanTargets(paths).map(async ({ dir, label })=>{
         const exists = await promises.stat(dir).catch(()=>null);
         if (exists) {
@@ -101,7 +273,7 @@ const cleanCommand = command({
     handler: async (ctx)=>{
         const paths = createPaths(process.cwd());
         ctx.logger.intro('zpress clean');
-        const removed = await clean(paths);
+        const removed = await clean_clean(paths);
         if (removed.length > 0) ctx.logger.success(`Removed: ${removed.join(', ')}`);
         else ctx.logger.info('Nothing to clean');
         ctx.logger.outro('Done');
@@ -111,14 +283,15 @@ const buildCommand = command({
     description: 'Run sync and build the Rspress site',
     args: z.object({
         quiet: z.boolean().optional().default(false),
-        clean: z.boolean().optional().default(false)
+        clean: z.boolean().optional().default(false),
+        check: z.boolean().optional().default(true)
     }),
     handler: async (ctx)=>{
-        const { quiet } = ctx.args;
+        const { quiet, check } = ctx.args;
         const paths = createPaths(process.cwd());
         ctx.logger.intro('zpress build');
         if (ctx.args.clean) {
-            const removed = await clean(paths);
+            const removed = await clean_clean(paths);
             if (removed.length > 0 && !quiet) ctx.logger.info(`Cleaned: ${removed.join(', ')}`);
         }
         const [configErr, config] = await loadConfig(paths.repoRoot);
@@ -126,15 +299,89 @@ const buildCommand = command({
             ctx.logger.error(configErr.message);
             process.exit(1);
         }
-        await sync(config, {
+        if (check) {
+            ctx.logger.step('Validating config...');
+            const configResult = runConfigCheck({
+                config,
+                loadError: configErr
+            });
+            ctx.logger.step('Syncing content...');
+            await sync(config, {
+                paths,
+                quiet: true
+            });
+            ctx.logger.step('Building & checking for broken links...');
+            const buildResult = await runBuildCheck({
+                config,
+                paths
+            });
+            const passed = presentResults({
+                configResult,
+                buildResult,
+                logger: ctx.logger
+            });
+            if (!passed) {
+                ctx.logger.outro('Build failed');
+                process.exit(1);
+            }
+            ctx.logger.outro('Done');
+        } else {
+            await sync(config, {
+                paths,
+                quiet
+            });
+            await buildSite({
+                config,
+                paths
+            });
+            ctx.logger.outro('Done');
+        }
+    }
+});
+const checkCommand = command({
+    description: 'Validate config and check for broken links',
+    handler: async (ctx)=>{
+        const paths = createPaths(process.cwd());
+        ctx.logger.intro('zpress check');
+        ctx.logger.step('Validating config...');
+        const [configErr, config] = await loadConfig(paths.repoRoot);
+        const configResult = runConfigCheck({
+            config,
+            loadError: configErr
+        });
+        if (configErr || !config) {
+            const buildResult = {
+                status: 'skipped'
+            };
+            presentResults({
+                configResult,
+                buildResult,
+                logger: ctx.logger
+            });
+            ctx.logger.outro('Checks failed');
+            process.exit(1);
+        }
+        ctx.logger.step('Syncing content...');
+        const syncResult = await sync(config, {
             paths,
-            quiet
+            quiet: true
         });
-        await buildSite({
+        ctx.logger.success(`Synced (${syncResult.pagesWritten} written, ${syncResult.pagesSkipped} unchanged)`);
+        ctx.logger.step('Checking for broken links...');
+        const buildResult = await runBuildCheck({
             config,
             paths
         });
-        ctx.logger.outro('Done');
+        const passed = presentResults({
+            configResult,
+            buildResult,
+            logger: ctx.logger
+        });
+        if (passed) ctx.logger.outro('All checks passed');
+        else {
+            ctx.logger.outro('Checks failed');
+            process.exit(1);
+        }
     }
 });
 const devCommand = command({
@@ -148,7 +395,7 @@ const devCommand = command({
         const paths = createPaths(process.cwd());
         ctx.logger.intro('zpress dev');
         if (ctx.args.clean) {
-            const removed = await clean(paths);
+            const removed = await clean_clean(paths);
             if (removed.length > 0 && !quiet) ctx.logger.info(`Cleaned: ${removed.join(', ')}`);
         }
         const [configErr, config] = await loadConfig(paths.repoRoot);
@@ -408,12 +655,13 @@ const syncCommand = command({
 });
 await cli({
     name: 'zpress',
-    version: "0.1.4",
+    version: "0.2.0",
     description: 'CLI for building and serving documentation',
     commands: {
         sync: syncCommand,
         dev: devCommand,
         build: buildCommand,
+        check: checkCommand,
         serve: serveCommand,
         clean: cleanCommand,
         dump: dumpCommand,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zpress/cli",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "CLI for building and serving zpress documentation sites",
   "keywords": [
     "cli",
@@ -40,8 +40,8 @@
     "es-toolkit": "^1.45.1",
     "ts-pattern": "^5.9.0",
     "zod": "^4.3.6",
-    "@zpress/ui": "0.3.0",
-    "@zpress/core": "0.3.0"
+    "@zpress/core": "0.4.0",
+    "@zpress/ui": "0.3.1"
   },
   "devDependencies": {
     "@rslib/core": "^0.20.0",