sdocs 0.0.1

package/dist/vite-plugin.js

@@ -0,0 +1,206 @@
+import { readFileSync } from 'fs';
+import { parseProps } from './docgen.js';
+const VIRTUAL_MODULE_ID = 'virtual:sdocs';
+const RESOLVED_VIRTUAL_MODULE_ID = '\0' + VIRTUAL_MODULE_ID;
+/**
+ * Extract export order from a .docs.svelte file
+ * Returns array of exported names in order
+ */
+function extractExportOrder(source) {
+    // Match: export { Name1, Name2, Name3 }
+    const exportMatch = source.match(/export\s*\{([^}]+)\}/);
+    if (exportMatch) {
+        return exportMatch[1]
+            .split(',')
+            .map(s => s.trim())
+            .filter(s => s && s !== 'meta');
+    }
+    return [];
+}
+/**
+ * Extract snippet source code from a .docs.svelte file
+ * Returns a map of snippet name -> source code
+ */
+function extractSnippetSources(source) {
+    const snippets = {};
+    // Match {#snippet Name(args)}...{/snippet} blocks
+    // Using a simple approach that handles nested braces
+    const snippetRegex = /\{#snippet\s+(\w+)\s*\([^)]*\)\}/g;
+    let match;
+    while ((match = snippetRegex.exec(source)) !== null) {
+        const snippetName = match[1];
+        const startIndex = match.index;
+        const startTag = match[0];
+        const contentStart = startIndex + startTag.length;
+        // Find the matching {/snippet} by counting nesting
+        let depth = 1;
+        let pos = contentStart;
+        while (depth > 0 && pos < source.length) {
+            const nextOpen = source.indexOf('{#snippet', pos);
+            const nextClose = source.indexOf('{/snippet}', pos);
+            if (nextClose === -1)
+                break;
+            if (nextOpen !== -1 && nextOpen < nextClose) {
+                depth++;
+                pos = nextOpen + 9; // length of '{#snippet'
+            }
+            else {
+                depth--;
+                if (depth === 0) {
+                    // Extract the content between start tag and {/snippet}
+                    const content = source.slice(contentStart, nextClose).trim();
+                    snippets[snippetName] = content;
+                }
+                pos = nextClose + 10; // length of '{/snippet}'
+            }
+        }
+    }
+    return snippets;
+}
+/**
+ * Vite plugin that extracts prop information from Svelte 5 components
+ * and attaches it as __docgen metadata for runtime access.
+ * Also extracts snippet source code from doc files.
+ * Provides a virtual module for auto-loading doc files.
+ */
+export function sdocsPlugin(options = {}) {
+    const docgenCache = new Map();
+    const snippetSourceCache = new Map();
+    // Normalize include patterns for import.meta.glob in virtual modules.
+    // Virtual modules require absolute paths (starting with /) or alias prefixes ($lib/).
+    // Convert relative patterns like ./src/** or src/** to /src/**
+    const rawPatterns = options.include
+        ? Array.isArray(options.include)
+            ? options.include
+            : [options.include]
+        : ['$lib/**/*.docs.{svelte,svx}'];
+    const includePatterns = rawPatterns.map((p) => {
+        if (p.startsWith('/') || p.startsWith('$'))
+            return p;
+        if (p.startsWith('./'))
+            return '/' + p.slice(2);
+        if (p.startsWith('../'))
+            return p; // relative traversal — keep as-is
+        return '/' + p;
+    });
+    // Generate the virtual module code with import.meta.glob
+    function generateVirtualModuleCode() {
+        const globs = includePatterns
+            .map((pattern) => `import.meta.glob('${pattern}', { eager: true })`)
+            .join(',\n  ');
+        if (includePatterns.length === 1) {
+            return `export const docs = ${globs};`;
+        }
+        // Multiple patterns - merge them
+        return `const modules = [
+  ${globs}
+];
+export const docs = Object.assign({}, ...modules);`;
+    }
+    return {
+        name: 'sdocs',
+        enforce: 'post', // Run after Svelte plugin compiles to JS
+        resolveId(id) {
+            if (id === VIRTUAL_MODULE_ID) {
+                return RESOLVED_VIRTUAL_MODULE_ID;
+            }
+        },
+        load(id) {
+            if (id === RESOLVED_VIRTUAL_MODULE_ID) {
+                return generateVirtualModuleCode();
+            }
+        },
+        configureServer(devServer) {
+            // Watch for new/deleted doc files and trigger full reload
+            // This fixes the issue where import.meta.glob doesn't detect new files
+            devServer.watcher.on('add', (file) => {
+                if (file.includes('.docs.svelte') || file.includes('.docs.svx')) {
+                    console.log(`[sdocs] New doc file detected: ${file}`);
+                    // Send full reload to pick up new glob entries
+                    devServer.ws.send({ type: 'full-reload' });
+                }
+            });
+            devServer.watcher.on('unlink', (file) => {
+                if (file.includes('.docs.svelte') || file.includes('.docs.svx')) {
+                    console.log(`[sdocs] Doc file removed: ${file}`);
+                    devServer.ws.send({ type: 'full-reload' });
+                }
+            });
+        },
+        transform(code, id) {
+            const isSvelte = id.endsWith('.svelte');
+            const isSvx = id.endsWith('.svx');
+            if (!isSvelte && !isSvx) {
+                return null;
+            }
+            // Handle doc files - extract snippet source code and export order (both .svelte and .svx)
+            if (id.includes('.docs.')) {
+                try {
+                    const source = readFileSync(id, 'utf-8');
+                    const snippetSources = extractSnippetSources(source);
+                    const exampleOrder = extractExportOrder(source);
+                    const hasSnippets = Object.keys(snippetSources).length > 0;
+                    const hasOrder = exampleOrder.length > 0;
+                    if (hasSnippets || hasOrder) {
+                        snippetSourceCache.set(id, snippetSources);
+                        // Add exports to the compiled module
+                        let newCode = code;
+                        if (hasSnippets) {
+                            newCode += `\nexport const __snippetSources = ${JSON.stringify(snippetSources)};`;
+                        }
+                        if (hasOrder) {
+                            newCode += `\nexport const __exampleOrder = ${JSON.stringify(exampleOrder)};`;
+                        }
+                        return { code: newCode + '\n', map: null };
+                    }
+                }
+                catch (err) {
+                    if (process.env.DEBUG) {
+                        console.warn(`[sdocs] Failed to extract snippets from ${id}:`, err);
+                    }
+                }
+                return null;
+            }
+            // Handle regular component files - extract prop docgen (only .svelte, not .svx)
+            if (!isSvelte) {
+                return null;
+            }
+            // Skip internal sdocs components - they don't need docgen
+            if (id.includes('/internal/') || id.includes('\\internal\\')) {
+                return null;
+            }
+            try {
+                // Read the original source file to parse props
+                const source = readFileSync(id, 'utf-8');
+                const docgen = parseProps(source);
+                if (docgen.props.length > 0 || docgen.methods.length > 0) {
+                    docgenCache.set(id, docgen);
+                    // The Svelte plugin has already compiled to JS
+                    // Find the default export and attach __docgen to it
+                    const docgenJson = JSON.stringify(docgen);
+                    // Look for the component export pattern in compiled Svelte 5 code
+                    // Pattern: "export default <ComponentName>" (client) or "export default function <Name>" (SSR)
+                    if (code.includes('export default')) {
+                        // Match "export default ComponentName" but not "export default function"
+                        const exportMatch = code.match(/export\s+default\s+(?!function\b)(\w+)/);
+                        if (exportMatch) {
+                            const componentName = exportMatch[1];
+                            // Add docgen assignment before the export
+                            const modifiedCode = code.replace(new RegExp(`(export\\s+default\\s+)(${componentName})`), `${componentName}.__docgen = ${docgenJson};\n$1$2`);
+                            return { code: modifiedCode, map: null };
+                        }
+                        // For SSR: "export default function ComponentName" - skip docgen injection
+                        // SSR components are not interactive, docgen is only needed for client
+                    }
+                }
+            }
+            catch (err) {
+                if (process.env.DEBUG) {
+                    console.warn(`[sdocs] Failed to parse ${id}:`, err);
+                }
+            }
+            return null;
+        }
+    };
+}
+export default sdocsPlugin;

package/dist/vite.d.ts

@@ -0,0 +1,2 @@
+export { sdocsPlugin, default } from './vite-plugin.js';
+export type { ComponentDocgen, SdocsPluginOptions } from './vite-plugin.js';

package/dist/vite.js

@@ -0,0 +1,2 @@
+// Separate entry for vite plugin (no Svelte imports)
+export { sdocsPlugin, default } from './vite-plugin.js';

package/package.json

@@ -0,0 +1,76 @@
+{
+	"name": "sdocs",
+	"version": "0.0.1",
+	"bin": {
+		"sdocs": "./bin/sdocs.js"
+	},
+	"scripts": {
+		"dev": "vite dev",
+		"build": "vite build && npm run prepack",
+		"preview": "vite preview",
+		"prepare": "svelte-kit sync || echo ''",
+		"prepack": "svelte-kit sync && svelte-package && publint",
+		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch"
+	},
+	"files": [
+		"dist",
+		"bin",
+		"!dist/**/*.test.*",
+		"!dist/**/*.spec.*"
+	],
+	"sideEffects": [
+		"**/*.css"
+	],
+	"svelte": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"svelte": "./dist/index.js",
+			"default": "./dist/index.js"
+		},
+		"./vite": {
+			"types": "./dist/vite.d.ts",
+			"default": "./dist/vite.js"
+		},
+		"./virtual": {
+			"types": "./dist/virtual-sdocs.d.ts"
+		},
+		"./Sdocs.svelte": {
+			"svelte": "./dist/Sdocs.svelte",
+			"default": "./dist/Sdocs.svelte"
+		},
+		"./ui/css/global.css": "./dist/ui/css/global.css"
+	},
+	"peerDependencies": {
+		"svelte": "^5.0.0",
+		"vite": "^6.0.0 || ^7.0.0",
+		"@sveltejs/vite-plugin-svelte": "^5.0.0 || ^6.0.0"
+	},
+	"peerDependenciesMeta": {
+		"vite": { "optional": true },
+		"@sveltejs/vite-plugin-svelte": { "optional": true }
+	},
+	"devDependencies": {
+		"@sveltejs/adapter-auto": "^7.0.0",
+		"@sveltejs/kit": "^2.50.1",
+		"@sveltejs/package": "^2.5.7",
+		"@sveltejs/vite-plugin-svelte": "^6.2.4",
+		"mdsvex": "^0.12.6",
+		"publint": "^0.3.17",
+		"svelte": "^5.48.2",
+		"svelte-check": "^4.3.5",
+		"typescript": "^5.9.3",
+		"vite": "^7.3.1"
+	},
+	"keywords": [
+		"svelte",
+		"documentation",
+		"components"
+	],
+	"dependencies": {
+		"lucide-svelte": "^0.563.0"
+	}
+}