@uniweb/build 0.1.4 → 0.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniweb/build",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Build tooling for the Uniweb Component Web Platform",
   "type": "module",
   "exports": {
@@ -42,13 +42,13 @@
     "sharp": "^0.33.2"
   },
   "optionalDependencies": {
-    "@uniweb/content-reader": "1.0.2"
+    "@uniweb/content-reader": "1.0.3"
   },
   "peerDependencies": {
     "vite": "^5.0.0 || ^6.0.0 || ^7.0.0",
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0",
-    "@uniweb/core": "0.1.2"
+    "@uniweb/core": "0.1.4"
   },
   "peerDependenciesMeta": {
     "vite": {

package/src/docs.js

@@ -0,0 +1,217 @@
+/**
+ * Documentation Generator
+ *
+ * Generates markdown documentation from foundation schema.json
+ * or directly from component meta files.
+ */
+
+import { readFile, writeFile } from 'node:fs/promises'
+import { existsSync } from 'node:fs'
+import { join } from 'node:path'
+import { buildSchema } from './schema.js'
+
+/**
+ * Generate markdown documentation for a single component
+ *
+ * @param {string} name - Component name
+ * @param {Object} meta - Component metadata
+ * @returns {string} Markdown content
+ */
+function generateComponentDocs(name, meta) {
+  const lines = []
+
+  // Component header
+  lines.push(`## ${name}`)
+  lines.push('')
+
+  // Description
+  if (meta.description) {
+    lines.push(meta.description)
+    lines.push('')
+  }
+
+  // Category badge
+  if (meta.category) {
+    lines.push(`**Category:** ${meta.category}`)
+    lines.push('')
+  }
+
+  // Content Elements
+  if (meta.elements && Object.keys(meta.elements).length > 0) {
+    lines.push('### Content Elements')
+    lines.push('')
+    lines.push('| Element | Label | Required | Description |')
+    lines.push('|---------|-------|----------|-------------|')
+
+    for (const [key, element] of Object.entries(meta.elements)) {
+      const label = element.label || key
+      const required = element.required ? 'Yes' : ''
+      const description = element.description || ''
+      lines.push(`| \`${key}\` | ${label} | ${required} | ${description} |`)
+    }
+    lines.push('')
+  }
+
+  // Parameters/Properties
+  if (meta.properties && Object.keys(meta.properties).length > 0) {
+    lines.push('### Parameters')
+    lines.push('')
+    lines.push('| Parameter | Type | Default | Description |')
+    lines.push('|-----------|------|---------|-------------|')
+
+    for (const [key, prop] of Object.entries(meta.properties)) {
+      const type = prop.type || 'string'
+      const defaultVal = prop.default !== undefined ? `\`${prop.default}\`` : ''
+      let description = prop.label || ''
+
+      // Add options for select type
+      if (prop.type === 'select' && prop.options) {
+        const optionValues = prop.options.map(o =>
+          typeof o === 'object' ? o.value : o
+        ).join(', ')
+        description += description ? ` (${optionValues})` : optionValues
+      }
+
+      lines.push(`| \`${key}\` | ${type} | ${defaultVal} | ${description} |`)
+    }
+    lines.push('')
+  }
+
+  // Presets
+  if (meta.presets && meta.presets.length > 0) {
+    lines.push('### Presets')
+    lines.push('')
+
+    for (const preset of meta.presets) {
+      const settings = preset.settings
+        ? Object.entries(preset.settings)
+            .map(([k, v]) => `${k}: ${v}`)
+            .join(', ')
+        : ''
+      lines.push(`- **${preset.name}** - ${preset.label || ''} ${settings ? `(${settings})` : ''}`)
+    }
+    lines.push('')
+  }
+
+  return lines.join('\n')
+}
+
+/**
+ * Generate full markdown documentation for a foundation
+ *
+ * @param {Object} schema - Foundation schema object
+ * @param {Object} options - Generation options
+ * @param {string} [options.title] - Document title
+ * @returns {string} Complete markdown documentation
+ */
+export function generateDocsFromSchema(schema, options = {}) {
+  const { title = 'Foundation Components' } = options
+  const lines = []
+
+  // Header
+  lines.push(`# ${title}`)
+  lines.push('')
+
+  // Foundation info
+  const foundationMeta = schema._self
+  if (foundationMeta) {
+    if (foundationMeta.name) {
+      lines.push(`**${foundationMeta.name}**`)
+      lines.push('')
+    }
+    if (foundationMeta.description) {
+      lines.push(foundationMeta.description)
+      lines.push('')
+    }
+  }
+
+  lines.push('---')
+  lines.push('')
+
+  // Table of contents
+  const componentNames = Object.keys(schema).filter(k => k !== '_self')
+
+  if (componentNames.length > 0) {
+    lines.push('## Components')
+    lines.push('')
+    for (const name of componentNames) {
+      const meta = schema[name]
+      const title = meta.title || name
+      lines.push(`- [${title}](#${name.toLowerCase()}) - ${meta.description || ''}`)
+    }
+    lines.push('')
+    lines.push('---')
+    lines.push('')
+  }
+
+  // Component documentation
+  for (const name of componentNames) {
+    const meta = schema[name]
+    lines.push(generateComponentDocs(name, meta))
+    lines.push('---')
+    lines.push('')
+  }
+
+  // Footer
+  lines.push('*Generated from foundation schema*')
+
+  return lines.join('\n')
+}
+
+/**
+ * Generate documentation for a foundation directory
+ *
+ * Can read from existing schema.json or build schema from source.
+ *
+ * @param {string} foundationDir - Path to foundation directory
+ * @param {Object} options - Options
+ * @param {string} [options.output] - Output file path (default: COMPONENTS.md)
+ * @param {boolean} [options.fromSource] - Build schema from source instead of dist
+ * @returns {Promise<{outputPath: string, componentCount: number}>}
+ */
+export async function generateDocs(foundationDir, options = {}) {
+  const {
+    output = 'COMPONENTS.md',
+    fromSource = false,
+  } = options
+
+  let schema
+
+  // Try to load schema.json from dist
+  const schemaPath = join(foundationDir, 'dist', 'schema.json')
+
+  if (!fromSource && existsSync(schemaPath)) {
+    // Load from existing schema.json
+    const schemaContent = await readFile(schemaPath, 'utf-8')
+    schema = JSON.parse(schemaContent)
+  } else {
+    // Build schema from source
+    const srcDir = join(foundationDir, 'src')
+    if (!existsSync(srcDir)) {
+      throw new Error(`Source directory not found: ${srcDir}`)
+    }
+    schema = await buildSchema(srcDir)
+  }
+
+  // Get foundation name for title
+  const pkgPath = join(foundationDir, 'package.json')
+  let title = 'Foundation Components'
+  if (existsSync(pkgPath)) {
+    const pkg = JSON.parse(await readFile(pkgPath, 'utf-8'))
+    if (pkg.name) {
+      title = `${pkg.name} Components`
+    }
+  }
+
+  // Generate markdown
+  const markdown = generateDocsFromSchema(schema, { title })
+
+  // Write output
+  const outputPath = join(foundationDir, output)
+  await writeFile(outputPath, markdown)
+
+  // Count components
+  const componentCount = Object.keys(schema).filter(k => k !== '_self').length
+
+  return { outputPath, componentCount }
+}

package/src/index.js

@@ -40,5 +40,11 @@ export {
   prerenderSite,
 } from './prerender.js'
 
+// Documentation generation
+export {
+  generateDocs,
+  generateDocsFromSchema,
+} from './docs.js'
+
 // Default export is the combined Vite plugin
 export { default } from './vite-foundation-plugin.js'