npm - uniweb - Versions diffs - 0.2.12 → 0.2.14 - Mend

uniweb 0.2.12 → 0.2.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "uniweb",
-  "version": "0.2.12",
+  "version": "0.2.14",
   "description": "Create structured Vite + React sites with content/code separation",
   "type": "module",
   "bin": {
@@ -32,8 +32,9 @@
   },
   "dependencies": {
     "handlebars": "^4.7.8",
+    "js-yaml": "^4.1.0",
     "prompts": "^2.4.2",
     "tar": "^7.0.0",
-    "@uniweb/build": "0.1.4"
+    "@uniweb/build": "0.1.6"
   }
 }

package/src/commands/build.js CHANGED Viewed

@@ -178,6 +178,112 @@ async function buildFoundation(projectDir, options = {}) {
   }
 }
+/**
+ * Load site i18n configuration
+ *
+ * Resolves locales from config:
+ * - undefined → all available locales (from locales/*.json)
+ * - '*' → explicitly all available locales
+ * - ['es', 'fr'] → only those specific locales
+ */
+async function loadI18nConfig(projectDir) {
+  const siteYmlPath = join(projectDir, 'site.yml')
+  if (!existsSync(siteYmlPath)) return null
+  const { readFile } = await import('node:fs/promises')
+  const yaml = await import('js-yaml')
+  const content = await readFile(siteYmlPath, 'utf-8')
+  const config = yaml.load(content) || {}
+  const localesDir = config.i18n?.localesDir || 'locales'
+  const localesPath = join(projectDir, localesDir)
+  // Resolve locales (undefined/'*' → all available, array → specific)
+  const { resolveLocales } = await import('@uniweb/build/i18n')
+  const locales = await resolveLocales(config.i18n?.locales, localesPath)
+  if (locales.length === 0) return null
+  return {
+    defaultLocale: config.defaultLanguage || 'en',
+    locales,
+    localesDir,
+  }
+}
+/**
+ * Build localized content for all configured locales
+ */
+async function buildLocalizedContent(projectDir, i18nConfig) {
+  const { buildLocalizedContent } = await import('@uniweb/build/i18n')
+  const outputs = await buildLocalizedContent(projectDir, {
+    localesDir: i18nConfig.localesDir,
+    locales: i18nConfig.locales,
+    outputDir: join(projectDir, 'dist'),
+    fallbackToSource: true,
+  })
+  return outputs
+}
+/**
+ * Generate index.html for each locale with hreflang tags
+ */
+async function generateLocalizedHtml(projectDir, i18nConfig) {
+  const { readFile, writeFile, mkdir, copyFile } = await import('node:fs/promises')
+  const distDir = join(projectDir, 'dist')
+  const baseHtmlPath = join(distDir, 'index.html')
+  if (!existsSync(baseHtmlPath)) {
+    return
+  }
+  let baseHtml = await readFile(baseHtmlPath, 'utf-8')
+  // Build hreflang tags
+  const hreflangTags = i18nConfig.locales.map(locale =>
+    `<link rel="alternate" hreflang="${locale}" href="/${locale}/" />`
+  ).join('\n    ')
+  const defaultHreflang = `<link rel="alternate" hreflang="x-default" href="/" />`
+  const allHreflangTags = `${hreflangTags}\n    ${defaultHreflang}`
+  // Add hreflang to base HTML (for default locale)
+  if (!baseHtml.includes('hreflang')) {
+    baseHtml = baseHtml.replace('</head>', `    ${allHreflangTags}\n  </head>`)
+    await writeFile(baseHtmlPath, baseHtml)
+  }
+  // Generate index.html for each locale
+  for (const locale of i18nConfig.locales) {
+    const localeDir = join(distDir, locale)
+    await mkdir(localeDir, { recursive: true })
+    // Read locale-specific site-content.json
+    const localeContentPath = join(localeDir, 'site-content.json')
+    let localeHtml = baseHtml
+    // Update html lang attribute
+    localeHtml = localeHtml.replace(/<html[^>]*lang="[^"]*"/, `<html lang="${locale}"`)
+    if (!localeHtml.includes('lang=')) {
+      localeHtml = localeHtml.replace('<html', `<html lang="${locale}"`)
+    }
+    // Update script src for locale-specific content if inlined
+    if (existsSync(localeContentPath)) {
+      const localeContent = await readFile(localeContentPath, 'utf-8')
+      // Replace the inlined content if present
+      localeHtml = localeHtml.replace(
+        /<script id="__SITE_CONTENT__"[^>]*>[\s\S]*?<\/script>/,
+        `<script id="__SITE_CONTENT__" type="application/json">${localeContent}</script>`
+      )
+    }
+    await writeFile(join(localeDir, 'index.html'), localeHtml)
+  }
+}
 /**
  * Build a site
  */
@@ -191,6 +297,35 @@ async function buildSite(projectDir, options = {}) {
   success('Site build complete')
+  // Check for i18n configuration
+  const i18nConfig = await loadI18nConfig(projectDir)
+  if (i18nConfig && i18nConfig.locales.length > 0) {
+    log('')
+    info(`Building localized content for: ${i18nConfig.locales.join(', ')}`)
+    try {
+      // Generate locale-specific site-content.json
+      const outputs = await buildLocalizedContent(projectDir, i18nConfig)
+      // Generate locale-specific index.html files
+      await generateLocalizedHtml(projectDir, i18nConfig)
+      success(`Generated ${Object.keys(outputs).length} locale(s)`)
+      for (const [locale, path] of Object.entries(outputs)) {
+        log(`  ${colors.dim}dist/${locale}/site-content.json${colors.reset}`)
+      }
+    } catch (err) {
+      error(`i18n build failed: ${err.message}`)
+      if (process.env.DEBUG) {
+        console.error(err.stack)
+      }
+      // Don't fail the build, just warn
+      log(`${colors.yellow}Continuing without localized content${colors.reset}`)
+    }
+  }
   // Pre-render if requested
   if (prerender) {
     log('')

package/src/commands/docs.js ADDED Viewed

@@ -0,0 +1,143 @@
+/**
+ * Docs Command
+ *
+ * Generates markdown documentation from foundation schema.
+ *
+ * Usage:
+ *   uniweb docs                    # Generate docs for current directory
+ *   uniweb docs --output README.md # Custom output filename
+ *   uniweb docs --from-source      # Build schema from source (no build required)
+ */
+import { existsSync } from 'node:fs'
+import { resolve, join } from 'node:path'
+import { generateDocs } from '@uniweb/build'
+// Colors for terminal output
+const colors = {
+  reset: '\x1b[0m',
+  bright: '\x1b[1m',
+  dim: '\x1b[2m',
+  cyan: '\x1b[36m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m',
+  red: '\x1b[31m',
+}
+function log(message) {
+  console.log(message)
+}
+function success(message) {
+  console.log(`${colors.green}✓${colors.reset} ${message}`)
+}
+function error(message) {
+  console.error(`${colors.red}✗${colors.reset} ${message}`)
+}
+function info(message) {
+  console.log(`${colors.cyan}→${colors.reset} ${message}`)
+}
+/**
+ * Parse command line arguments
+ */
+function parseArgs(args) {
+  const options = {
+    output: 'COMPONENTS.md',
+    fromSource: false,
+  }
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i]
+    if (arg === '--output' || arg === '-o') {
+      options.output = args[++i]
+    } else if (arg === '--from-source' || arg === '-s') {
+      options.fromSource = true
+    } else if (arg === '--help' || arg === '-h') {
+      options.help = true
+    }
+  }
+  return options
+}
+/**
+ * Show help message
+ */
+function showHelp() {
+  log(`
+${colors.bright}uniweb docs${colors.reset} - Generate component documentation
+${colors.dim}Usage:${colors.reset}
+  uniweb docs                         Generate COMPONENTS.md from schema.json
+  uniweb docs --output DOCS.md        Custom output filename
+  uniweb docs --from-source           Build schema from source (no build required)
+${colors.dim}Options:${colors.reset}
+  -o, --output <file>    Output filename (default: COMPONENTS.md)
+  -s, --from-source      Read meta.js files directly instead of schema.json
+  -h, --help             Show this help message
+${colors.dim}Notes:${colors.reset}
+  By default, docs are generated from dist/schema.json (requires build).
+  Use --from-source to generate without building first.
+`)
+}
+/**
+ * Detect if current directory is a foundation
+ */
+function isFoundation(dir) {
+  const srcDir = join(dir, 'src')
+  const componentsDir = join(srcDir, 'components')
+  return existsSync(componentsDir)
+}
+/**
+ * Main docs command
+ */
+export async function docs(args) {
+  const options = parseArgs(args)
+  if (options.help) {
+    showHelp()
+    return
+  }
+  const projectDir = resolve(process.cwd())
+  // Verify this is a foundation
+  if (!isFoundation(projectDir)) {
+    error('This directory does not appear to be a foundation.')
+    log(`${colors.dim}Foundations have a src/components/ directory with component folders.${colors.reset}`)
+    process.exit(1)
+  }
+  // Check if schema.json exists (if not using --from-source)
+  const schemaPath = join(projectDir, 'dist', 'schema.json')
+  if (!options.fromSource && !existsSync(schemaPath)) {
+    log(`${colors.yellow}⚠${colors.reset} No dist/schema.json found.`)
+    log(`${colors.dim}Run 'uniweb build' first, or use '--from-source' to read meta.js files directly.${colors.reset}`)
+    log('')
+    info('Falling back to --from-source mode')
+    options.fromSource = true
+  }
+  try {
+    info('Generating documentation...')
+    const result = await generateDocs(projectDir, {
+      output: options.output,
+      fromSource: options.fromSource,
+    })
+    success(`Generated ${result.outputPath}`)
+    log(`${colors.dim}Documented ${result.componentCount} components${colors.reset}`)
+  } catch (err) {
+    error(`Failed to generate docs: ${err.message}`)
+    process.exit(1)
+  }
+}

package/src/commands/i18n.js ADDED Viewed

@@ -0,0 +1,325 @@
+/**
+ * i18n CLI Commands
+ *
+ * Commands for managing site content internationalization.
+ *
+ * Usage:
+ *   uniweb i18n extract      Extract translatable strings to manifest
+ *   uniweb i18n sync         Sync manifest with content changes
+ *   uniweb i18n status       Show translation coverage per locale
+ */
+import { resolve, join } from 'path'
+import { existsSync } from 'fs'
+import { readFile } from 'fs/promises'
+import yaml from 'js-yaml'
+// Colors for terminal output
+const colors = {
+  reset: '\x1b[0m',
+  bright: '\x1b[1m',
+  dim: '\x1b[2m',
+  cyan: '\x1b[36m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m',
+  red: '\x1b[31m',
+}
+function log(message) {
+  console.log(message)
+}
+function success(message) {
+  console.log(`${colors.green}✓${colors.reset} ${message}`)
+}
+function warn(message) {
+  console.log(`${colors.yellow}⚠${colors.reset} ${message}`)
+}
+function error(message) {
+  console.error(`${colors.red}✗${colors.reset} ${message}`)
+}
+/**
+ * Main i18n command handler
+ * @param {string[]} args - Command arguments
+ */
+export async function i18n(args) {
+  const subcommand = args[0]
+  if (!subcommand || subcommand === '--help' || subcommand === '-h') {
+    showHelp()
+    return
+  }
+  // Find site root
+  const siteRoot = await findSiteRoot()
+  if (!siteRoot) {
+    error('Could not find site root. Make sure you are in a Uniweb site directory.')
+    process.exit(1)
+  }
+  // Load site config for locale settings
+  const config = await loadSiteConfig(siteRoot)
+  switch (subcommand) {
+    case 'extract':
+      await runExtract(siteRoot, config, args.slice(1))
+      break
+    case 'sync':
+      await runSync(siteRoot, config, args.slice(1))
+      break
+    case 'status':
+      await runStatus(siteRoot, config, args.slice(1))
+      break
+    default:
+      error(`Unknown subcommand: ${subcommand}`)
+      showHelp()
+      process.exit(1)
+  }
+}
+/**
+ * Find site root by looking for site.yml
+ */
+async function findSiteRoot() {
+  let dir = process.cwd()
+  // Check current directory and parents
+  for (let i = 0; i < 5; i++) {
+    if (existsSync(join(dir, 'site.yml'))) {
+      return dir
+    }
+    const parent = resolve(dir, '..')
+    if (parent === dir) break
+    dir = parent
+  }
+  return null
+}
+/**
+ * Load site configuration
+ *
+ * Resolves locales from config:
+ * - undefined → all available locales (from locales/*.json)
+ * - '*' → explicitly all available locales
+ * - ['es', 'fr'] → only those specific locales
+ */
+async function loadSiteConfig(siteRoot) {
+  const configPath = join(siteRoot, 'site.yml')
+  const content = await readFile(configPath, 'utf-8')
+  const config = yaml.load(content) || {}
+  const localesDir = config.i18n?.localesDir || 'locales'
+  const localesPath = join(siteRoot, localesDir)
+  // Resolve locales (undefined/'*' → all available, array → specific)
+  const { resolveLocales } = await import('@uniweb/build/i18n')
+  const locales = await resolveLocales(config.i18n?.locales, localesPath)
+  return {
+    defaultLocale: config.defaultLanguage || 'en',
+    locales,
+    localesDir,
+    ...config.i18n,
+  }
+}
+/**
+ * Extract command - extract translatable strings from site content
+ */
+async function runExtract(siteRoot, config, args) {
+  const verbose = args.includes('--verbose') || args.includes('-v')
+  log(`\n${colors.cyan}Extracting translatable content...${colors.reset}\n`)
+  // Check if site has been built
+  const siteContentPath = join(siteRoot, 'dist', 'site-content.json')
+  if (!existsSync(siteContentPath)) {
+    error('Site content not found. Run "uniweb build" first.')
+    process.exit(1)
+  }
+  try {
+    // Dynamic import to avoid loading at CLI startup
+    const { extractManifest, formatSyncReport } = await import('@uniweb/build/i18n')
+    const { manifest, report } = await extractManifest(siteRoot, {
+      localesDir: config.localesDir,
+      siteContentPath,
+      verbose,
+    })
+    // Show results
+    const unitCount = Object.keys(manifest.units).length
+    success(`Extracted ${unitCount} translatable strings`)
+    if (report) {
+      log('')
+      log(formatSyncReport(report))
+    }
+    log(`\nManifest written to: ${colors.dim}${config.localesDir}/manifest.json${colors.reset}`)
+    if (config.locales.length === 0) {
+      log(`\n${colors.dim}No translation files found in ${config.localesDir}/.`)
+      log(`After translating, create locale files like ${config.localesDir}/es.json${colors.reset}`)
+    }
+  } catch (err) {
+    error(`Extraction failed: ${err.message}`)
+    if (verbose) console.error(err)
+    process.exit(1)
+  }
+}
+/**
+ * Sync command - detect changes and update manifest
+ */
+async function runSync(siteRoot, config, args) {
+  const verbose = args.includes('--verbose') || args.includes('-v')
+  const dryRun = args.includes('--dry-run')
+  log(`\n${colors.cyan}Syncing i18n manifest...${colors.reset}\n`)
+  // Check if site has been built
+  const siteContentPath = join(siteRoot, 'dist', 'site-content.json')
+  if (!existsSync(siteContentPath)) {
+    error('Site content not found. Run "uniweb build" first.')
+    process.exit(1)
+  }
+  // Check if manifest exists
+  const manifestPath = join(siteRoot, config.localesDir, 'manifest.json')
+  if (!existsSync(manifestPath)) {
+    warn('No existing manifest found. Running extract instead.')
+    return runExtract(siteRoot, config, args)
+  }
+  try {
+    const { extractManifest, formatSyncReport } = await import('@uniweb/build/i18n')
+    if (dryRun) {
+      log(`${colors.dim}(dry run - no files will be modified)${colors.reset}\n`)
+    }
+    const { manifest, report } = await extractManifest(siteRoot, {
+      localesDir: config.localesDir,
+      siteContentPath,
+      verbose,
+      dryRun,
+    })
+    log(formatSyncReport(report))
+    if (!dryRun) {
+      success('\nManifest updated')
+    }
+  } catch (err) {
+    error(`Sync failed: ${err.message}`)
+    if (verbose) console.error(err)
+    process.exit(1)
+  }
+}
+/**
+ * Status command - show translation coverage
+ */
+async function runStatus(siteRoot, config, args) {
+  const locale = args.find(a => !a.startsWith('-'))
+  log(`\n${colors.cyan}Translation Status${colors.reset}\n`)
+  // Check if manifest exists
+  const manifestPath = join(siteRoot, config.localesDir, 'manifest.json')
+  if (!existsSync(manifestPath)) {
+    error('No manifest found. Run "uniweb i18n extract" first.')
+    process.exit(1)
+  }
+  if (config.locales.length === 0) {
+    log(`${colors.dim}No translation files found in ${config.localesDir}/.`)
+    log(`Create locale files like ${config.localesDir}/es.json to add translations.${colors.reset}`)
+    return
+  }
+  try {
+    const { getTranslationStatus, formatTranslationStatus } = await import('@uniweb/build/i18n')
+    const localesToCheck = locale ? [locale] : config.locales
+    const status = await getTranslationStatus(siteRoot, {
+      localesDir: config.localesDir,
+      locales: localesToCheck,
+    })
+    log(formatTranslationStatus(status))
+    // Show next steps if there are missing translations
+    const hasMissing = Object.values(status.locales).some(l => l.missing > 0)
+    if (hasMissing) {
+      log(`\n${colors.dim}To translate missing strings, edit the locale files in ${config.localesDir}/`)
+      log(`Or use AI tools with the manifest.json as reference.${colors.reset}`)
+    }
+  } catch (err) {
+    error(`Status check failed: ${err.message}`)
+    process.exit(1)
+  }
+}
+/**
+ * Show help for i18n commands
+ */
+function showHelp() {
+  log(`
+${colors.cyan}${colors.bright}Uniweb i18n${colors.reset}
+Site content internationalization commands.
+${colors.bright}Usage:${colors.reset}
+  uniweb i18n <command> [options]
+${colors.bright}Commands:${colors.reset}
+  extract      Extract translatable strings to locales/manifest.json
+  sync         Update manifest with content changes (detects moved/changed content)
+  status       Show translation coverage per locale
+${colors.bright}Options:${colors.reset}
+  --verbose    Show detailed output
+  --dry-run    (sync) Show changes without writing files
+${colors.bright}Configuration:${colors.reset}
+  Optional site.yml settings:
+    i18n:
+      locales: [es, fr]          # Specific locales only (default: all available)
+      locales: '*'               # Explicitly all available locales
+      localesDir: locales        # Directory for translation files (default: locales)
+  By default, all *.json files in locales/ are treated as translation targets.
+${colors.bright}Workflow:${colors.reset}
+  1. Build your site:           uniweb build
+  2. Extract strings:           uniweb i18n extract
+  3. Translate locale files:    Edit locales/es.json, locales/fr.json, etc.
+  4. Build with translations:   uniweb build (generates locale-specific output)
+${colors.bright}File Structure:${colors.reset}
+  locales/
+    manifest.json     Auto-generated: source strings + hashes + contexts
+    es.json           Translations for Spanish
+    fr.json           Translations for French
+    _memory.json      Optional: translation memory for reuse
+${colors.bright}Examples:${colors.reset}
+  uniweb i18n extract              # Extract all translatable strings
+  uniweb i18n extract --verbose    # Show extracted strings
+  uniweb i18n sync                 # Update manifest after content changes
+  uniweb i18n sync --dry-run       # Preview changes without writing
+  uniweb i18n status               # Show coverage for all locales
+  uniweb i18n status es            # Show coverage for Spanish only
+`)
+}
+export default i18n

package/src/index.js CHANGED Viewed

@@ -3,14 +3,13 @@
 /**
  * Uniweb CLI
  *
- * Scaffolds new Uniweb sites and foundations, and builds projects.
+ * Scaffolds new Uniweb sites and foundations, builds projects, and generates docs.
  *
  * Usage:
  *   npx uniweb create [project-name]
- *   npx uniweb create --template single      # site/ + foundation/ (default)
- *   npx uniweb create --template multi       # sites/* + foundations/*
+ *   npx uniweb create --template marketing
  *   npx uniweb build
- *   npx uniweb build --target foundation
+ *   npx uniweb docs                          # Generate COMPONENTS.md from schema
  */
 import { existsSync, mkdirSync, writeFileSync, readFileSync } from 'node:fs'
@@ -18,6 +17,8 @@ import { resolve, join, dirname } from 'node:path'
 import { fileURLToPath } from 'node:url'
 import prompts from 'prompts'
 import { build } from './commands/build.js'
+import { docs } from './commands/docs.js'
+import { i18n } from './commands/i18n.js'
 import { getVersionsForTemplates, getVersion } from './versions.js'
 import {
   resolveTemplate,
@@ -84,6 +85,18 @@ async function main() {
     return
   }
+  // Handle docs command
+  if (command === 'docs') {
+    await docs(args.slice(1))
+    return
+  }
+  // Handle i18n command
+  if (command === 'i18n') {
+    await i18n(args.slice(1))
+    return
+  }
   // Handle create command
   if (command !== 'create') {
     error(`Unknown command: ${command}`)
@@ -239,6 +252,8 @@ ${colors.bright}Usage:${colors.reset}
 ${colors.bright}Commands:${colors.reset}
   create [name]      Create a new project
   build              Build the current project
+  docs               Generate component documentation
+  i18n <cmd>         Internationalization (extract, sync, status)
 ${colors.bright}Create Options:${colors.reset}
   --template <type>  Project template
@@ -251,6 +266,15 @@ ${colors.bright}Build Options:${colors.reset}
   --foundation-dir   Path to foundation directory (for prerendering)
   --platform <name>  Deployment platform (e.g., vercel) for platform-specific output
+${colors.bright}Docs Options:${colors.reset}
+  --output <file>    Output filename (default: COMPONENTS.md)
+  --from-source      Read meta.js files directly instead of schema.json
+${colors.bright}i18n Commands:${colors.reset}
+  extract            Extract translatable strings to manifest
+  sync               Update manifest with content changes
+  status             Show translation coverage per locale
 ${colors.bright}Template Types:${colors.reset}
   single                        One site + one foundation (default)
   multi                         Multiple sites and foundations
@@ -268,6 +292,7 @@ ${colors.bright}Examples:${colors.reset}
   npx uniweb build
   npx uniweb build --target foundation
   npx uniweb build --prerender                         # Build site + pre-render to static HTML
+  cd foundation && npx uniweb docs                     # Generate COMPONENTS.md
 `)
 }

package/src/versions.js CHANGED Viewed

@@ -72,6 +72,9 @@ export function getResolvedVersions() {
     '@uniweb/runtime': '^0.1.0',
     '@uniweb/core': '^0.1.0',
+    // Foundation utility library (used by official templates)
+    '@uniweb/kit': '^0.1.0',
     // CLI itself (use current version)
     'uniweb': `^${pkg.version}`,
   }
@@ -106,6 +109,7 @@ export function getVersionsForTemplates() {
     build: versions['@uniweb/build'],
     runtime: versions['@uniweb/runtime'],
     core: versions['@uniweb/core'],
+    kit: versions['@uniweb/kit'],
     templates: versions['@uniweb/templates'],
     cli: versions['uniweb'],
   }