@compilr-dev/sdk 0.2.5 → 0.2.6

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;

package/dist/project-generator/templates/coding-standards.js

@@ -0,0 +1,299 @@
+/**
+ * Coding Standards Template Generator
+ *
+ * Generates the coding standards documentation.
+ */
+export function generateCodingStandardsMd(config) {
+    if (config.codingStandards === 'custom') {
+        return generateCustomTemplate(config);
+    }
+    return config.codingStandards === 'strict'
+        ? generateStrictTemplate(config)
+        : generateRelaxedTemplate(config);
+}
+function generateCustomTemplate(config) {
+    return `# Coding Standards - ${config.name}
+
+*Configure your coding standards here*
+
+---
+
+## TypeScript Configuration
+
+\`\`\`json
+// tsconfig.json - customize as needed
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "strict": true,  // Adjust based on preference
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  }
+}
+\`\`\`
+
+---
+
+## Linting
+
+*Add your ESLint configuration*
+
+---
+
+## Formatting
+
+*Add your Prettier configuration*
+
+---
+
+## Git Workflow
+
+*Define your branching strategy and commit conventions*
+
+---
+
+## Code Review
+
+*Define your code review process*
+
+---
+
+*Last Updated: ${new Date().toISOString().split('T')[0]}*
+`;
+}
+function generateStrictTemplate(config) {
+    return `# Coding Standards - ${config.name}
+
+**Preset:** TypeScript Strict
+
+---
+
+## TypeScript Configuration
+
+\`\`\`json
+// tsconfig.json
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "exactOptionalPropertyTypes": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  }
+}
+\`\`\`
+
+---
+
+## ESLint Configuration
+
+\`\`\`javascript
+// eslint.config.js
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.strictTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    rules: {
+      '@typescript-eslint/explicit-function-return-type': 'error',
+      '@typescript-eslint/no-explicit-any': 'error',
+      '@typescript-eslint/prefer-readonly': 'error',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        { argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+      ],
+    },
+  }
+);
+\`\`\`
+
+---
+
+## Prettier Configuration
+
+\`\`\`json
+// .prettierrc
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 100
+}
+\`\`\`
+
+---
+
+## Git Workflow
+
+### Branch Naming
+
+\`\`\`
+feat/feature-name     # New features
+fix/bug-description   # Bug fixes
+docs/update-area      # Documentation
+refactor/area         # Code refactoring
+\`\`\`
+
+### Commit Messages (Conventional Commits)
+
+\`\`\`
+feat: add user authentication
+fix: resolve login redirect issue
+docs: update API documentation
+refactor: simplify database queries
+test: add unit tests for auth module
+chore: update dependencies
+\`\`\`
+
+---
+
+## Code Review Checklist
+
+Before merging, verify:
+
+- [ ] All tests pass
+- [ ] No TypeScript errors
+- [ ] ESLint passes with no errors
+- [ ] Code follows project patterns
+- [ ] Documentation updated if needed
+- [ ] No sensitive data in commits
+
+---
+
+## File Organization
+
+\`\`\`
+src/
+├── components/      # UI components
+├── features/        # Feature modules
+├── lib/             # Shared utilities
+├── hooks/           # Custom hooks
+├── types/           # TypeScript types
+└── index.ts         # Entry point
+\`\`\`
+
+---
+
+*Last Updated: ${new Date().toISOString().split('T')[0]}*
+`;
+}
+function generateRelaxedTemplate(config) {
+    return `# Coding Standards - ${config.name}
+
+**Preset:** TypeScript Relaxed
+
+---
+
+## TypeScript Configuration
+
+\`\`\`json
+// tsconfig.json
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "sourceMap": true
+  }
+}
+\`\`\`
+
+---
+
+## ESLint Configuration
+
+\`\`\`javascript
+// eslint.config.js
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    rules: {
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        { argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+      ],
+      '@typescript-eslint/no-explicit-any': 'warn',
+    },
+  }
+);
+\`\`\`
+
+---
+
+## Prettier Configuration
+
+\`\`\`json
+// .prettierrc
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 100
+}
+\`\`\`
+
+---
+
+## Git Workflow
+
+### Commit Messages
+
+Use descriptive commit messages. Conventional commits encouraged but not required:
+
+\`\`\`
+feat: add user authentication
+fix: resolve login redirect issue
+Update README
+\`\`\`
+
+---
+
+## Code Review
+
+- Tests should pass before merging
+- No TypeScript errors
+- Code should be readable
+
+---
+
+*Last Updated: ${new Date().toISOString().split('T')[0]}*
+`;
+}

package/dist/project-generator/templates/compilr-md-import.d.ts

@@ -0,0 +1,8 @@
+/**
+ * COMPILR.md Template Generator for Imported Projects
+ *
+ * Generates the AI assistant context file for existing projects that are being imported.
+ * Different from the new project template - acknowledges existing codebase structure.
+ */
+import type { ImportProjectConfig } from '../types.js';
+export declare function generateCompilrMdForImport(config: ImportProjectConfig): string;