create-sprint 0.0.2 → 0.0.5

package/src/cli.ts

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+
+import { runCLI } from "./index";
+
+const args = process.argv.slice(2);
+
+if (args.includes("--help") || args.includes("-h")) {
+    console.log("\n🚀 Sprint - Quickly API Framework\n");
+    console.log("Usage: npx create-sprint [options]");
+    console.log("\nOptions:");
+    console.log("  --ts, --typescript      Create TypeScript project");
+    console.log("  --js, --javascript     Create JavaScript project");
+    console.log("  --name <name>          Project name (use '.' for current directory)");
+    console.log("  --no-install           Skip automatic dependency installation");
+    console.log("  --telemetry <type>    Telemetry: none, sentry, glitchtip, discord");
+    console.log("  --docker               Add Docker support");
+    console.log("  --yes, -y             Skip all prompts (use defaults)");
+    console.log("  --help, -h            Show this help message");
+    console.log("\nExamples:");
+    console.log("  npx create-sprint     Interactive mode");
+    console.log("  npx create-sprint -y   Create TypeScript project with defaults");
+    console.log("  npx create-sprint --ts --name my-api");
+    console.log("  npx create-sprint --js --name . --telemetry sentry --docker\n");
+    process.exit(0);
+}
+
+runCLI(args).catch(console.error);

package/src/generators.ts

@@ -0,0 +1,396 @@
+export function getTypeScriptPackageJson(name: string, telemetry: string) {
+    const deps: Record<string, string> = {
+        "sprint-es": "^0.0.24",
+        dotenv: "^17.0.0",
+    };
+
+    const devDeps: Record<string, string> = {
+        "@types/node": "^22.0.0",
+        "tsx": "^4.19.0",
+        typescript: "^5.6.0",
+        vite: "^6.0.0",
+    };
+
+    if (telemetry === "sentry" || telemetry === "glitchtip") {
+        deps["@sentry/node"] = "^8.0.0";
+    } else if (telemetry === "discord") {
+        deps["axios"] = "^1.6.0";
+    }
+
+    return {
+        name: name === "." ? "sprint-app" : name,
+        version: "0.0.1",
+        description: "Sprint API",
+        main: "dist/index.js",
+        scripts: {
+            build: "vite build",
+            start: "NODE_ENV=production node dist/index.js",
+            dev: "NODE_ENV=development tsx src/index.ts",
+        },
+        dependencies: deps,
+        devDependencies: devDeps,
+    };
+}
+
+export function getJavaScriptPackageJson(name: string, telemetry: string) {
+    const deps: Record<string, string> = {
+        "sprint-es": "^0.0.24",
+        dotenv: "^17.0.0",
+    };
+
+    if (telemetry === "sentry" || telemetry === "glitchtip") {
+        deps["@sentry/node"] = "^8.0.0";
+    } else if (telemetry === "discord") {
+        deps["axios"] = "^1.6.0";
+    }
+
+    return {
+        name: name === "." ? "sprint-app" : name,
+        version: "0.0.1",
+        description: "Sprint API",
+        main: "src/index.js",
+        type: "module",
+        scripts: {
+            start: "NODE_ENV=production node src/index.js",
+            dev: "NODE_ENV=development node --watch src/index.js",
+        },
+        dependencies: deps,
+    };
+}
+
+export function getTsConfig() {
+    return JSON.stringify({
+        compilerOptions: {
+            target: "ES2020",
+            module: "ESNext",
+            moduleResolution: "bundler",
+            lib: ["ES2020"],
+            outDir: "./dist",
+            rootDir: "./src",
+            strict: true,
+            esModuleInterop: true,
+            skipLibCheck: true,
+            forceConsistentCasingInFileNames: true,
+            resolveJsonModule: true,
+            declaration: true,
+            declarationMap: true,
+            sourceMap: true,
+            tabWidth: 4,
+        },
+        include: ["src/**/*"],
+        exclude: ["node_modules", "dist"],
+    }, null, 2);
+}
+
+export function getViteConfig() {
+    return `import { defineConfig } from "vite";
+import { resolve } from "path";
+
+export default defineConfig({
+    build: {
+        lib: {
+            entry: resolve(__dirname, "src/index.ts"),
+            formats: ["es"],
+            fileName: "index",
+        },
+        outDir: "dist",
+        rollupOptions: {
+            external: ["sprint-es", "express", "cors", "morgan", "serve-favicon", "dotenv"],
+        },
+        target: "ES2020",
+    },
+    resolve: {
+        alias: {
+            "@": resolve(__dirname, "src"),
+        },
+    },
+});
+`;
+}
+
+export function getMainFile(language: string) {
+    if (language === "typescript") {
+        return `import Sprint from "sprint-es";
+import { config } from "./sprint.config";
+import homeRouter from "./routes/home";
+
+const app = new Sprint(config);
+
+app.use(homeRouter);
+`;
+    }
+
+    return `import Sprint from "sprint-es";
+import { config } from "./sprint.config.js";
+import homeRouter from "./routes/home.js";
+
+const app = new Sprint(config);
+
+app.use(homeRouter);
+`;
+}
+
+export function getHomeRoute(language: string) {
+    if (language === "typescript") {
+        return `import { Router } from "sprint-es";
+
+const router = Router();
+
+router.get("/", (req, res) => {
+    res.json({
+        message: "Hello World",
+        status: "ok"
+    });
+});
+
+export default router;
+`;
+    }
+    return `import { Router } from "sprint-es";
+
+const router = Router();
+
+router.get("/", (req, res) => {
+    res.json({
+        message: "Hello World",
+        status: "ok"
+    });
+});
+
+export default router;
+`;
+}
+
+export function getDockerfile(language: string) {
+    if (language === "typescript") {
+        return `FROM node:20-alpine
+
+WORKDIR /app
+
+COPY package*.json ./
+
+RUN npm ci
+
+COPY . .
+
+RUN npm run build
+
+EXPOSE 3000
+
+CMD ["npm", "start"]
+`;
+    }
+    return `FROM node:20-alpine
+
+WORKDIR /app
+
+COPY package*.json ./
+
+RUN npm ci
+
+COPY . .
+
+EXPOSE 3000
+
+CMD ["npm", "start"]
+`;
+}
+
+export function getDockerCompose(language: string) {
+    return `version: "3.8"
+
+services:
+  app:
+    build: .
+    ports:
+      - "3000:3000"
+    environment:
+      - NODE_ENV=production
+      - PORT=3000
+    restart: unless-stopped
+`;
+}
+
+export function getGitignore() {
+    return `# Dependencies
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Build
+dist/
+build/
+*.tsbuildinfo
+
+# Environment
+.env.development
+.env.production
+.env.local
+.env.*.local
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Logs
+logs/
+*.log
+
+# Test
+coverage/
+
+# Temporary
+tmp/
+temp/
+`;
+}
+
+export function getDockerIgnore() {
+    return `node_modules
+npm-debug.log
+.env
+.env.*
+.git
+.gitignore
+README.md
+dist
+build
+coverage
+.vscode
+.idea
+*.log
+tmp
+temp
+`;
+}
+
+export function getSprintConfigFile(language: string, telemetry: string) {
+    if (language === "typescript") {
+        let config = `import type { SprintOptions } from "sprint-es";
+
+export const config: SprintOptions = {
+    port: process.env.PORT ? parseInt(process.env.PORT) : 3000
+};
+
+`;
+
+        if (telemetry === "sentry" || telemetry === "glitchtip") {
+            config += `import { initTelemetry } from "sprint-es/telemetry";
+
+initTelemetry({
+    provider: "${telemetry}",
+    dsn: process.env.SENTRY_DSN || "",
+    environment: process.env.NODE_ENV || "development"
+});
+`;
+        } else if (telemetry === "discord") {
+            config += `import { initTelemetry } from "sprint-es/telemetry";
+
+initTelemetry({
+    provider: "discord",
+    webhookUrl: process.env.DISCORD_WEBHOOK_URL || ""
+});
+`;
+        }
+
+        return config;
+    }
+
+    let config = `export const config = {
+    port: process.env.PORT ? parseInt(process.env.PORT) : 3000
+};
+`;
+
+    if (telemetry === "sentry" || telemetry === "glitchtip") {
+        config += `
+import { initTelemetry } from "sprint-es/telemetry";
+
+initTelemetry({
+    provider: "${telemetry}",
+    dsn: process.env.SENTRY_DSN || "",
+    environment: process.env.NODE_ENV || "development"
+});
+`;
+    } else if (telemetry === "discord") {
+        config += `
+import { initTelemetry } from "sprint-es/telemetry";
+
+initTelemetry({
+    provider: "discord",
+    webhookUrl: process.env.DISCORD_WEBHOOK_URL || ""
+});
+`;
+    }
+
+    return config;
+}
+
+export function getEnvExample(telemetry: string) {
+    let env = `PORT=3000
+
+# Development: npm run dev (NODE_ENV=development)
+# Production: npm start (NODE_ENV=production)
+`;
+
+    if (telemetry === "sentry" || telemetry === "glitchtip") {
+        env += `
+# Sentry / GlitchTip (use GlitchTip DSN for self-hosted)
+SENTRY_DSN=
+`;
+    } else if (telemetry === "discord") {
+        env += `
+# Discord Webhook URL for error notifications
+DISCORD_WEBHOOK_URL=
+`;
+    }
+
+    return env;
+}
+
+export function getEnvDevelopment(telemetry: string) {
+    let env = `NODE_ENV=development
+PORT=3000
+`;
+
+    if (telemetry === "sentry" || telemetry === "glitchtip") {
+        env += `
+# Sentry / GlitchTip
+SENTRY_DSN=
+`;
+    } else if (telemetry === "discord") {
+        env += `
+# Discord Webhook URL
+DISCORD_WEBHOOK_URL=
+`;
+    }
+
+    return env;
+}
+
+export function getEnvProduction(telemetry: string) {
+    let env = `NODE_ENV=production
+PORT=3000
+`;
+
+    if (telemetry === "sentry" || telemetry === "glitchtip") {
+        env += `
+# Sentry / GlitchTip
+SENTRY_DSN=
+`;
+    } else if (telemetry === "discord") {
+        env += `
+# Discord Webhook URL
+DISCORD_WEBHOOK_URL=
+`;
+    }
+
+    return env;
+}

package/src/index.ts

@@ -0,0 +1,252 @@
+import { execSync } from "child_process";
+import { existsSync } from "fs";
+import { mkdir, writeFile } from "fs/promises";
+import { join } from "path";
+import { input, select, confirm } from "@inquirer/prompts";
+import { validateProjectName } from "./validators";
+import { getTypeScriptPackageJson, getJavaScriptPackageJson, getTsConfig, getViteConfig, getMainFile, getHomeRoute, getDockerfile, getDockerCompose, getGitignore, getDockerIgnore, getSprintConfigFile, getEnvExample, getEnvDevelopment, getEnvProduction } from "./generators";
+
+export interface CLIOptions {
+    projectName?: string;
+    language?: "typescript" | "javascript";
+    telemetry?: "none" | "sentry" | "glitchtip" | "discord";
+    docker?: boolean;
+    skipInstall?: boolean;
+    skipPrompts?: boolean;
+}
+
+export async function runCLI(args: string[]) {
+    const options = parseArgs(args);
+
+    console.log("\n🚀 Welcome to Sprint - Quickly API Framework\n");
+
+    let projectName = options.projectName;
+    let language = options.language;
+    const telemetry = options.telemetry;
+    const useDocker = options.docker;
+
+    if (!projectName) {
+        projectName = await getProjectName();
+    }
+
+    const error = validateProjectName(projectName);
+    if (error) {
+        console.error(`\n❌ Error: ${error}\n`);
+        process.exit(1);
+    }
+
+    if (!language) {
+        language = await selectLanguage();
+    }
+
+    console.log(`\n✅ Creating Sprint project: ${projectName === "." ? "current directory" : projectName} with ${language === "typescript" ? "TypeScript" : "JavaScript"}\n`);
+
+    await createProject(projectName, language, telemetry, useDocker);
+
+    console.log("\n✅ Project created successfully!");
+
+    let installDeps = true;
+    if (options.skipInstall) {
+        installDeps = false;
+    } else if (!options.skipPrompts) {
+        installDeps = await confirm({
+            message: "Do you want to install dependencies now?",
+            default: true,
+        });
+    }
+
+    if (installDeps) {
+        console.log("\n📦 Installing dependencies...\n");
+        const targetDir = projectName === "." ? process.cwd() : join(process.cwd(), projectName);
+        try {
+            execSync("npm install", { cwd: targetDir, stdio: "inherit" });
+            console.log("\n✅ Dependencies installed successfully!");
+        } catch {
+            console.error("\n❌ Error installing dependencies. Please run 'npm install' manually.");
+        }
+    }
+
+    console.log("\n📦 Next steps:");
+    const cdCmd = projectName === "." ? "" : `cd ${projectName} && `;
+    if (!installDeps) {
+        console.log(`   ${cdCmd}npm install`);
+    }
+    console.log(`   ${cdCmd}npm run dev`);
+    console.log("\n");
+}
+
+function parseArgs(args: string[]): CLIOptions {
+    const options: CLIOptions = {};
+
+    const hasTs = args.includes("--ts") || args.includes("--typescript");
+    const hasJs = args.includes("--js") || args.includes("--javascript");
+    const hasName = args.indexOf("--name");
+    const telemetryArg = args.includes("--telemetry") ? args[args.indexOf("--telemetry") + 1] : null;
+
+    if (args.includes("--yes") || args.includes("-y")) {
+        options.skipPrompts = true;
+        options.language = "typescript";
+    } else if (hasTs) {
+        options.language = "typescript";
+    } else if (hasJs) {
+        options.language = "javascript";
+    }
+
+    if (hasName !== -1 && args[hasName + 1]) {
+        options.projectName = args[hasName + 1];
+    }
+
+    if (args.includes("--current")) {
+        options.projectName = ".";
+    }
+
+    if (args.includes("--docker")) {
+        options.docker = true;
+    }
+
+    if (args.includes("--no-install")) {
+        options.skipInstall = true;
+    }
+
+    if (telemetryArg && ["sentry", "glitchtip", "discord", "none"].includes(telemetryArg)) {
+        options.telemetry = telemetryArg as CLIOptions["telemetry"];
+    }
+
+    return options;
+}
+
+async function getProjectName(): Promise<string> {
+    const name = await input({
+        message: "Enter project name:",
+        validate: (value) => {
+            return validateProjectName(value) || true;
+        },
+    });
+
+    return name;
+}
+
+async function selectLanguage(): Promise<"typescript" | "javascript"> {
+    const language = await select({
+        message: "Select your preferred language:",
+        choices: [
+            {
+                name: "TypeScript",
+                value: "typescript",
+                description: "Recommended - Type safety and better developer experience",
+            },
+            {
+                name: "JavaScript",
+                value: "javascript",
+                description: "Vanilla JavaScript for simpler projects",
+            },
+        ],
+    });
+
+    return language as "typescript" | "javascript";
+}
+
+async function selectTelemetry(): Promise<"none" | "sentry" | "glitchtip" | "discord"> {
+    const telemetry = await select({
+        message: "Select error tracking/telemetry solution:",
+        choices: [
+            {
+                name: "None",
+                value: "none",
+                description: "No error tracking integration",
+            },
+            {
+                name: "Sentry",
+                value: "sentry",
+                description: "Full-featured error tracking (free tier available)",
+            },
+            {
+                name: "GlitchTip",
+                value: "glitchtip",
+                description: "Simple error tracking, can be self-hosted",
+            },
+            {
+                name: "Discord Webhook",
+                value: "discord",
+                description: "Send error notifications to Discord channel",
+            },
+        ],
+    });
+
+    return telemetry as "none" | "sentry" | "glitchtip" | "discord";
+}
+
+async function createProject(
+    projectName: string,
+    language: "typescript" | "javascript",
+    telemetryArg?: string,
+    useDockerArg?: boolean
+) {
+    const isCurrentDir = projectName === ".";
+    const targetDir = isCurrentDir ? process.cwd() : join(process.cwd(), projectName);
+
+    if (!isCurrentDir && existsSync(targetDir)) {
+        console.error(`Error: Directory ${projectName} already exists`);
+        process.exit(1);
+    }
+
+    if (!isCurrentDir) {
+        await mkdir(targetDir, { recursive: true });
+    }
+
+    let telemetry = telemetryArg || "none";
+    if (!telemetryArg) {
+        telemetry = await selectTelemetry();
+    }
+
+    let useDocker = useDockerArg || false;
+    if (!useDockerArg) {
+        useDocker = await confirm({
+            message: "Do you want to add Docker support?",
+            default: false,
+        });
+    }
+
+    let pkgJson;
+    if (language === "typescript") {
+        pkgJson = getTypeScriptPackageJson(projectName, telemetry);
+    } else {
+        pkgJson = getJavaScriptPackageJson(projectName, telemetry);
+    }
+
+    await writeFile(join(targetDir, "package.json"), JSON.stringify(pkgJson, null, 2));
+
+    if (language === "typescript") {
+        await writeFile(join(targetDir, "tsconfig.json"), getTsConfig());
+        await writeFile(join(targetDir, "vite.config.ts"), getViteConfig());
+        await writeFile(join(targetDir, "sprint.config.ts"), getSprintConfigFile(language, telemetry));
+    } else {
+        await writeFile(join(targetDir, "sprint.config.js"), getSprintConfigFile(language, telemetry));
+    }
+
+    const srcDir = join(targetDir, "src");
+    await mkdir(srcDir, { recursive: true });
+
+    await mkdir(join(srcDir, "middlewares"), { recursive: true });
+    await mkdir(join(srcDir, "routes"), { recursive: true });
+    await mkdir(join(srcDir, "controllers"), { recursive: true });
+
+    await writeFile(join(srcDir, "middlewares", ".gitkeep"), "");
+    await writeFile(join(srcDir, "controllers", ".gitkeep"), "");
+
+    await writeFile(join(srcDir, "app." + (language === "typescript" ? "ts" : "js")), getMainFile(language));
+
+    await writeFile(join(srcDir, "routes", "home." + (language === "typescript" ? "ts" : "js")), getHomeRoute(language));
+
+    await writeFile(join(targetDir, ".env.example"), getEnvExample(telemetry));
+    await writeFile(join(targetDir, ".env.development"), getEnvDevelopment(telemetry));
+    await writeFile(join(targetDir, ".env.production"), getEnvProduction(telemetry));
+
+    await writeFile(join(targetDir, ".gitignore"), getGitignore());
+
+    if (useDocker) {
+        await writeFile(join(targetDir, "Dockerfile"), getDockerfile(language));
+        await writeFile(join(targetDir, "docker-compose.yml"), getDockerCompose(language));
+        await writeFile(join(targetDir, ".dockerignore"), getDockerIgnore());
+    }
+}

package/src/validators.ts

@@ -0,0 +1,32 @@
+export function validateProjectName(name: string): string | null {
+    if (!name.trim()) return "Please enter a project name";
+
+    const n = name.trim();
+
+    if (n !== n.toLowerCase()) {
+        return "Project name must be lowercase";
+    }
+
+    if (n.length > 214) {
+        return "Project name must be less than 214 characters";
+    }
+
+    if (n.startsWith("-") || n.startsWith(".")) {
+        return "Project name cannot start with - or .";
+    }
+
+    if (/[~!@#$%^&*(){}[\]<>?:]/.test(n)) {
+        return "Project name cannot contain special characters (only letters, numbers, - and _)";
+    }
+
+    if (n !== encodeURIComponent(n)) {
+        return "Project name must be URL-safe";
+    }
+
+    const reserved = ["node_modules", "favicon.ico"];
+    if (reserved.includes(n.toLowerCase())) {
+        return `Cannot use "${n}" as project name`;
+    }
+
+    return null;
+}