@compilr-dev/sdk 0.2.4 → 0.2.6

package/dist/project-generator/templates/readme-md.js

@@ -0,0 +1,165 @@
+/**
+ * README.md Template Generator
+ *
+ * Generates the project README with next steps.
+ */
+import { TECH_STACK_LABELS } from '../types.js';
+export function generateReadmeMd(config) {
+    const techStackSetup = getTechStackSetup(config.techStack);
+    return `# ${config.name}
+
+${config.description}
+
+---
+
+## Getting Started
+
+### Prerequisites
+
+${getPrerequisites(config.techStack)}
+
+### Installation
+
+\`\`\`bash
+cd ${config.name}
+${techStackSetup.install}
+\`\`\`
+
+### Development
+
+\`\`\`bash
+${techStackSetup.dev}
+\`\`\`
+
+---
+
+## Project Structure
+
+\`\`\`
+${config.name}/
+├── src/                   # Source code
+${config.repoPattern === 'single'
+        ? `├── .compilr/              # Workflow files (backlog, sessions, etc.)
+├── COMPILR.md             # AI assistant context`
+        : ''}
+├── package.json
+└── README.md
+\`\`\`
+${config.repoPattern === 'two-repo'
+        ? `
+**Documentation repo:** \`${config.name}-docs/\`
+`
+        : ''}
+
+---
+
+## Next Steps
+
+1. ${techStackSetup.nextSteps[0]}
+2. ${techStackSetup.nextSteps[1]}
+3. ${techStackSetup.nextSteps[2]}
+4. Start coding with \`compilr start\`
+
+---
+
+## Workflow Commands
+
+\`\`\`bash
+compilr start       # Begin coding session with context loaded
+compilr save        # Save session progress and generate notes
+compilr backlog     # View and manage tasks
+compilr resume      # Restore context after interruption
+\`\`\`
+
+---
+
+## Tech Stack
+
+**${TECH_STACK_LABELS[config.techStack]}**
+
+${techStackSetup.description}
+
+---
+
+## License
+
+*Add your license here*
+
+---
+
+*Created with [compilr](https://compilr.dev)*
+`;
+}
+function getPrerequisites(techStack) {
+    const common = '- Node.js 20+\n- npm or yarn';
+    if (techStack === 'react-python-pg') {
+        return `${common}\n- Python 3.11+\n- PostgreSQL 15+`;
+    }
+    return `${common}\n- PostgreSQL 15+ (for database)`;
+}
+function getTechStackSetup(techStack) {
+    const setups = {
+        'react-node-pg': {
+            install: 'npm install',
+            dev: 'npm run dev',
+            description: `
+| Layer | Technology |
+|-------|------------|
+| Frontend | React 18, Vite, TypeScript |
+| Backend | Node.js, Express, TypeScript |
+| Database | PostgreSQL |
+| ORM | Prisma |
+`,
+            nextSteps: [
+                'Install dependencies: `npm install`',
+                'Set up PostgreSQL and configure `.env`',
+                'Run database migrations: `npx prisma migrate dev`',
+            ],
+        },
+        'react-python-pg': {
+            install: 'npm install  # Frontend\npip install -r requirements.txt  # Backend',
+            dev: 'npm run dev     # Frontend\nuvicorn main:app --reload  # Backend',
+            description: `
+| Layer | Technology |
+|-------|------------|
+| Frontend | React 18, Vite, TypeScript |
+| Backend | Python, FastAPI |
+| Database | PostgreSQL |
+| ORM | SQLAlchemy |
+`,
+            nextSteps: [
+                'Install frontend deps: `npm install`',
+                'Install backend deps: `pip install -r requirements.txt`',
+                'Set up PostgreSQL and configure environment',
+            ],
+        },
+        'vue-node-pg': {
+            install: 'npm install',
+            dev: 'npm run dev',
+            description: `
+| Layer | Technology |
+|-------|------------|
+| Frontend | Vue 3, Vite, TypeScript |
+| Backend | Node.js, Express, TypeScript |
+| Database | PostgreSQL |
+| ORM | Prisma |
+`,
+            nextSteps: [
+                'Install dependencies: `npm install`',
+                'Set up PostgreSQL and configure `.env`',
+                'Run database migrations: `npx prisma migrate dev`',
+            ],
+        },
+        custom: {
+            install: '# Add your installation command',
+            dev: '# Add your development command',
+            description: '*Configure your tech stack*',
+            nextSteps: [
+                'Choose and set up your tech stack',
+                'Configure development environment',
+                'Update this README with your stack details',
+            ],
+        },
+    };
+    return setups[techStack] ?? setups.custom;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * TSConfig Template Generator
+ *
+ * Generates a tsconfig.json file based on coding standards.
+ */
+import type { ProjectConfig } from '../types.js';
+export declare function generateTsconfig(config: ProjectConfig): string;

package/dist/project-generator/templates/tsconfig.js

@@ -0,0 +1,61 @@
+/**
+ * TSConfig Template Generator
+ *
+ * Generates a tsconfig.json file based on coding standards.
+ */
+export function generateTsconfig(config) {
+    const tsconfig = getTsconfigTemplate(config);
+    return JSON.stringify(tsconfig, null, 2) + '\n';
+}
+function getTsconfigTemplate(config) {
+    // Base config for all presets
+    const base = {
+        compilerOptions: {
+            target: 'ES2022',
+            useDefineForClassFields: true,
+            module: 'ESNext',
+            lib: ['ES2022', 'DOM', 'DOM.Iterable'],
+            skipLibCheck: true,
+            // Bundler mode
+            moduleResolution: 'bundler',
+            allowImportingTsExtensions: true,
+            resolveJsonModule: true,
+            isolatedModules: true,
+            noEmit: true,
+            // JSX for React/Vue
+            jsx: config.techStack === 'vue-node-pg' ? 'preserve' : 'react-jsx',
+            // Common strict settings
+            esModuleInterop: true,
+            forceConsistentCasingInFileNames: true,
+        },
+        include: ['src'],
+        exclude: ['node_modules'],
+    };
+    // Apply coding standards
+    if (config.codingStandards === 'strict') {
+        return {
+            ...base,
+            compilerOptions: {
+                ...base.compilerOptions,
+                strict: true,
+                noUncheckedIndexedAccess: true,
+                noImplicitReturns: true,
+                noFallthroughCasesInSwitch: true,
+                noUnusedLocals: true,
+                noUnusedParameters: true,
+                exactOptionalPropertyTypes: true,
+            },
+        };
+    }
+    if (config.codingStandards === 'relaxed') {
+        return {
+            ...base,
+            compilerOptions: {
+                ...base.compilerOptions,
+                strict: true,
+            },
+        };
+    }
+    // Custom - minimal config
+    return base;
+}

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

@@ -0,0 +1,95 @@
+/**
+ * Project Configuration Types
+ *
+ * Shared types for project initialization templates.
+ */
+export type TechStack = 'react-node-pg' | 'react-python-pg' | 'vue-node-pg' | 'custom';
+export declare const TECH_STACK_LABELS: Record<TechStack, string>;
+export type CodingStandards = 'strict' | 'relaxed' | 'custom';
+export declare const CODING_STANDARDS_LABELS: Record<CodingStandards, string>;
+export type GeneratorRepoPattern = 'single' | 'two-repo';
+export declare const REPO_PATTERN_LABELS: Record<GeneratorRepoPattern, string>;
+export interface ProjectConfig {
+    /** Project name (lowercase, alphanumeric + hyphens) */
+    name: string;
+    /** Project description (1-2 sentences) */
+    description: string;
+    /** Repository pattern */
+    repoPattern: GeneratorRepoPattern;
+    /** Selected tech stack */
+    techStack: TechStack;
+    /** Coding standards preset */
+    codingStandards: CodingStandards;
+    /** Whether to initialize git */
+    initGit: boolean;
+}
+export interface GenerationResult {
+    success: boolean;
+    projectPath: string;
+    docsPath?: string;
+    filesCreated: string[];
+    error?: string;
+}
+export interface CompilrConfig {
+    version: string;
+    project: {
+        name: string;
+        description: string;
+        createdAt: string;
+    };
+    paths: {
+        /** Absolute path to the project/code repository */
+        project: string;
+        /** Absolute path to the docs repository (two-repo pattern only) */
+        docs: string | null;
+        /** Directory where .compilr/config.json lives (for reference) */
+        workflowRoot: string;
+    };
+    settings: {
+        repoPattern: 'single' | 'two-repo';
+        techStack: string;
+        codingStandards: string;
+    };
+    sessions: {
+        count: number;
+        lastSession: string | null;
+    };
+}
+export interface DetectedProject {
+    /** Project name from package.json or folder name */
+    name: string;
+    /** Prettified display name */
+    displayName: string;
+    /** Source of the name (package.json, go.mod, folder) */
+    nameSource: 'package.json' | 'go.mod' | 'pyproject.toml' | 'Cargo.toml' | 'folder';
+    /** Detected primary language (null if unknown) */
+    language: string | null;
+    /** Detected framework (null if not detected) */
+    framework: string | null;
+    /** Detected package manager (null if not detected) */
+    packageManager: string | null;
+    /** Whether .git directory exists */
+    hasGit: boolean;
+    /** Git remote URL (null if not configured) */
+    gitRemote: string | null;
+    /** Current git branch (null if not in git repo) */
+    gitBranch: string | null;
+    /** Whether COMPILR.md exists */
+    hasCompilrMd: boolean;
+    /** Whether CLAUDE.md exists (alternative) */
+    hasClaudeMd: boolean;
+}
+export interface GitInfo {
+    hasGit: boolean;
+    remote: string | null;
+    branch: string | null;
+}
+export interface ImportProjectConfig {
+    name: string;
+    displayName: string;
+    description?: string;
+    path: string;
+    detected: DetectedProject;
+    workflowMode: 'flexible' | 'guided';
+}
+export declare const WORKFLOW_VERSION = "1.0.0";

package/dist/project-generator/types.js

@@ -0,0 +1,24 @@
+/**
+ * Project Configuration Types
+ *
+ * Shared types for project initialization templates.
+ */
+export const TECH_STACK_LABELS = {
+    'react-node-pg': 'React + Node.js + PostgreSQL',
+    'react-python-pg': 'React + Python + PostgreSQL',
+    'vue-node-pg': 'Vue + Node.js + PostgreSQL',
+    custom: 'Custom (configure later)',
+};
+export const CODING_STANDARDS_LABELS = {
+    strict: 'TypeScript Strict (recommended)',
+    relaxed: 'TypeScript Relaxed',
+    custom: 'Custom (configure later)',
+};
+export const REPO_PATTERN_LABELS = {
+    single: 'Single repo (.compilr/ folder + COMPILR.md in project root)',
+    'two-repo': 'Two repos (project/ + project-docs/ separate repositories)',
+};
+// =============================================================================
+// Workflow Version
+// =============================================================================
+export const WORKFLOW_VERSION = '1.0.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compilr-dev/sdk",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "Universal agent runtime for building AI-powered applications",
   "type": "module",
   "main": "dist/index.js",