@mgks/docmd 0.3.11 → 0.4.0

package/src/commands/build.js

@@ -1,237 +0,0 @@
-// Source file from the docmd project — https://github.com/docmd-io/docmd
-
-const path = require('path');
-const fs = require('../core/fs-utils');
-const MiniSearch = require('minisearch');
-const { loadConfig } = require('../core/config-loader');
-const { createMarkdownItInstance, findMarkdownFiles, processMarkdownFile } = require('../core/file-processor');
-const { generateHtmlPage, generateNavigationHtml } = require('../core/html-generator');
-const { clearWarnedIcons } = require('../core/icon-renderer');
-const { findPageNeighbors } = require('../core/navigation-helper');
-const { generateSitemap } = require('../plugins/sitemap');
-const { processAssets } = require('../core/asset-manager');
-
-// Add a global or scoped flag to track if the warning has been shown in the current dev session
-let highlightWarningShown = false;
-
-/**
- * Format paths for display to make them relative to CWD
- */
-function formatPathForDisplay(absolutePath, cwd) {
-  const relativePath = path.relative(cwd, absolutePath);
-  if (!relativePath.startsWith('..') && !path.isAbsolute(relativePath)) {
-    return `./${relativePath}`;
-  }
-  return relativePath;
-}
-
-async function buildSite(configPath, options = { isDev: false, preserve: false, noDoubleProcessing: false }) {
-  clearWarnedIcons(); // Clear warnings at the start of every build
-
-  const config = await loadConfig(configPath);
-  const CWD = process.cwd();
-  const SRC_DIR = path.resolve(CWD, config.srcDir);
-  const OUTPUT_DIR = path.resolve(CWD, config.outputDir);
-  const USER_ASSETS_DIR = path.resolve(CWD, 'assets');
-  const md = createMarkdownItInstance(config);
-  const shouldMinify = !options.isDev && config.minify !== false;
-  const searchIndexData = [];
-  const isOfflineMode = options.offline === true;
-
-  if (!await fs.exists(SRC_DIR)) {
-    throw new Error(`Source directory not found: ${formatPathForDisplay(SRC_DIR, CWD)}`);
-  }
-
-  // Create output directory if it doesn't exist
-  await fs.ensureDir(OUTPUT_DIR);
-
-  // Clean HTML files
-  if (await fs.exists(OUTPUT_DIR)) {
-    const cleanupFiles = await findFilesToCleanup(OUTPUT_DIR);
-    for (const file of cleanupFiles) {
-      await fs.remove(file);
-    }
-    if (!options.isDev) {
-      console.log(`🧹 Cleaned HTML files from output directory: ${formatPathForDisplay(OUTPUT_DIR, CWD)}`);
-    }
-  }
-
-  // --- ASSET PROCESSING ---
-  const assetsDestDir = path.join(OUTPUT_DIR, 'assets');
-  await fs.ensureDir(assetsDestDir);
-
-  // 1. Process Internal Assets First (Base)
-  const assetsSrcDir = path.join(__dirname, '..', 'assets');
-  if (await fs.exists(assetsSrcDir)) {
-    if (!options.isDev) console.log(`📂 Processing docmd assets...`);
-    await processAssets(assetsSrcDir, assetsDestDir, { minify: shouldMinify });
-  } else {
-    console.warn(`⚠️  Assets source directory not found: ${formatPathForDisplay(assetsSrcDir, CWD)}`);
-  }
-
-  // 2. Process User Assets Second (Overrides Internal)
-  if (await fs.exists(USER_ASSETS_DIR)) {
-    if (!options.isDev) console.log(`📂 Processing user assets...`);
-    await processAssets(USER_ASSETS_DIR, assetsDestDir, { minify: shouldMinify });
-
-    // Copy favicon to root if exists
-    const userFavicon = path.join(USER_ASSETS_DIR, 'favicon.ico');
-    if (await fs.exists(userFavicon)) {
-      await fs.copy(userFavicon, path.join(OUTPUT_DIR, 'favicon.ico'));
-    }
-  }
-
-  // Check for Highlight.js themes presence (sanity check)
-  const lightThemePath = path.join(__dirname, '..', 'assets', 'css', 'docmd-highlight-light.css');
-  if (!await fs.exists(lightThemePath)) {
-    if (!options.isDev || (options.isDev && !highlightWarningShown)) {
-      console.warn(`⚠️ Highlight.js themes not found in assets. Syntax highlighting may break.`);
-      if (options.isDev) highlightWarningShown = true;
-    }
-  }
-
-  // 3. Process Markdown Content
-  const processedPages = [];
-  const processedFiles = new Set();
-  const markdownFiles = await findMarkdownFiles(SRC_DIR);
-  if (!options.isDev) console.log(`📄 Found ${markdownFiles.length} markdown files.`);
-
-  for (const filePath of markdownFiles) {
-    try {
-      const relativePath = path.relative(SRC_DIR, filePath);
-
-      // Skip file if already processed in this dev build cycle
-      if (options.noDoubleProcessing && processedFiles.has(relativePath)) continue;
-      processedFiles.add(relativePath);
-
-      const processedData = await processMarkdownFile(filePath, md, config);
-      if (!processedData) continue;
-
-      const { frontmatter: pageFrontmatter, htmlContent, headings, searchData } = processedData;
-      const isIndexFile = path.basename(relativePath) === 'index.md';
-
-      let outputHtmlPath;
-      if (isIndexFile) {
-        outputHtmlPath = path.join(path.dirname(relativePath), 'index.html');
-      } else {
-        outputHtmlPath = relativePath.replace(/\.md$/, '/index.html');
-      }
-
-      const finalOutputHtmlPath = path.join(OUTPUT_DIR, outputHtmlPath);
-      
-      let relativePathToRoot = path.relative(path.dirname(finalOutputHtmlPath), OUTPUT_DIR);
-      relativePathToRoot = relativePathToRoot === '' ? './' : relativePathToRoot.replace(/\\/g, '/') + '/';
-
-      let normalizedPath = path.relative(SRC_DIR, filePath).replace(/\\/g, '/');
-      if (path.basename(normalizedPath) === 'index.md') {
-        normalizedPath = path.dirname(normalizedPath);
-        if (normalizedPath === '.') normalizedPath = '';
-      } else {
-        normalizedPath = normalizedPath.replace(/\.md$/, '');
-      }
-
-      if (!normalizedPath.startsWith('/')) normalizedPath = '/' + normalizedPath;
-      if (normalizedPath.length > 1 && !normalizedPath.endsWith('/')) normalizedPath += '/';
-
-      const navigationHtml = await generateNavigationHtml(
-          config.navigation, normalizedPath, relativePathToRoot, config, isOfflineMode
-      );
-
-      const { prevPage, nextPage } = findPageNeighbors(config.navigation, normalizedPath);
-
-      if (prevPage) prevPage.url = relativePathToRoot + prevPage.path.substring(1);
-      if (nextPage) nextPage.url = relativePathToRoot + nextPage.path.substring(1);
-
-      const pageDataForTemplate = {
-        content: htmlContent,
-        pageTitle: pageFrontmatter.title || 'Untitled',
-        siteTitle: config.siteTitle,
-        navigationHtml, relativePathToRoot, config, frontmatter: pageFrontmatter,
-        outputPath: outputHtmlPath.replace(/\\/g, '/'),
-        prevPage, nextPage, currentPagePath: normalizedPath,
-        headings: headings || [], isOfflineMode,
-      };
-
-      const pageHtml = await generateHtmlPage(pageDataForTemplate, isOfflineMode);
-      await fs.ensureDir(path.dirname(finalOutputHtmlPath));
-      await fs.writeFile(finalOutputHtmlPath, pageHtml);
-
-      const sitemapOutputPath = isIndexFile
-        ? (path.dirname(relativePath) === '.' ? '' : path.dirname(relativePath) + '/')
-        : relativePath.replace(/\.md$/, '/');
-
-      processedPages.push({
-        outputPath: sitemapOutputPath.replace(/\\/g, '/'),
-        frontmatter: pageFrontmatter
-      });
-
-      // Collect Search Data
-      if (searchData) {
-        let pageUrl = outputHtmlPath.replace(/\\/g, '/');
-        if (pageUrl.endsWith('/index.html')) pageUrl = pageUrl.substring(0, pageUrl.length - 10);
-        
-        searchIndexData.push({
-          id: pageUrl, 
-          title: searchData.title, 
-          text: searchData.content, 
-          headings: searchData.headings.join(' ')
-        });
-      }
-
-    } catch (error) {
-      console.error(`❌ Error processing ${path.relative(CWD, filePath)}:`, error);
-    }
-  }
-
-  // 4. Generate Sitemap
-  if (config.plugins?.sitemap !== false) {
-    try {
-      await generateSitemap(config, processedPages, OUTPUT_DIR, { isDev: options.isDev });
-    } catch (error) {
-      console.error(`❌ Error generating sitemap: ${error.message}`);
-    }
-  }
-
-  // 5. Generate Search Index
-  if (config.search !== false) {
-    if (!options.isDev) console.log('🔍 Generating search index...');
-    
-    // MiniSearch build process (server-side)
-    const miniSearch = new MiniSearch({
-      fields: ['title', 'headings', 'text'],
-      storeFields: ['title', 'id', 'text'],
-      searchOptions: { boost: { title: 2, headings: 1.5 }, fuzzy: 0.2 }
-    });
-    
-    miniSearch.addAll(searchIndexData);
-    
-    // Save the index JSON
-    await fs.writeFile(path.join(OUTPUT_DIR, 'search-index.json'), JSON.stringify(miniSearch.toJSON()));
-    
-    if (!options.isDev) console.log(`✅ Search index generated.`);
-  }
-
-  return { config, processedPages, markdownFiles };
-}
-
-// Helper function to find HTML files and sitemap.xml to clean up
-async function findFilesToCleanup(dir) {
-  let filesToRemove = [];
-  const items = await fs.readdir(dir, { withFileTypes: true });
-
-  for (const item of items) {
-    const fullPath = path.join(dir, item.name);
-
-    if (item.isDirectory()) {
-      if (item.name !== 'assets') {
-        const subDirFiles = await findFilesToCleanup(fullPath);
-        filesToRemove = filesToRemove.concat(subDirFiles);
-      }
-    } else if (item.name.endsWith('.html') || item.name === 'sitemap.xml') {
-      filesToRemove.push(fullPath);
-    }
-  }
-  return filesToRemove;
-}
-
-module.exports = { buildSite };

package/src/commands/dev.js

@@ -1,352 +0,0 @@
-// Source file from the docmd project — https://github.com/docmd-io/docmd
-
-const http = require('http');
-const WebSocket = require('ws');
-const chokidar = require('chokidar');
-const path = require('path');
-const fs = require('../core/fs-utils');
-const chalk = require('chalk');
-const os = require('os');
-const readline = require('readline');
-const { buildSite } = require('./build');
-const { loadConfig } = require('../core/config-loader');
-
-// --- 1. Native Static File Server ---
-const MIME_TYPES = {
-  '.html': 'text/html',
-  '.js': 'text/javascript',
-  '.css': 'text/css',
-  '.json': 'application/json',
-  '.png': 'image/png',
-  '.jpg': 'image/jpg',
-  '.jpeg': 'image/jpg',
-  '.gif': 'image/gif',
-  '.svg': 'image/svg+xml',
-  '.ico': 'image/x-icon',
-  '.woff': 'application/font-woff',
-  '.woff2': 'font/woff2',
-  '.ttf': 'application/font-ttf',
-  '.txt': 'text/plain',
-};
-
-async function serveStatic(req, res, rootDir) {
-  // Normalize path and remove query strings
-  let safePath = path.normalize(req.url).replace(/^(\.\.[\/\\])+/, '').split('?')[0].split('#')[0];
-  if (safePath === '/' || safePath === '\\') safePath = 'index.html';
-  
-  let filePath = path.join(rootDir, safePath);
-
-  try {
-    let stats;
-    try {
-      stats = await fs.stat(filePath);
-    } catch (e) {
-      // If direct path fails, try appending .html (clean URLs support)
-      if (path.extname(filePath) === '') {
-        filePath += '.html';
-        stats = await fs.stat(filePath);
-      } else {
-        throw e;
-      }
-    }
-    
-    if (stats.isDirectory()) {
-      filePath = path.join(filePath, 'index.html');
-      await fs.stat(filePath);
-    }
-
-    const ext = path.extname(filePath).toLowerCase();
-    const contentType = MIME_TYPES[ext] || 'application/octet-stream';
-    const content = await fs.readFile(filePath);
-
-    res.writeHead(200, { 'Content-Type': contentType });
-    
-    // Inject Live Reload Script into HTML files only
-    if (contentType === 'text/html') {
-      const htmlStr = content.toString('utf-8');
-      const liveReloadScript = `
-        <script>
-          (function() {
-            let socket;
-            let retryCount = 0;
-            const maxRetries = 50;
-            
-            function connect() {
-              // Avoid connecting if already connected
-              if (socket && (socket.readyState === 0 || socket.readyState === 1)) return;
-
-              socket = new WebSocket('ws://' + window.location.host);
-              
-              socket.onopen = () => {
-                console.log('⚡ docmd connected');
-                retryCount = 0;
-              };
-              
-              socket.onmessage = (e) => { 
-                if(e.data === 'reload') window.location.reload(); 
-              };
-              
-              socket.onclose = () => {
-                // Exponential backoff for reconnection
-                if (retryCount < maxRetries) {
-                    retryCount++;
-                    const delay = Math.min(1000 * (1.5 ** retryCount), 5000);
-                    setTimeout(connect, delay);
-                }
-              };
-              
-              socket.onerror = (err) => {
-                 // Ignore errors, let onclose handle retry
-              };
-            }
-            // Delay initial connection slightly to ensure page load
-            setTimeout(connect, 500);
-          })();
-        </script></body>`;
-      res.end(htmlStr.replace('</body>', liveReloadScript));
-    } else {
-      res.end(content);
-    }
-
-  } catch (err) {
-    if (err.code === 'ENOENT') {
-      res.writeHead(404, { 'Content-Type': 'text/html' });
-      res.end('<h1>404 Not Found</h1><p>docmd dev server</p>');
-    } else {
-      res.writeHead(500);
-      res.end(`Server Error: ${err.code}`);
-    }
-  }
-}
-
-// --- 2. Helper Utilities ---
-
-function formatPathForDisplay(absolutePath, cwd) {
-  const relativePath = path.relative(cwd, absolutePath);
-  if (!relativePath.startsWith('..') && !path.isAbsolute(relativePath)) {
-    return `./${relativePath}`;
-  }
-  return relativePath;
-}
-
-function getNetworkIp() {
-  const interfaces = os.networkInterfaces();
-  for (const name of Object.keys(interfaces)) {
-    for (const iface of interfaces[name]) {
-      if (iface.family === 'IPv4' && !iface.internal) {
-        return iface.address;
-      }
-    }
-  }
-  return null;
-}
-
-// --- 3. Main Dev Function ---
-
-async function startDevServer(configPathOption, options = { preserve: false, port: undefined }) {
-  let config = await loadConfig(configPathOption);
-  const CWD = process.cwd();
-
-  // Config Fallback Logic
-  let actualConfigPath = path.resolve(CWD, configPathOption);
-  if (configPathOption === 'docmd.config.js' && !await fs.pathExists(actualConfigPath)) {
-      const legacyPath = path.resolve(CWD, 'config.js');
-      if (await fs.pathExists(legacyPath)) {
-          actualConfigPath = legacyPath;
-      }
-  }
-
-  const resolveConfigPaths = (currentConfig) => {
-    return {
-      outputDir: path.resolve(CWD, currentConfig.outputDir),
-      srcDirToWatch: path.resolve(CWD, currentConfig.srcDir),
-      configFileToWatch: actualConfigPath,
-      userAssetsDir: path.resolve(CWD, 'assets'),
-    };
-  };
-
-  let paths = resolveConfigPaths(config);
-  const DOCMD_ROOT = path.resolve(__dirname, '..');
-  
-  // --- Create Native Server ---
-  const server = http.createServer((req, res) => {
-    serveStatic(req, res, paths.outputDir);
-  });
-  
-  let wss; // WebSocket instance (initialized later)
-
-  function broadcastReload() {
-    if (wss) {
-      wss.clients.forEach((client) => {
-        if (client.readyState === WebSocket.OPEN) {
-          client.send('reload');
-        }
-      });
-    }
-  }
-
-  // --- Initial Build ---
-  console.log(chalk.blue('🚀 Performing initial build...'));
-  try {
-    await buildSite(configPathOption, { isDev: true, preserve: options.preserve, noDoubleProcessing: true });
-  } catch (error) {
-      console.error(chalk.red('❌ Initial build failed:'), error.message);
-  }
-
-  // --- Watcher Setup ---
-  const userAssetsDirExists = await fs.pathExists(paths.userAssetsDir);
-  const watchedPaths = [paths.srcDirToWatch, paths.configFileToWatch];
-  if (userAssetsDirExists) watchedPaths.push(paths.userAssetsDir);
-  
-  if (process.env.DOCMD_DEV === 'true') {
-    watchedPaths.push(
-      path.join(DOCMD_ROOT, 'templates'),
-      path.join(DOCMD_ROOT, 'assets'),
-      path.join(DOCMD_ROOT, 'core'),
-      path.join(DOCMD_ROOT, 'plugins')
-    );
-  }
-  
-  console.log(chalk.dim('\n👀 Watching for changes in:'));
-  console.log(chalk.dim(`   - Source: ${chalk.cyan(formatPathForDisplay(paths.srcDirToWatch, CWD))}`));
-  console.log(chalk.dim(`   - Config: ${chalk.cyan(formatPathForDisplay(paths.configFileToWatch, CWD))}`));
-  if (userAssetsDirExists) {
-    console.log(chalk.dim(`   - Assets: ${chalk.cyan(formatPathForDisplay(paths.userAssetsDir, CWD))}`));
-  }
-  console.log(''); 
-
-  const watcher = chokidar.watch(watchedPaths, {
-    ignored: /(^|[\/\\])\../,
-    persistent: true,
-    ignoreInitial: true,
-    awaitWriteFinish: { stabilityThreshold: 100, pollInterval: 100 }
-  });
-
-  watcher.on('all', async (event, filePath) => {
-    const relativeFilePath = path.relative(CWD, filePath);
-    process.stdout.write(chalk.dim(`↻ Change in ${relativeFilePath}... `));
-    
-    try {
-      if (filePath === paths.configFileToWatch) {
-        config = await loadConfig(configPathOption);
-        // Note: With native server, we don't need to restart middleware, 
-        // serveStatic reads from disk dynamically on every request.
-        paths = resolveConfigPaths(config);
-      }
-
-      await buildSite(configPathOption, { isDev: true, preserve: options.preserve, noDoubleProcessing: true });
-      broadcastReload();
-      process.stdout.write(chalk.green('Done.\n'));
-      
-    } catch (error) {
-      console.error(chalk.red('\n❌ Rebuild failed:'), error.message);
-    }
-  });
-
-  // --- Server Startup Logic (Port Checking) ---
-  const PORT = parseInt(options.port || process.env.PORT || 3000, 10);
-  const MAX_PORT_ATTEMPTS = 10;
-
-  function checkPortInUse(port) {
-    return new Promise((resolve) => {
-      const tester = http.createServer()
-        .once('error', (err) => {
-          if (err.code === 'EADDRINUSE') resolve(true);
-          else resolve(false);
-        })
-        .once('listening', () => {
-          tester.close(() => resolve(false));
-        })
-        .listen(port, '0.0.0.0');
-    });
-  }
-
-  function askUserConfirmation() {
-    return new Promise((resolve) => {
-      const rl = readline.createInterface({
-        input: process.stdin,
-        output: process.stdout
-      });
-
-      console.log(chalk.yellow(`\n⚠️  Port ${PORT} is already in use.`));
-      console.log(chalk.yellow(`   Another instance of docmd (or another app) might be running.`));
-      
-      rl.question('   Do you want to start another instance on a different port? (Y/n) ', (answer) => {
-        rl.close();
-        const isYes = answer.trim().toLowerCase() === 'y' || answer.trim() === '';
-        resolve(isYes);
-      });
-    });
-  }
-  
-  function tryStartServer(port, attempt = 1) {
-    server.listen(port, '0.0.0.0')
-      .on('listening', async () => {
-        // Initialize WebSocket Server only AFTER successful listen
-        wss = new WebSocket.Server({ server });
-        wss.on('error', (e) => console.error('WebSocket Error:', e.message));
-
-        const indexHtmlPath = path.join(paths.outputDir, 'index.html');
-        const networkIp = getNetworkIp();
-        
-        const localUrl = `http://127.0.0.1:${port}`;
-        const networkUrl = networkIp ? `http://${networkIp}:${port}` : null;
-
-        const border = chalk.gray('────────────────────────────────────────');
-        console.log(border);
-        console.log(`  ${chalk.bold.green('SERVER RUNNING')}  ${chalk.dim(`(v${require('../../package.json').version})`)}`);
-        console.log('');
-        console.log(`  ${chalk.bold('Local:')}    ${chalk.cyan(localUrl)}`);
-        if (networkUrl) {
-            console.log(`  ${chalk.bold('Network:')}  ${chalk.cyan(networkUrl)}`);
-        }
-        console.log('');
-        console.log(`  ${chalk.dim('Serving:')}  ${formatPathForDisplay(paths.outputDir, CWD)}`);
-        console.log(border);
-        console.log('');
-
-        if (!await fs.pathExists(indexHtmlPath)) {
-            console.warn(chalk.yellow(`⚠️  Warning: Root index.html not found.`));
-        }
-      })
-      .on('error', (err) => {
-        if (err.code === 'EADDRINUSE') {
-           server.close(); 
-           tryStartServer(port + 1);
-        } else {
-           console.error(chalk.red(`Failed to start server: ${err.message}`));
-           process.exit(1);
-        }
-      });
-  }
-
-  // --- Main Execution Flow ---
-  (async () => {
-    // Skip check if user manually specified port flag
-    if (options.port) {
-      tryStartServer(PORT);
-      return;
-    }
-
-    const isBusy = await checkPortInUse(PORT);
-    
-    if (isBusy) {
-      const shouldProceed = await askUserConfirmation();
-      if (!shouldProceed) {
-        console.log(chalk.dim('Cancelled.'));
-        process.exit(0);
-      }
-      tryStartServer(PORT + 1);
-    } else {
-      tryStartServer(PORT);
-    }
-  })();
-
-  process.on('SIGINT', () => {
-    console.log(chalk.yellow('\n🛑 Shutting down...'));
-    watcher.close();
-    process.exit(0);
-  });
-}
-
-module.exports = { startDevServer };