@knowcode/doc-builder 1.9.6 → 1.9.7

package/doc-builder.config.js

@@ -1,4 +1,5 @@
 module.exports = {
+  "configVersion": "1.9.6",
   "siteName": "@knowcode/doc-builder",
   "siteDescription": "Beautiful documentation with the least effort possible",
   "docsDir": "docs",

package/lib/config.js

@@ -1,12 +1,16 @@
 const fs = require('fs-extra');
 const path = require('path');
 const chalk = require('chalk');
+const semver = require('semver');
 const sharedAuth = require('./shared-auth-config');
 
 /**
  * Default configuration
  */
 const defaultConfig = {
+  // Configuration version - updated when new config options are added
+  configVersion: require('../package.json').version,
+  
   // Source and output directories
   docsDir: 'docs',
   outputDir: 'html',
@@ -214,6 +218,112 @@ const notionInspiredPreset = {
   }
 };
 
+/**
+ * Check if config migration is needed
+ * @param {object} userConfig - Current user configuration
+ * @param {string} packageVersion - Current package version
+ * @returns {boolean} - Whether migration is needed
+ */
+function needsMigration(userConfig, packageVersion) {
+  // If no configVersion in user config, it needs migration
+  if (!userConfig.configVersion) {
+    return true;
+  }
+  
+  try {
+    // Use semver to compare versions
+    return semver.lt(userConfig.configVersion, packageVersion);
+  } catch (error) {
+    console.warn(chalk.yellow(`Warning: Invalid version format in config: ${userConfig.configVersion}`));
+    return true; // Migrate on version parse errors
+  }
+}
+
+/**
+ * Deep merge objects, preserving user customizations
+ * @param {object} target - Target object (defaults)
+ * @param {object} source - Source object (user config)
+ * @returns {object} - Merged object
+ */
+function deepMerge(target, source) {
+  const result = { ...target };
+  
+  for (const key in source) {
+    if (source.hasOwnProperty(key)) {
+      if (source[key] && typeof source[key] === 'object' && !Array.isArray(source[key])) {
+        // Recursively merge objects
+        result[key] = deepMerge(target[key] || {}, source[key]);
+      } else {
+        // Use source value (user customization takes precedence)
+        result[key] = source[key];
+      }
+    }
+  }
+  
+  return result;
+}
+
+/**
+ * Migrate user configuration to current version
+ * @param {object} userConfig - Current user configuration
+ * @param {string} targetVersion - Target package version
+ * @returns {object} - Migrated configuration
+ */
+function migrateConfig(userConfig, targetVersion) {
+  console.log(chalk.blue(`🔄 Migrating config from ${userConfig.configVersion || 'unknown'} to ${targetVersion}`));
+  
+  // Start with current defaults
+  let migratedConfig = { ...defaultConfig };
+  
+  // Deep merge user customizations
+  migratedConfig = deepMerge(migratedConfig, userConfig);
+  
+  // Update the config version
+  migratedConfig.configVersion = targetVersion;
+  
+  // Log new features added
+  const newFeatures = [];
+  if (!userConfig.features?.dynamicNavIcons) {
+    newFeatures.push('Dynamic navigation icons');
+  }
+  if (!userConfig.features?.subtleColors) {
+    newFeatures.push('Subtle status colors');
+  }
+  if (!userConfig.features?.phosphorWeight) {
+    newFeatures.push('Phosphor icon weight options');
+  }
+  if (!userConfig.features?.phosphorSize) {
+    newFeatures.push('Phosphor icon sizing');
+  }
+  
+  if (newFeatures.length > 0) {
+    console.log(chalk.green(`✨ Added new features: ${newFeatures.join(', ')}`));
+  }
+  
+  return migratedConfig;
+}
+
+/**
+ * Save configuration to file
+ * @param {string} configPath - Path to config file
+ * @param {object} config - Configuration object to save
+ */
+async function saveConfig(configPath, config) {
+  // Create backup of existing config
+  if (fs.existsSync(configPath)) {
+    const backupPath = `${configPath}.backup.${Date.now()}`;
+    await fs.copy(configPath, backupPath);
+    console.log(chalk.gray(`💾 Backed up existing config to ${path.basename(backupPath)}`));
+  }
+  
+  // Format config as module.exports
+  const configContent = `module.exports = ${JSON.stringify(config, null, 2)};
+`;
+  
+  await fs.writeFile(configPath, configContent);
+  console.log(chalk.green(`✅ Updated config file: ${path.basename(configPath)}`));
+}
+
 /**
  * Load configuration
  */
@@ -230,7 +340,15 @@ async function loadConfig(configPath, options = {}) {
   if (fs.existsSync(customConfigPath)) {
     try {
       const customConfig = require(customConfigPath);
-      config = { ...config, ...customConfig };
+      const packageJson = require('../package.json');
+      
+      // Check if migration is needed
+      if (needsMigration(customConfig, packageJson.version)) {
+        config = migrateConfig(customConfig, packageJson.version);
+        await saveConfig(customConfigPath, config);
+      } else {
+        config = { ...config, ...customConfig };
+      }
       
       // Handle alternative config formats
       if (customConfig.site) {
@@ -358,5 +476,8 @@ module.exports = {
   defaultConfig,
   notionInspiredPreset,
   loadConfig,
-  createDefaultConfig
+  createDefaultConfig,
+  needsMigration,
+  migrateConfig,
+  saveConfig
 };

package/lib/emoji-mapper.js

@@ -81,6 +81,7 @@ const emojiToPhosphor = {
   '🧭': '<i class="ph ph-compass" aria-label="navigation"></i>',
   '🗺️': '<i class="ph ph-map-trifold" aria-label="map"></i>',
   '🌐': '<i class="ph ph-globe" aria-label="global"></i>',
+  '🌍': '<i class="ph ph-globe-hemisphere-west" aria-label="world"></i>',
   
   // Communication
   '📧': '<i class="ph ph-envelope" aria-label="email"></i>',
@@ -250,6 +251,20 @@ const emojiToPhosphor = {
   '📑': '<i class="ph ph-file-text" aria-label="document"></i>',
   '💀': '<i class="ph ph-skull" aria-label="skull"></i>',
   '🔤': '<i class="ph ph-textbox" aria-label="letters"></i>',
+  '🧱': '<i class="ph ph-wall" aria-label="brick"></i>',
+  '🖼️': '<i class="ph ph-image" aria-label="picture"></i>',
+  '🎂': '<i class="ph ph-cake" aria-label="birthday"></i>',
+  '↩️': '<i class="ph ph-arrow-u-left" aria-label="return"></i>',
+  '📜': '<i class="ph ph-scroll" aria-label="scroll"></i>',
+  '🕰️': '<i class="ph ph-clock" aria-label="clock"></i>',
+  '🧮': '<i class="ph ph-calculator" aria-label="calculator"></i>',
+  '🎫': '<i class="ph ph-ticket" aria-label="ticket"></i>',
+  '🌿': '<i class="ph ph-leaf" aria-label="leaf"></i>',
+  '🥊': '<i class="ph ph-boxing-glove" aria-label="boxing"></i>',
+  '🎛️': '<i class="ph ph-faders" aria-label="controls"></i>',
+  '🗣️': '<i class="ph ph-megaphone-simple" aria-label="speaking"></i>',
+  '💝': '<i class="ph ph-gift" aria-label="gift with bow"></i>',
+  '🐌': '<i class="ph ph-spiral" aria-label="snail"></i>',
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowcode/doc-builder",
-  "version": "1.9.6",
+  "version": "1.9.7",
   "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
   "main": "index.js",
   "bin": {
@@ -37,7 +37,8 @@
     "gray-matter": "^4.0.3",
     "marked": "^15.0.12",
     "ora": "5.4.1",
-    "prompts": "^2.4.2"
+    "prompts": "^2.4.2",
+    "semver": "^7.7.2"
   },
   "engines": {
     "node": ">=14.0.0"