@mgks/docmd 0.2.6 → 0.2.8

package/src/assets/js/docmd-main.js

@@ -36,6 +36,22 @@ function initializeCollapsibleNav() {
     toggleSubmenu(isExpanded);
 
     anchor.addEventListener('click', (e) => {
+      const currentExpanded = item.getAttribute('aria-expanded') === 'true';
+      const href = anchor.getAttribute('href');
+      const isPlaceholder = !href || href === '#' || href === '';
+
+      if (!currentExpanded) {
+        toggleSubmenu(true);
+      } else if (isPlaceholder || e.target.closest('.collapse-icon')) {
+        toggleSubmenu(false);
+      }
+
+      if (isPlaceholder || e.target.closest('.collapse-icon')) {
+        e.preventDefault();
+      }
+    });
+
+/*    anchor.addEventListener('click', (e) => {
       // If the click target is the icon, ALWAYS prevent navigation and toggle.
       if (e.target.closest('.collapse-icon')) {
         e.preventDefault();
@@ -47,7 +63,7 @@ function initializeCollapsibleNav() {
         toggleSubmenu(item.getAttribute('aria-expanded') !== 'true');
       }
       // Otherwise, let the click proceed to navigate to the link.
-    });
+    });*/
   });
 }
 

package/src/core/config-loader.js

@@ -2,19 +2,22 @@
 
 const path = require('path');
 const fs = require('fs-extra');
+const { validateConfig } = require('./config-validator');
 
 async function loadConfig(configPath) {
   const absoluteConfigPath = path.resolve(process.cwd(), configPath);
   if (!await fs.pathExists(absoluteConfigPath)) {
-    throw new Error(`Configuration file not found: ${absoluteConfigPath}`);
+    throw new Error(`Configuration file not found at: ${absoluteConfigPath}\nRun "docmd init" to create one.`);
   }
   try {
     // Clear require cache to always get the freshest config
     delete require.cache[require.resolve(absoluteConfigPath)];
     const config = require(absoluteConfigPath);
 
+    // Validate configuration call
+    validateConfig(config);
+
     // Basic validation and defaults
-    if (!config.siteTitle) throw new Error('`siteTitle` is missing in config file');
     config.srcDir = config.srcDir || 'docs';
     config.outputDir = config.outputDir || 'site';
     config.theme = config.theme || {};
@@ -24,7 +27,10 @@ async function loadConfig(configPath) {
 
     return config;
   } catch (e) {
-    throw new Error(`Error loading or parsing config file ${absoluteConfigPath}: ${e.message}`);
+    if (e.message === 'Invalid configuration file.') {
+      throw e;
+    }
+    throw new Error(`Error parsing config file: ${e.message}`);
   }
 }
 

package/src/core/config-validator.js

@@ -0,0 +1,79 @@
+// Source file from the docmd project — https://github.com/mgks/docmd
+
+const chalk = require('chalk');
+
+// Known configuration keys for typo detection
+const KNOWN_KEYS = [
+  'siteTitle', 'siteUrl', 'srcDir', 'outputDir', 'logo', 
+  'sidebar', 'theme', 'customJs', 'autoTitleFromH1', 
+  'copyCode', 'plugins', 'navigation', 'footer', 'sponsor', 'favicon'
+];
+
+// Common typos mapping
+const TYPO_MAPPING = {
+  'site_title': 'siteTitle',
+  'sitetitle': 'siteTitle',
+  'baseUrl': 'siteUrl',
+  'source': 'srcDir',
+  'out': 'outputDir',
+  'customCSS': 'theme.customCss',
+  'customcss': 'theme.customCss',
+  'customJS': 'customJs',
+  'customjs': 'customJs',
+  'nav': 'navigation',
+  'menu': 'navigation'
+};
+
+function validateConfig(config) {
+  const errors = [];
+  const warnings = [];
+
+  // 1. Required Fields
+  if (!config.siteTitle) {
+    errors.push('Missing required property: "siteTitle"');
+  }
+
+  // 2. Type Checking
+  if (config.navigation && !Array.isArray(config.navigation)) {
+    errors.push('"navigation" must be an Array');
+  }
+
+  if (config.customJs && !Array.isArray(config.customJs)) {
+    errors.push('"customJs" must be an Array of strings');
+  }
+
+  if (config.theme) {
+    if (config.theme.customCss && !Array.isArray(config.theme.customCss)) {
+      errors.push('"theme.customCss" must be an Array of strings');
+    }
+  }
+
+  // 3. Typos and Unknown Keys (Top Level)
+  Object.keys(config).forEach(key => {
+    if (TYPO_MAPPING[key]) {
+      warnings.push(`Found unknown property "${key}". Did you mean "${TYPO_MAPPING[key]}"?`);
+    }
+  });
+
+  // 4. Theme specific typos
+  if (config.theme) {
+    if (config.theme.customCSS) {
+      warnings.push('Found "theme.customCSS". Did you mean "theme.customCss"?');
+    }
+  }
+
+  // Output results
+  if (warnings.length > 0) {
+    console.log(chalk.yellow('\n⚠️  Configuration Warnings:'));
+    warnings.forEach(w => console.log(chalk.yellow(`   - ${w}`)));
+  }
+
+  if (errors.length > 0) {
+    console.log(chalk.red('\n❌ Configuration Errors:'));
+    errors.forEach(e => console.log(chalk.red(`   - ${e}`)));
+    console.log('');
+    throw new Error('Invalid configuration file.');
+  }
+}
+
+module.exports = { validateConfig };