@compilr-dev/sdk 0.2.5 → 0.2.7

package/dist/project-generator/detection.js

@@ -0,0 +1,401 @@
+/**
+ * Project Detection Utilities
+ *
+ * Utilities for detecting project information from an existing directory.
+ * Used by the import project feature.
+ */
+import * as fs from 'fs';
+import * as path from 'path';
+import { execSync } from 'child_process';
+const LANGUAGE_MARKERS = [
+    // Node.js / JavaScript / TypeScript
+    {
+        file: 'package.json',
+        language: 'node',
+        packageManager: 'npm',
+        frameworkDetector: (content) => {
+            try {
+                const pkg = JSON.parse(content);
+                const deps = { ...pkg.dependencies, ...pkg.devDependencies };
+                if (deps['next'])
+                    return 'next';
+                if (deps['nuxt'])
+                    return 'nuxt';
+                if (deps['react'])
+                    return 'react';
+                if (deps['vue'])
+                    return 'vue';
+                if (deps['svelte'])
+                    return 'svelte';
+                if (deps['@angular/core'])
+                    return 'angular';
+                if (deps['express'])
+                    return 'express';
+                if (deps['fastify'])
+                    return 'fastify';
+                if (deps['koa'])
+                    return 'koa';
+                if (deps['hono'])
+                    return 'hono';
+                if (deps['electron'])
+                    return 'electron';
+                return null;
+            }
+            catch {
+                return null;
+            }
+        },
+        nameExtractor: (content) => {
+            try {
+                const pkg = JSON.parse(content);
+                return pkg.name ?? null;
+            }
+            catch {
+                return null;
+            }
+        },
+    },
+    // Go
+    {
+        file: 'go.mod',
+        language: 'go',
+        packageManager: 'go',
+        nameExtractor: (content) => {
+            const match = content.match(/^module\s+(.+)$/m);
+            if (match) {
+                const parts = match[1].split('/');
+                return parts[parts.length - 1];
+            }
+            return null;
+        },
+    },
+    // Python
+    {
+        file: 'pyproject.toml',
+        language: 'python',
+        packageManager: 'pip',
+        frameworkDetector: (content) => {
+            if (content.includes('fastapi'))
+                return 'fastapi';
+            if (content.includes('django'))
+                return 'django';
+            if (content.includes('flask'))
+                return 'flask';
+            return null;
+        },
+        nameExtractor: (content) => {
+            const match = content.match(/^name\s*=\s*["'](.+)["']/m);
+            return match ? match[1] : null;
+        },
+    },
+    {
+        file: 'requirements.txt',
+        language: 'python',
+        packageManager: 'pip',
+        frameworkDetector: (content) => {
+            if (content.includes('fastapi'))
+                return 'fastapi';
+            if (content.includes('django'))
+                return 'django';
+            if (content.includes('flask'))
+                return 'flask';
+            return null;
+        },
+    },
+    {
+        file: 'setup.py',
+        language: 'python',
+        packageManager: 'pip',
+    },
+    // Rust
+    {
+        file: 'Cargo.toml',
+        language: 'rust',
+        packageManager: 'cargo',
+        nameExtractor: (content) => {
+            const match = content.match(/^name\s*=\s*["'](.+)["']/m);
+            return match ? match[1] : null;
+        },
+    },
+    // Java
+    { file: 'pom.xml', language: 'java', packageManager: 'maven' },
+    { file: 'build.gradle', language: 'java', packageManager: 'gradle' },
+    { file: 'build.gradle.kts', language: 'kotlin', packageManager: 'gradle' },
+    // PHP
+    {
+        file: 'composer.json',
+        language: 'php',
+        packageManager: 'composer',
+        frameworkDetector: (content) => {
+            try {
+                const pkg = JSON.parse(content);
+                const deps = pkg.require ?? {};
+                if (deps['laravel/framework'])
+                    return 'laravel';
+                if (deps['symfony/framework-bundle'])
+                    return 'symfony';
+                return null;
+            }
+            catch {
+                return null;
+            }
+        },
+        nameExtractor: (content) => {
+            try {
+                const pkg = JSON.parse(content);
+                if (pkg.name) {
+                    const parts = pkg.name.split('/');
+                    return parts[parts.length - 1];
+                }
+                return null;
+            }
+            catch {
+                return null;
+            }
+        },
+    },
+    // Ruby
+    {
+        file: 'Gemfile',
+        language: 'ruby',
+        packageManager: 'bundler',
+        frameworkDetector: (content) => {
+            if (content.includes("'rails'") || content.includes('"rails"'))
+                return 'rails';
+            if (content.includes("'sinatra'") || content.includes('"sinatra"'))
+                return 'sinatra';
+            return null;
+        },
+    },
+    // .NET
+    { file: '*.csproj', language: 'dotnet', packageManager: 'nuget' },
+    { file: '*.fsproj', language: 'dotnet', packageManager: 'nuget' },
+];
+// =============================================================================
+// Main Detection Functions
+// =============================================================================
+/**
+ * Detect project information from a directory path
+ */
+export function detectProjectInfo(projectPath) {
+    const folderName = path.basename(projectPath);
+    const result = {
+        name: folderName,
+        displayName: prettifyName(folderName),
+        nameSource: 'folder',
+        language: null,
+        framework: null,
+        packageManager: null,
+        hasGit: false,
+        gitRemote: null,
+        gitBranch: null,
+        hasCompilrMd: false,
+        hasClaudeMd: false,
+    };
+    // Check for COMPILR.md and CLAUDE.md
+    result.hasCompilrMd = fs.existsSync(path.join(projectPath, 'COMPILR.md'));
+    result.hasClaudeMd = fs.existsSync(path.join(projectPath, 'CLAUDE.md'));
+    // Detect git info
+    const gitInfo = detectGitInfo(projectPath);
+    result.hasGit = gitInfo.hasGit;
+    result.gitRemote = gitInfo.remote;
+    result.gitBranch = gitInfo.branch;
+    // Detect language and framework from markers
+    for (const marker of LANGUAGE_MARKERS) {
+        let filePath = null;
+        if (marker.file.includes('*')) {
+            const pattern = marker.file.replace('*', '');
+            try {
+                const files = fs.readdirSync(projectPath);
+                const match = files.find((f) => f.endsWith(pattern));
+                if (match) {
+                    filePath = path.join(projectPath, match);
+                }
+            }
+            catch {
+                continue;
+            }
+        }
+        else {
+            filePath = path.join(projectPath, marker.file);
+        }
+        if (filePath && fs.existsSync(filePath)) {
+            if (!result.language) {
+                result.language = marker.language;
+            }
+            try {
+                const content = fs.readFileSync(filePath, 'utf-8');
+                if (marker.nameExtractor && result.nameSource === 'folder') {
+                    const extractedName = marker.nameExtractor(content);
+                    if (extractedName) {
+                        result.name = extractedName;
+                        result.displayName = prettifyName(extractedName);
+                        result.nameSource = marker.file;
+                    }
+                }
+                if (!result.framework && marker.frameworkDetector) {
+                    result.framework = marker.frameworkDetector(content);
+                }
+                if (!result.packageManager && marker.packageManager) {
+                    result.packageManager = marker.packageManager;
+                }
+            }
+            catch {
+                // File read failed, continue
+            }
+        }
+    }
+    // Detect package manager overrides for Node.js
+    if (result.language === 'node') {
+        if (fs.existsSync(path.join(projectPath, 'pnpm-lock.yaml'))) {
+            result.packageManager = 'pnpm';
+        }
+        else if (fs.existsSync(path.join(projectPath, 'yarn.lock'))) {
+            result.packageManager = 'yarn';
+        }
+        else if (fs.existsSync(path.join(projectPath, 'bun.lockb'))) {
+            result.packageManager = 'bun';
+        }
+    }
+    // Detect package manager overrides for Python
+    if (result.language === 'python') {
+        if (fs.existsSync(path.join(projectPath, 'poetry.lock'))) {
+            result.packageManager = 'poetry';
+        }
+        else if (fs.existsSync(path.join(projectPath, 'pdm.lock'))) {
+            result.packageManager = 'pdm';
+        }
+        else if (fs.existsSync(path.join(projectPath, 'uv.lock'))) {
+            result.packageManager = 'uv';
+        }
+    }
+    return result;
+}
+/**
+ * Detect git repository information
+ */
+export function detectGitInfo(projectPath) {
+    const result = {
+        hasGit: false,
+        remote: null,
+        branch: null,
+    };
+    const gitPath = path.join(projectPath, '.git');
+    if (!fs.existsSync(gitPath)) {
+        return result;
+    }
+    result.hasGit = true;
+    try {
+        const remote = execSync('git remote get-url origin', {
+            cwd: projectPath,
+            encoding: 'utf8',
+            stdio: ['pipe', 'pipe', 'pipe'],
+        }).trim();
+        if (remote) {
+            result.remote = remote;
+        }
+    }
+    catch {
+        // No remote configured
+    }
+    try {
+        const branch = execSync('git branch --show-current', {
+            cwd: projectPath,
+            encoding: 'utf8',
+            stdio: ['pipe', 'pipe', 'pipe'],
+        }).trim();
+        if (branch) {
+            result.branch = branch;
+        }
+    }
+    catch {
+        // Detached HEAD or git command failed
+    }
+    return result;
+}
+// =============================================================================
+// Helper Functions
+// =============================================================================
+/**
+ * Convert kebab-case or snake_case to Title Case
+ */
+export function prettifyName(name) {
+    return name.replace(/[-_]/g, ' ').replace(/\b\w/g, (c) => c.toUpperCase());
+}
+/**
+ * Get a human-readable label for detected language
+ */
+export function getLanguageLabel(language) {
+    if (!language)
+        return 'Unknown';
+    const labels = {
+        node: 'Node.js / TypeScript',
+        go: 'Go',
+        python: 'Python',
+        rust: 'Rust',
+        java: 'Java',
+        kotlin: 'Kotlin',
+        php: 'PHP',
+        ruby: 'Ruby',
+        dotnet: '.NET (C#/F#)',
+    };
+    return labels[language] ?? language;
+}
+/**
+ * Get a human-readable label for detected framework
+ */
+export function getFrameworkLabel(framework) {
+    if (!framework)
+        return 'Not detected';
+    const labels = {
+        react: 'React',
+        vue: 'Vue.js',
+        svelte: 'Svelte',
+        angular: 'Angular',
+        next: 'Next.js',
+        nuxt: 'Nuxt.js',
+        express: 'Express.js',
+        fastify: 'Fastify',
+        koa: 'Koa',
+        hono: 'Hono',
+        electron: 'Electron',
+        fastapi: 'FastAPI',
+        django: 'Django',
+        flask: 'Flask',
+        rails: 'Ruby on Rails',
+        sinatra: 'Sinatra',
+        laravel: 'Laravel',
+        symfony: 'Symfony',
+    };
+    return labels[framework] ?? framework;
+}
+/**
+ * Check if a path is a valid directory that can be imported
+ */
+export function validateImportPath(importPath) {
+    if (!fs.existsSync(importPath)) {
+        return { valid: false, error: 'Path does not exist' };
+    }
+    try {
+        const stats = fs.statSync(importPath);
+        if (!stats.isDirectory()) {
+            return { valid: false, error: 'Path is not a directory' };
+        }
+    }
+    catch {
+        return { valid: false, error: 'Cannot access path' };
+    }
+    return { valid: true };
+}
+/**
+ * Validate project name
+ */
+export function isValidProjectName(name) {
+    return /^[a-z][a-z0-9-]{1,49}$/.test(name);
+}
+/**
+ * Check if project directory already exists
+ */
+export function projectExists(name, basePath) {
+    return fs.existsSync(path.join(basePath, name));
+}

package/dist/project-generator/generator.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Project Generator
+ *
+ * Main module for generating project scaffolding.
+ */
+import type { ProjectConfig, GenerationResult } from './types.js';
+/**
+ * Generate a new project from configuration
+ */
+export declare function generateProject(config: ProjectConfig, basePath: string): GenerationResult;
+/**
+ * Check if git user.name and user.email are configured
+ */
+export declare function isGitConfigured(): boolean;

package/dist/project-generator/generator.js

@@ -0,0 +1,245 @@
+/**
+ * Project Generator
+ *
+ * Main module for generating project scaffolding.
+ */
+import * as fs from 'fs';
+import * as path from 'path';
+import { execSync } from 'child_process';
+import { generateCompilrMd } from './templates/compilr-md.js';
+import { generateCodingStandardsMd } from './templates/coding-standards.js';
+import { generateConfigJson } from './templates/config-json.js';
+import { generateReadmeMd } from './templates/readme-md.js';
+import { generatePackageJson } from './templates/package-json.js';
+import { generateGitignore } from './templates/gitignore.js';
+import { generateTsconfig } from './templates/tsconfig.js';
+// =============================================================================
+// Main Generator
+// =============================================================================
+/**
+ * Generate a new project from configuration
+ */
+export function generateProject(config, basePath) {
+    const filesCreated = [];
+    try {
+        if (config.repoPattern === 'single') {
+            return generateSingleRepoProject(config, basePath, filesCreated);
+        }
+        else {
+            return generateTwoRepoProject(config, basePath, filesCreated);
+        }
+    }
+    catch (error) {
+        return {
+            success: false,
+            projectPath: path.join(basePath, config.name),
+            filesCreated,
+            error: error instanceof Error ? error.message : String(error),
+        };
+    }
+}
+// =============================================================================
+// Single Repo Pattern
+// =============================================================================
+function generateSingleRepoProject(config, basePath, filesCreated) {
+    const projectPath = path.join(basePath, config.name);
+    // Create directory structure
+    const dirs = [
+        projectPath,
+        path.join(projectPath, 'src'),
+        path.join(projectPath, '.compilr'),
+        path.join(projectPath, '.compilr', 'architecture'),
+        path.join(projectPath, '.compilr', 'architecture', 'decisions'),
+        path.join(projectPath, '.compilr', 'docs'),
+        path.join(projectPath, '.compilr', 'sessions'),
+    ];
+    for (const dir of dirs) {
+        fs.mkdirSync(dir, { recursive: true });
+    }
+    // Generate and write files
+    const files = [
+        { path: path.join(projectPath, 'COMPILR.md'), content: generateCompilrMd(config) },
+        { path: path.join(projectPath, 'README.md'), content: generateReadmeMd(config) },
+        { path: path.join(projectPath, 'package.json'), content: generatePackageJson(config) },
+        { path: path.join(projectPath, '.gitignore'), content: generateGitignore(config) },
+        { path: path.join(projectPath, 'tsconfig.json'), content: generateTsconfig(config) },
+        {
+            path: path.join(projectPath, '.compilr', 'config.json'),
+            content: generateConfigJson(config, projectPath),
+        },
+        { path: path.join(projectPath, '.compilr', 'roadmap.md'), content: generateRoadmapMd(config) },
+        {
+            path: path.join(projectPath, '.compilr', 'architecture', 'coding-standards.md'),
+            content: generateCodingStandardsMd(config),
+        },
+        {
+            path: path.join(projectPath, '.compilr', 'docs', 'README.md'),
+            content: '# Documentation\n\n*Add your documentation here*\n',
+        },
+        {
+            path: path.join(projectPath, '.compilr', 'sessions', 'README.md'),
+            content: '# Session Notes\n\n*Session notes will be auto-generated here*\n',
+        },
+    ];
+    for (const file of files) {
+        fs.writeFileSync(file.path, file.content, 'utf-8');
+        filesCreated.push(file.path);
+    }
+    // Initialize git if requested
+    if (config.initGit) {
+        initGit(projectPath);
+    }
+    return {
+        success: true,
+        projectPath,
+        filesCreated,
+    };
+}
+// =============================================================================
+// Two Repo Pattern
+// =============================================================================
+function generateTwoRepoProject(config, basePath, filesCreated) {
+    const projectPath = path.join(basePath, config.name);
+    const docsPath = path.join(basePath, `${config.name}-docs`);
+    // Create code repo structure
+    const codeDirs = [projectPath, path.join(projectPath, 'src')];
+    for (const dir of codeDirs) {
+        fs.mkdirSync(dir, { recursive: true });
+    }
+    // Create docs repo structure
+    const docsDirs = [
+        docsPath,
+        path.join(docsPath, '.compilr'),
+        path.join(docsPath, '01-planning'),
+        path.join(docsPath, '02-architecture'),
+        path.join(docsPath, '02-architecture', 'decisions'),
+        path.join(docsPath, '03-documentation'),
+        path.join(docsPath, '04-session-notes'),
+    ];
+    for (const dir of docsDirs) {
+        fs.mkdirSync(dir, { recursive: true });
+    }
+    // Generate code repo files
+    const codeFiles = [
+        { path: path.join(projectPath, 'README.md'), content: generateReadmeMd(config) },
+        { path: path.join(projectPath, 'package.json'), content: generatePackageJson(config) },
+        { path: path.join(projectPath, '.gitignore'), content: generateGitignore(config) },
+        { path: path.join(projectPath, 'tsconfig.json'), content: generateTsconfig(config) },
+    ];
+    for (const file of codeFiles) {
+        fs.writeFileSync(file.path, file.content, 'utf-8');
+        filesCreated.push(file.path);
+    }
+    // Generate docs repo files
+    const docsFiles = [
+        { path: path.join(docsPath, 'COMPILR.md'), content: generateCompilrMd(config) },
+        {
+            path: path.join(docsPath, '.compilr', 'config.json'),
+            content: generateConfigJson(config, projectPath, docsPath),
+        },
+        { path: path.join(docsPath, '01-planning', 'roadmap.md'), content: generateRoadmapMd(config) },
+        {
+            path: path.join(docsPath, '02-architecture', 'coding-standards.md'),
+            content: generateCodingStandardsMd(config),
+        },
+        {
+            path: path.join(docsPath, '03-documentation', 'README.md'),
+            content: '# Documentation\n\n*Add your documentation here*\n',
+        },
+        {
+            path: path.join(docsPath, '04-session-notes', 'README.md'),
+            content: '# Session Notes\n\n*Session notes will be auto-generated here*\n',
+        },
+    ];
+    for (const file of docsFiles) {
+        fs.writeFileSync(file.path, file.content, 'utf-8');
+        filesCreated.push(file.path);
+    }
+    // Initialize git if requested
+    if (config.initGit) {
+        initGit(projectPath);
+        initGit(docsPath);
+    }
+    return {
+        success: true,
+        projectPath,
+        docsPath,
+        filesCreated,
+    };
+}
+// =============================================================================
+// Helper Functions
+// =============================================================================
+/**
+ * Check if git user.name and user.email are configured
+ */
+export function isGitConfigured() {
+    try {
+        const name = execSync('git config --global user.name', {
+            encoding: 'utf8',
+            stdio: ['pipe', 'pipe', 'pipe'],
+        }).trim();
+        const email = execSync('git config --global user.email', {
+            encoding: 'utf8',
+            stdio: ['pipe', 'pipe', 'pipe'],
+        }).trim();
+        return Boolean(name && email);
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Initialize git repository
+ * If git config is not set, only runs git init (skips commit)
+ */
+function initGit(projectPath) {
+    try {
+        execSync('git init', { cwd: projectPath, stdio: 'ignore' });
+        execSync('git add .', { cwd: projectPath, stdio: 'ignore' });
+        if (isGitConfigured()) {
+            execSync('git commit -m "Initial commit from compilr init"', {
+                cwd: projectPath,
+                stdio: 'ignore',
+            });
+        }
+    }
+    catch {
+        // Git init failed - not critical
+    }
+}
+function generateRoadmapMd(config) {
+    return `# Roadmap - ${config.name}
+
+## Vision
+
+${config.description}
+
+---
+
+## Milestones
+
+### Milestone 1: Foundation
+- [ ] Project setup
+- [ ] Development environment
+- [ ] CI/CD pipeline
+
+### Milestone 2: Core Features
+- [ ] *Define your core features*
+
+### Milestone 3: Launch
+- [ ] Testing
+- [ ] Documentation
+- [ ] Deploy to production
+
+---
+
+## Timeline
+
+*Add your timeline here*
+
+---
+
+*Last Updated: ${new Date().toISOString().split('T')[0]}*
+`;
+}

package/dist/project-generator/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Project Generator — SDK module for creating and importing projects.
+ *
+ * Provides template generation, project scaffolding, and project detection
+ * shared by CLI and Desktop apps.
+ */
+export type { TechStack, CodingStandards, GeneratorRepoPattern, ProjectConfig, GenerationResult, CompilrConfig, DetectedProject, GitInfo, ImportProjectConfig, } from './types.js';
+export { TECH_STACK_LABELS, CODING_STANDARDS_LABELS, REPO_PATTERN_LABELS, WORKFLOW_VERSION, } from './types.js';
+export { generateProject, isGitConfigured } from './generator.js';
+export { generateCompilrMd, generateConfigJson, generateReadmeMd, generateCodingStandardsMd, generatePackageJson, generateTsconfig, generateGitignore, generateCompilrMdForImport, } from './templates/index.js';
+export { detectProjectInfo, detectGitInfo, prettifyName, getLanguageLabel, getFrameworkLabel, validateImportPath, isValidProjectName, projectExists, } from './detection.js';

package/dist/project-generator/index.js

@@ -0,0 +1,13 @@
+/**
+ * Project Generator — SDK module for creating and importing projects.
+ *
+ * Provides template generation, project scaffolding, and project detection
+ * shared by CLI and Desktop apps.
+ */
+export { TECH_STACK_LABELS, CODING_STANDARDS_LABELS, REPO_PATTERN_LABELS, WORKFLOW_VERSION, } from './types.js';
+// Generator
+export { generateProject, isGitConfigured } from './generator.js';
+// Templates (individual generators for preview/customization)
+export { generateCompilrMd, generateConfigJson, generateReadmeMd, generateCodingStandardsMd, generatePackageJson, generateTsconfig, generateGitignore, generateCompilrMdForImport, } from './templates/index.js';
+// Detection
+export { detectProjectInfo, detectGitInfo, prettifyName, getLanguageLabel, getFrameworkLabel, validateImportPath, isValidProjectName, projectExists, } from './detection.js';

package/dist/project-generator/templates/coding-standards.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Coding Standards Template Generator
+ *
+ * Generates the coding standards documentation.
+ */
+import type { ProjectConfig } from '../types.js';
+export declare function generateCodingStandardsMd(config: ProjectConfig): string;