@dawitworku/projectcli 0.1.3 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dawitworku/projectcli",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Interactive project generator (language -> framework -> create).",
   "license": "MIT",
   "type": "commonjs",

package/src/cicd.js

@@ -0,0 +1,169 @@
+const fs = require("node:fs");
+const path = require("node:path");
+
+const GITHUB_ACTIONS_JS = `name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test --if-present
+`;
+
+const GITHUB_ACTIONS_PY = `name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+      - run: pip install -r requirements.txt
+`;
+
+const GITHUB_ACTIONS_RUST = `name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo build --verbose
+      - run: cargo test --verbose
+`;
+
+const GITHUB_ACTIONS_GO = `name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: '1.21'
+      - run: go build -v ./...
+      - run: go test -v ./...
+`;
+
+function getGitHubAction(language, pm) {
+  if (language === "JavaScript" || language === "TypeScript")
+    return GITHUB_ACTIONS_JS;
+  if (language === "Python") return GITHUB_ACTIONS_PY;
+  if (language === "Rust") return GITHUB_ACTIONS_RUST;
+  if (language === "Go") return GITHUB_ACTIONS_GO;
+  // Default generic
+  return `name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: echo "Add build steps here"
+`;
+}
+
+const DOCKERFILE_JS = `FROM node:20-alpine AS base
+
+FROM base AS deps
+WORKDIR /app
+COPY package.json ./
+RUN npm install
+
+FROM base AS runner
+WORKDIR /app
+COPY --from=deps /app/node_modules ./node_modules
+COPY . .
+# RUN npm run build
+CMD ["node", "index.js"]
+`;
+
+const DOCKERFILE_PY = `FROM python:3.11-slim
+WORKDIR /app
+COPY requirements.txt .
+RUN pip install -r requirements.txt
+COPY . .
+CMD ["python", "app.py"]
+`;
+
+const DOCKERFILE_GO = `FROM golang:1.21-alpine AS builder
+WORKDIR /app
+COPY . .
+RUN go build -o myapp main.go
+
+FROM alpine:latest
+WORKDIR /app
+COPY --from=builder /app/myapp .
+CMD ["./myapp"]
+`;
+
+const DOCKERFILE_RUST = `FROM rust:1.75 as builder
+WORKDIR /usr/src/myapp
+COPY . .
+RUN cargo install --path .
+
+FROM debian:buster-slim
+COPY --from=builder /usr/local/cargo/bin/myapp /usr/local/bin/myapp
+CMD ["myapp"]
+`;
+
+function getDockerfile(language) {
+  if (language === "JavaScript" || language === "TypeScript")
+    return DOCKERFILE_JS;
+  if (language === "Python") return DOCKERFILE_PY;
+  if (language === "Go") return DOCKERFILE_GO;
+  if (language === "Rust") return DOCKERFILE_RUST;
+  return `# Dockerfile
+FROM ubuntu:latest
+WORKDIR /app
+COPY . .
+CMD ["echo", "Start..."]
+`;
+}
+
+function generateCI(projectRoot, language, pm) {
+  const steps = [];
+
+  // GitHub Actions
+  const ghContent = getGitHubAction(language, pm);
+  steps.push({
+    type: "writeFile",
+    path: ".github/workflows/ci.yml",
+    content: ghContent,
+  });
+
+  return steps;
+}
+
+function generateDocker(projectRoot, language) {
+  const content = getDockerfile(language);
+  return [
+    {
+      type: "writeFile",
+      path: "Dockerfile",
+      content: content,
+    },
+    {
+      type: "writeFile",
+      path: ".dockerignore",
+      content: "node_modules\ntarget\n.venv\n.git\n",
+    },
+  ];
+}
+
+module.exports = {
+  generateCI,
+  generateDocker,
+};

package/src/descriptions.js

@@ -0,0 +1,45 @@
+const DESCRIPTIONS = {
+  // JavaScript
+  "js.vite.vanilla":
+    "Native ESM-based build tool. Best for: fast prototyping, zero-framework learning.",
+  "js.vite.react":
+    "Most popular UI library. Best for: interactive UIs, large ecosystem, jobs.",
+  "js.vite.vue":
+    "Progressive framework. Best for: easy learning curve, clean template syntax.",
+  "js.vite.svelte":
+    "Compiler-based framework. Best for: performance, less boilerplate, true reactivity.",
+  "js.nextjs":
+    "The React Framework for the Web. Best for: SEO, SSR/SSG, full-stack apps.",
+  "js.astro":
+    "Content-focused site builder. Best for: blogs, documentation, portfolios (ships less JS).",
+  "js.express":
+    "Minimalist web framework for Node.js. Best for: REST APIs, learning backend basics.",
+  "js.nestjs":
+    "Angular-style backend framework. Best for: enterprise, scalable architecture, TypeScript.",
+
+  // Python
+  "py.django":
+    "Batteries-included web framework. Best for: rapid dev, CMS, huge ecosystem.",
+  "py.flask.basic":
+    "Microframework. Best for: simple services, learning, flexibility.",
+  "py.fastapi.basic":
+    "Modern, fast (high-performance). Best for: APIs with auto-docs (Swagger), async support.",
+
+  // Rust
+  "rs.cargo.bin":
+    "Standard Rust binary. Best for: CLI tools, backend services, learning Rust.",
+  "rs.tauri":
+    "Build smaller, faster, and more secure desktop applications with a web frontend.",
+
+  // Go
+  "go.module.basic":
+    "Go's dependency management system. Best for: microservices, high concurrency.",
+};
+
+function getDescription(id) {
+  return DESCRIPTIONS[id] || "No description available.";
+}
+
+module.exports = {
+  getDescription,
+};

package/src/index.js

@@ -28,6 +28,8 @@ try {
 const { getLanguages, getFrameworks, getGenerator } = require("./registry");
 const { runSteps } = require("./run");
 const { runAdd } = require("./add");
+const { generateCI, generateDocker } = require("./cicd");
+const { getDescription } = require("./descriptions");
 
 const RUST_KEYWORDS = new Set(
   [
@@ -129,6 +131,9 @@ function parseArgs(argv) {
     framework: undefined,
     name: undefined,
     pm: undefined,
+    ci: false,
+    docker: false,
+    learning: false,
   };
 
   const nextValue = (i) => {
@@ -143,6 +148,9 @@ function parseArgs(argv) {
     else if (a === "--list") out.list = true;
     else if (a === "--yes" || a === "-y") out.yes = true;
     else if (a === "--dry-run") out.dryRun = true;
+    else if (a === "--ci") out.ci = true;
+    else if (a === "--docker") out.docker = true;
+    else if (a === "--learning") out.learning = true;
     else if (a.startsWith("--language="))
       out.language = a.slice("--language=".length);
     else if (a === "--language") {
@@ -202,6 +210,9 @@ function printHelp() {
   console.log(
     "  --pm             Package manager for JS/TS (npm|pnpm|yarn|bun)"
   );
+  console.log("  --ci             Auto-add GitHub Actions CI");
+  console.log("  --docker         Auto-add Dockerfile");
+  console.log("  --learning       Enable learning mode (shows descriptions)");
 }
 
 const BACK = "__back__";
@@ -247,6 +258,18 @@ function printList() {
   }
 }
 
+function showBanner() {
+  console.log("");
+  console.log(
+    gradient.pastel.multiline(
+      figlet.textSync("ProjectCLI", { font: "Standard" })
+    )
+  );
+  console.log(chalk.bold.magenta("  The Swiss Army Knife for Developers"));
+  console.log(chalk.dim("  v" + readPackageVersion()));
+  console.log("");
+}
+
 async function main(options = {}) {
   if (!prompt) {
     throw new Error(
@@ -257,7 +280,19 @@ async function main(options = {}) {
   const argv = options.argv || [];
   const { cmd, rest } = splitCommand(argv);
   const args = parseArgs(rest);
+
+  if (
+    !args.list &&
+    !args.version &&
+    !args.help &&
+    rest.length === 0 &&
+    cmd === "init"
+  ) {
+    showBanner();
+  }
+
   if (args.help) {
+    showBanner();
     printHelp();
     return;
   }
@@ -526,6 +561,20 @@ async function main(options = {}) {
         `Framework: ${state.framework}`,
       ];
       if (state.pm) summaryLines.push(`Package manager: ${state.pm}`);
+
+      if (args.learning) {
+        const desc = getDescription(generator.id);
+        console.log(
+          chalk.cyan(
+            boxen(desc, {
+              padding: 1,
+              title: `About ${state.framework}`,
+              borderStyle: "round",
+            })
+          )
+        );
+      }
+
       console.log("\n" + summaryLines.join("\n") + "\n");
 
       if (targetExists && args.dryRun) {
@@ -623,6 +672,83 @@ async function main(options = {}) {
         continue;
       }
 
+      // Git init
+      if (!args.dryRun) {
+        let doGit = args.yes;
+        if (!doGit) {
+          const { git } = await prompt([
+            {
+              type: "confirm",
+              name: "git",
+              message: "Initialize a new git repository?",
+              default: true,
+            },
+          ]);
+          doGit = git;
+        }
+
+        if (doGit) {
+          try {
+            await runSteps(
+              [
+                { program: "git", args: ["init"], cwdFromProjectRoot: true },
+                {
+                  program: "git",
+                  args: ["add", "."],
+                  cwdFromProjectRoot: true,
+                },
+                {
+                  program: "git",
+                  args: ["commit", "-m", "Initial commit"],
+                  cwdFromProjectRoot: true,
+                },
+              ],
+              { projectRoot }
+            );
+            console.log("Initialized git repository.");
+          } catch (e) {
+            console.warn("Git init failed (is git installed?):", e.message);
+          }
+        }
+      }
+
+      // CI/CD & Docker
+      if (!args.dryRun) {
+        let wantCi = args.ci;
+        let wantDocker = args.docker;
+
+        if (!args.yes) {
+          const { extras } = await prompt([
+            {
+              type: "checkbox",
+              name: "extras",
+              message: "Extras:",
+              choices: [
+                { name: "GitHub Actions CI", value: "ci", checked: wantCi },
+                { name: "Dockerfile", value: "docker", checked: wantDocker },
+              ],
+            },
+          ]);
+          if (extras) {
+            wantCi = extras.includes("ci");
+            wantDocker = extras.includes("docker");
+          }
+        }
+
+        const extraSteps = [];
+        if (wantCi) {
+          extraSteps.push(...generateCI(projectRoot, state.language, state.pm));
+        }
+        if (wantDocker) {
+          extraSteps.push(...generateDocker(projectRoot, state.language));
+        }
+
+        if (extraSteps.length > 0) {
+          console.log("Adding extras...");
+          await runSteps(extraSteps, { projectRoot });
+        }
+      }
+
       console.log(`\nDone. Created project in: ${projectRoot}`);
       return;
     }

package/src/libraries.js

@@ -137,11 +137,60 @@ const GO = {
   ],
 };
 
+const PHP = {
+  "Web Frameworks": [
+    { label: "Laravel", packages: ["laravel/framework"] },
+    { label: "Symfony", packages: ["symfony/symfony"] },
+    { label: "Slim", packages: ["slim/slim"] },
+  ],
+  Testing: [
+    { label: "PHPUnit", packages: [], packagesDev: ["phpunit/phpunit"] },
+    { label: "Pest", packages: [], packagesDev: ["pestphp/pest"] },
+  ],
+  Tools: [
+    {
+      label: "PHPStudio (CS Fixer)",
+      packages: [],
+      packagesDev: ["friendsofphp/php-cs-fixer"],
+    },
+    { label: "Monolog", packages: ["monolog/monolog"] },
+  ],
+};
+
+const RUBY = {
+  Web: [
+    { label: "Rails", packages: ["rails"] },
+    { label: "Sinatra", packages: ["sinatra"] },
+  ],
+  Testing: [{ label: "RSpec", packages: ["rspec"] }],
+  Tools: [{ label: "Rubocop", packages: ["rubocop"] }],
+};
+
+const DART = {
+  "Web/App": [{ label: "Shelf (Server)", packages: ["shelf", "shelf_router"] }],
+  State: [
+    { label: "Provider", packages: ["provider"] },
+    { label: "Riverpod", packages: ["flutter_riverpod"] },
+    { label: "Bloc", packages: ["flutter_bloc"] },
+  ],
+  Utils: [
+    { label: "Dio (HTTP)", packages: ["dio"] },
+    {
+      label: "Freezed",
+      packages: ["freezed_annotation"],
+      packagesDev: ["build_runner", "freezed"],
+    },
+  ],
+};
+
 function getCatalog(language) {
   if (language === "JavaScript/TypeScript") return JS_TS;
   if (language === "Python") return PY;
   if (language === "Rust") return RUST;
   if (language === "Go") return GO;
+  if (language === "PHP") return PHP;
+  if (language === "Ruby") return RUBY;
+  if (language === "Dart") return DART;
   return {};
 }
 

package/src/pm.js

@@ -50,6 +50,33 @@ function pmAddCommand(pm, packages, { dev = false } = {}) {
     return { program: "go", args: ["get", ...pkgs] };
   }
 
+  // PHP
+  if (pm === "composer") {
+    return {
+      program: "composer",
+      args: ["require", ...(dev ? ["--dev"] : []), ...pkgs],
+    };
+  }
+
+  // Ruby
+  if (pm === "bundle") {
+    // bundle add pkg
+    // dev dependencies often go to "development" or "test" group, but let's just do default add for now
+    // or standard "bundle add generic"
+    return {
+      program: "bundle",
+      args: ["add", ...pkgs, ...(dev ? ["--group", "development,test"] : [])],
+    };
+  }
+
+  // Dart
+  if (pm === "dart") {
+    return {
+      program: "dart",
+      args: ["pub", "add", ...(dev ? ["--dev"] : []), ...pkgs],
+    };
+  }
+
   return { program: "npm", args: ["install", ...(dev ? ["-D"] : []), ...pkgs] };
 }
 
@@ -58,7 +85,7 @@ function pmExecCommand(pm, pkg, pkgArgs) {
 
   if (pm === "pnpm") return { program: "pnpm", args: ["dlx", pkg, ...args] };
   if (pm === "yarn") return { program: "yarn", args: ["dlx", pkg, ...args] };
-  if (pm === "bun") return { program: "bunx", args: [pkg, ...args] };
+  if (pm === "bun") return { program: "bun", args: ["x", pkg, ...args] };
   if (pm === "mvn")
     return { program: "mvn", args: ["archetype:generate", ...args] };
   if (pm === "gradle") return { program: "gradle", args: ["init", ...args] };

package/src/registry.js

@@ -429,17 +429,17 @@ const REGISTRY = {
           type: "writeFile",
           path: "app.py",
           content:
-            "from flask import Flask\n\napp = Flask(__name__)\n\n@app.get('/')\ndef hello():\n    return {'status': 'ok'}\n\nif __name__ == '__main__':\n    app.run(debug=True)\n",
+            "from flask import Flask\\n\\napp = Flask(__name__)\\n\\n@app.get('/')\\ndef hello():\\n    return {'status': 'ok'}\\n\\nif __name__ == '__main__':\\n    app.run(debug=True)\\n",
         },
         {
           type: "writeFile",
           path: "requirements.txt",
-          content: "flask\n",
+          content: "flask\\n",
         },
         {
           type: "writeFile",
           path: ".gitignore",
-          content: ".venv\n__pycache__\n*.pyc\n.DS_Store\n",
+          content: ".venv\\n__pycache__\\n*.pyc\\n.DS_Store\\n",
         },
       ],
       notes: "Writes app.py + requirements.txt (no pip install).",
@@ -453,23 +453,23 @@ const REGISTRY = {
           type: "writeFile",
           path: "main.py",
           content:
-            "from fastapi import FastAPI\n\napp = FastAPI()\n\n@app.get('/')\ndef root():\n    return {'status': 'ok'}\n",
+            "from fastapi import FastAPI\\n\\napp = FastAPI()\\n\\n@app.get('/')\\ndef root():\\n    return {'status': 'ok'}\\n",
         },
         {
           type: "writeFile",
           path: "requirements.txt",
-          content: "fastapi\nuvicorn\n",
+          content: "fastapi\\nuvicorn\\n",
         },
         {
           type: "writeFile",
           path: "README.md",
           content:
-            "# FastAPI app\n\nRun:\n\n- python -m venv .venv\n- . .venv/bin/activate\n- pip install -r requirements.txt\n- uvicorn main:app --reload\n",
+            "# FastAPI app\\n\\nRun:\\n\\n- python -m venv .venv\\n- . .venv/bin/activate\\n- pip install -r requirements.txt\\n- uvicorn main:app --reload\\n",
         },
         {
           type: "writeFile",
           path: ".gitignore",
-          content: ".venv\n__pycache__\n*.pyc\n.DS_Store\n",
+          content: ".venv\\n__pycache__\\n*.pyc\\n.DS_Store\\n",
         },
       ],
       notes: "Writes files only (no pip install).",
@@ -480,18 +480,17 @@ const REGISTRY = {
       commands: (ctx) => {
         const projectName = getProjectName(ctx);
         return [
-          // Pyramid cookiecutter is common, but basic scaffold:
           { type: "mkdir", path: "." },
           {
             type: "writeFile",
             path: "requirements.txt",
-            content: "pyramid\nwaitress\n",
+            content: "pyramid\\nwaitress\\n",
           },
           {
             type: "writeFile",
             path: "app.py",
             content:
-              "from wsgiref.simple_server import make_server\nfrom pyramid.config import Configurator\nfrom pyramid.response import Response\n\ndef hello_world(request):\n    return Response('Hello World!')\n\nif __name__ == '__main__':\n    with Configurator() as config:\n        config.add_route('hello', '/')\n        config.add_view(hello_world, route_name='hello')\n        app = config.make_wsgi_app()\n    server = make_server('0.0.0.0', 6543, app)\n    server.serve_forever()\n",
+              "from wsgiref.simple_server import make_server\\nfrom pyramid.config import Configurator\\nfrom pyramid.response import Response\\n\\ndef hello_world(request):\\n    return Response('Hello World!')\\n\\nif __name__ == '__main__':\\n    with Configurator() as config:\\n        config.add_route('hello', '/')\\n        config.add_view(hello_world, route_name='hello')\\n        app = config.make_wsgi_app()\\n    server = make_server('0.0.0.0', 6543, app)\\n    server.serve_forever()\\n",
           },
         ];
       },
@@ -534,8 +533,6 @@ const REGISTRY = {
       commands: (ctx) => {
         const projectName = getProjectName(ctx);
         const pm = getPackageManager(ctx); // usually npm for tauri frontend
-        // Using create-tauri-app via pmExec
-        // cargo create-tauri-app is also an option but node way is common if JS frontend
         return [pmExec(pm, "create-tauri-app@latest", [projectName])];
       },
       notes: "Cross-platform desktop app",
@@ -551,8 +548,6 @@ const REGISTRY = {
             args: ["init", "--name", projectName],
             cwdFromProjectRoot: true,
           },
-          // In reality, one would use cargo-leptos or a template.
-          // Just a stub for now.
         ];
       },
       notes: "Init basic Rust project (Leptos needs template usually)",
@@ -591,7 +586,7 @@ const REGISTRY = {
             type: "writeFile",
             path: "main.go",
             content:
-              'package main\n\nimport "fmt"\n\nfunc main() {\n    fmt.Println("hello")\n}\n',
+              'package main\\n\\nimport "fmt"\\n\\nfunc main() {\\n    fmt.Println("hello")\\n}\\n',
           },
         ];
       },
@@ -783,8 +778,6 @@ int main() {
       id: "java.springboot.maven",
       label: "Spring Boot (Maven)",
       commands: (ctx) => {
-        // Simple archetype or just hints. Spring Init is complex.
-        // Let's use maven quickstart for now as basic.
         const projectName = getProjectName(ctx);
         return [
           {
@@ -819,11 +812,8 @@ int main() {
               "--project-name",
               projectName,
             ],
-            cwd: projectName, // This property needs to be supported in runSteps, handled via chdir logic usually?
-            // current runSteps implementation supports cwdFromProjectRoot but not arbitrary cwd change easily maybe?
-            // runSteps implementation check:
-            // It uses `cwdFromProjectRoot` or defaults to current process.cwd().
-            // Better to just run gradle init inside the folder.
+            cwd: projectName,
+            cwdFromProjectRoot: true,
           },
         ];
       },