create-lafkn 1.0.0

package/README.md

@@ -0,0 +1,85 @@
+# 🌊 Lafkn
+
+A modern serverless framework scaffolding tool for AWS CDK projects.
+
+## Installation
+
+```bash
+npm create lafkn@latest
+```
+
+Or use directly with npx:
+
+```bash
+npx create-lafkn
+```
+
+## Usage
+
+Simply run the command and follow the interactive prompts:
+
+```bash
+npm create lafkn
+```
+
+The CLI will guide you through:
+
+1. **Project name**: Choose a name for your project
+2. **Directory selection**: If your current directory matches the project name, you'll be asked if you want to use it
+3. **Service selection**: Choose which AWS services to include in your project
+4. **Dependency installation**: Optionally install dependencies with your preferred package manager
+
+## Available Services
+
+Lafkn supports the following AWS services out of the box:
+
+- **API Gateway** - RESTful API endpoints
+- **Authentication** - User authentication and authorization
+- **S3 Bucket** - Object storage
+- **DynamoDB** - NoSQL database
+- **EventBridge** - Event bus for event-driven architecture
+- **SQS Queue** - Message queuing service
+- **EventBridge Schedule** - Scheduled task execution
+- **Step Functions** - State machine workflows
+
+## Project Structure
+
+After scaffolding, your project will have the following structure:
+
+```
+my-lafkn-app/
+├── src/
+│   └── index.ts
+├── package.json
+├── tsconfig.json
+└── cdktf.json
+```
+
+The `package.json` will include only the services you selected during setup.
+
+## Development
+
+Once your project is created:
+
+```bash
+cd my-lafkn-app
+npm install  # if you didn't install during setup
+npm run build
+npm run cdktf:synth
+```
+
+## Available Scripts
+
+- `npm run build` - Compile TypeScript to JavaScript
+- `npm run cdktf:deploy` - Build and deploy your infrastructure
+- `npm run cdktf:destroy` - Destroy your infrastructure
+- `npm run cdktf:synth` - Synthesize CloudFormation templates
+- `npm run clean` - Clean build artifacts
+
+## Support
+
+For issues and questions, please open an issue on GitHub.
+
+---
+
+Built with ❤️ using [Eta](https://eta.js.org/) templates and [Inquirer](https://github.com/SBoudrias/Inquirer.js)

package/dist/index.js

@@ -0,0 +1,176 @@
+#! /usr/bin/env node
+import path from "node:path";
+import fs from "node:fs/promises";
+import { exec } from "node:child_process";
+import { promisify } from "node:util";
+import crypto from "node:crypto";
+import { fileURLToPath } from "node:url";
+import { input, checkbox, confirm, select } from "@inquirer/prompts";
+import { Eta } from "eta";
+const execPromise = promisify(exec);
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const TEMPLATE_DIR = path.join(__dirname, "../template");
+const processDirectory = async (src, dest, context) => {
+    await fs.mkdir(dest, { recursive: true });
+    const entries = await fs.readdir(src, { withFileTypes: true });
+    for (const entry of entries) {
+        const srcPath = path.join(src, entry.name);
+        const destPath = path.join(dest, entry.name);
+        if (entry.isDirectory()) {
+            await processDirectory(srcPath, destPath, context);
+        }
+        else {
+            if (entry.name.endsWith(".eta")) {
+                const content = await fs.readFile(srcPath, "utf-8");
+                const realDestPath = destPath.replace(/\.eta$/, "");
+                const eta = new Eta();
+                console.log(context);
+                const rendered = eta.renderString(content, context);
+                await fs.writeFile(realDestPath, rendered);
+            }
+            else {
+                await fs.copyFile(srcPath, destPath);
+            }
+        }
+    }
+};
+const checkDirectoryEmpty = async (dir) => {
+    try {
+        const files = await fs.readdir(dir);
+        return files.length === 0;
+    }
+    catch {
+        return true;
+    }
+};
+const main = async () => {
+    try {
+        console.log("🌊 Welcome to Lafkn 🌊");
+        const appName = await input({
+            message: "Project name:",
+            default: "my-lafkn-app",
+            validate: (value) => {
+                if (!value || value.trim().length === 0) {
+                    return "Project name cannot be empty";
+                }
+                if (!/^[a-z0-9-_]+$/i.test(value)) {
+                    return "Project name can only contain letters, numbers, hyphens and underscores";
+                }
+                return true;
+            },
+        });
+        const currentDirName = path.basename(process.cwd());
+        let useCurrentDir = false;
+        if (currentDirName === appName) {
+            useCurrentDir = await confirm({
+                message: `Current directory is already named "${appName}". Create project here?`,
+                default: true,
+            });
+        }
+        const targetDir = useCurrentDir
+            ? process.cwd()
+            : path.join(process.cwd(), appName);
+        let dirExists = false;
+        try {
+            await fs.access(targetDir);
+            dirExists = true;
+        }
+        catch {
+            dirExists = false;
+        }
+        if (!dirExists) {
+            console.log(`\n📁 Creating directory: ${targetDir}`);
+            await fs.mkdir(targetDir, { recursive: true });
+        }
+        else {
+            const isEmpty = await checkDirectoryEmpty(targetDir);
+            if (!isEmpty) {
+                const overwrite = await confirm({
+                    message: "⚠️  Directory is not empty. Continue anyway?",
+                    default: false,
+                });
+                if (!overwrite) {
+                    console.log("\n❌ Project creation cancelled");
+                    process.exit(0);
+                }
+            }
+        }
+        const services = await checkbox({
+            message: "Select services to include:",
+            choices: [
+                { name: "API Gateway", value: "api" },
+                { name: "Cognito Authentication", value: "auth" },
+                { name: "S3 Bucket", value: "bucket" },
+                { name: "DynamoDB", value: "dynamo" },
+                { name: "EventBridge Events", value: "event" },
+                { name: "SQS Queue", value: "queue" },
+                { name: "EventBridge Schedule", value: "schedule" },
+                { name: "Step Functions", value: "state-machine" },
+            ],
+        });
+        const shouldInstall = await confirm({
+            message: "Install dependencies?",
+            default: true,
+        });
+        let packageManager = "npm";
+        if (shouldInstall) {
+            packageManager = await select({
+                message: "Select package manager:",
+                choices: [
+                    { name: "npm", value: "npm" },
+                    { name: "yarn", value: "yarn" },
+                    { name: "pnpm", value: "pnpm" },
+                ],
+                default: "npm",
+            });
+        }
+        console.log(`\n🚀 Creating project in ${targetDir}...`);
+        try {
+            await fs.access(TEMPLATE_DIR);
+        }
+        catch {
+            console.error(`❌ Template directory not found at ${TEMPLATE_DIR}`);
+            process.exit(1);
+        }
+        const uuid = crypto.randomUUID();
+        await processDirectory(TEMPLATE_DIR, targetDir, {
+            appName,
+            services,
+            uuid,
+        });
+        console.log("✅ Project created successfully!");
+        if (shouldInstall) {
+            console.log(`\n📦 Installing dependencies with ${packageManager}...`);
+            const installCommand = packageManager === "yarn"
+                ? "yarn install"
+                : `${packageManager} install`;
+            try {
+                await execPromise(installCommand, { cwd: targetDir });
+                console.log("✅ Dependencies installed successfully!");
+            }
+            catch (error) {
+                console.error("❌ Failed to install dependencies:", error);
+            }
+        }
+        console.log("\n🎉 All done! Happy coding with Lafkn!\n");
+        console.log("Next steps:");
+        if (!useCurrentDir) {
+            console.log(`  cd ${appName}`);
+        }
+        if (!shouldInstall) {
+            console.log(`  ${packageManager} install`);
+        }
+        console.log(`  ${packageManager === "npm" ? "npm run" : packageManager} dev\n`);
+    }
+    catch (error) {
+        if (error instanceof Error && error.name === "ExitPromptError") {
+            console.log("\n👋 Project creation cancelled");
+            process.exit(0);
+        }
+        console.error("❌ An error occurred:", error);
+        process.exit(1);
+    }
+};
+main();
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "create-lafkn",
+  "version": "1.0.0",
+  "description": "Create a simple lafkn project",
+  "keywords": [
+    "aws",
+    "lafkn",
+    "serverless",
+    "cdk"
+  ],
+  "license": "ISC",
+  "author": "Aníbal Jorquera<ajorquera.cornejo@gmail.com>",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": "./dist/index.js",
+  "files": [
+    "lib"
+  ],
+  "dependencies": {
+    "@inquirer/prompts": "8.1.0",
+    "eta": "4.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "25.0.3",
+    "typescript": "5.9.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "release": "pnpm run build && pnpm -r publish --access public --no-git-checks"
+  }
+}