@dawitworku/projectcli 0.2.1 → 0.2.2

package/README.md

@@ -19,6 +19,8 @@ We handle the complexity of calling the official CLIs for you.
 - **Preflight Checks**: Warns you if you are missing required tools (e.g. `cargo`, `go`, `node`) before you start.
 - **Remote Templates**: Clone any GitHub repository and automatically strip `.git` history for a fresh start.
 - **CI/CD & Docker**: One-click generation of GitHub Actions workflows and Dockerfiles.
+- **Dev Containers**: Generate `.devcontainer/devcontainer.json` for VS Code / Codespaces.
+- **License Generator**: Add a standard `LICENSE` file (configurable default).
 
 ## 🚀 Quick Start
 
@@ -81,6 +83,12 @@ Save your preferences (like default package manager):
 projectcli config
 ```
 
+You can set defaults like:
+
+- JS/TS package manager
+- Author name (for LICENSE)
+- Default license type (MIT/Apache2/ISC)
+
 ## 📦 Supported Generators (Partial List)
 
 | Language                  | Frameworks / Tools                                            |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dawitworku/projectcli",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "The ultimate interactive project generator (language -> framework -> create).",
   "author": "Dawit Worku",
   "repository": {
@@ -32,7 +32,7 @@
   ],
   "scripts": {
     "start": "node bin/projectcli.js",
-    "lint": "node -c bin/projectcli.js && node -c src/index.js && node -c src/registry.js && node -c src/run.js"
+    "lint": "node -c bin/projectcli.js && node -c src/index.js && node -c src/registry.js && node -c src/run.js && node -c src/settings.js && node -c src/config.js && node -c src/devcontainer.js && node -c src/license.js"
   },
   "dependencies": {
     "boxen": "^5.1.2",

package/src/devcontainer.js

@@ -0,0 +1,82 @@
+const DEVCONTAINER_NODE = `{
+  "name": "Node.js",
+  "image": "mcr.microsoft.com/devcontainers/javascript-node:20",
+  "features": {
+    "ghcr.io/devcontainers/features/node:1": {}
+  },
+  "forwardPorts": [3000],
+  "postCreateCommand": "npm install"
+}`;
+
+const DEVCONTAINER_PYTHON = `{
+  "name": "Python 3",
+  "image": "mcr.microsoft.com/devcontainers/python:3.11",
+  "features": {
+    "ghcr.io/devcontainers/features/python:1": {}
+  },
+  "postCreateCommand": "pip install -r requirements.txt"
+}`;
+
+const DEVCONTAINER_RUST = `{
+  "name": "Rust",
+  "image": "mcr.microsoft.com/devcontainers/rust:1",
+  "features": {
+    "ghcr.io/devcontainers/features/rust:1": {}
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": ["rust-lang.rust-analyzer", "tamasfe.even-better-toml"]
+    }
+  },
+  "postCreateCommand": "cargo build"
+}`;
+
+const DEVCONTAINER_GO = `{
+  "name": "Go",
+  "image": "mcr.microsoft.com/devcontainers/go:1.21",
+  "features": {
+    "ghcr.io/devcontainers/features/go:1": {}
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": ["golang.Go"]
+    }
+  },
+  "postCreateCommand": "go mod download"
+}`;
+
+function getDevContainer(language) {
+  if (language === "JavaScript" || language === "TypeScript")
+    return DEVCONTAINER_NODE;
+  if (language === "Python") return DEVCONTAINER_PYTHON;
+  if (language === "Rust") return DEVCONTAINER_RUST;
+  if (language === "Go") return DEVCONTAINER_GO;
+
+  // Generic fallback
+  return `{
+  "name": "Default",
+  "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+  "features": {
+    "ghcr.io/devcontainers/features/common-utils:2": {}
+  }
+}`;
+}
+
+function generateDevContainer(projectRoot, language) {
+  const content = getDevContainer(language);
+  return [
+    {
+      type: "mkdir",
+      path: ".devcontainer",
+    },
+    {
+      type: "writeFile",
+      path: ".devcontainer/devcontainer.json",
+      content: content,
+    },
+  ];
+}
+
+module.exports = {
+  generateDevContainer,
+};

package/src/index.js

@@ -31,6 +31,8 @@ const { runAdd } = require("./add");
 const { checkBinaries } = require("./preflight");
 const { gitClone, removeGitFolder } = require("./remote");
 const { generateCI, generateDocker } = require("./cicd");
+const { generateDevContainer } = require("./devcontainer");
+const { generateLicense, licenseTypes } = require("./license");
 const { getDescription } = require("./descriptions");
 const { detectLanguage, detectPackageManager } = require("./detect");
 const { loadConfig } = require("./config");
@@ -138,6 +140,8 @@ function parseArgs(argv) {
     pm: undefined,
     ci: false,
     docker: false,
+    devcontainer: false,
+    license: undefined,
     learning: false,
     template: undefined,
   };
@@ -156,6 +160,9 @@ function parseArgs(argv) {
     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 === "--devcontainer") out.devcontainer = true;
+    else if (a === "--license") out.license = true;
+    else if (a === "--no-license") out.license = false;
     else if (a === "--learning") out.learning = true;
     else if (a.startsWith("--template="))
       out.template = a.slice("--template=".length);
@@ -224,6 +231,9 @@ function printHelp() {
   );
   console.log("  --ci             Auto-add GitHub Actions CI");
   console.log("  --docker         Auto-add Dockerfile");
+  console.log("  --devcontainer   Auto-add VS Code Dev Container");
+  console.log("  --license        Force-add LICENSE (uses config defaults)");
+  console.log("  --no-license     Never add LICENSE");
   console.log("  --learning       Enable learning mode (shows descriptions)");
   console.log("  --template       Clone from a Git repository URL");
 }
@@ -261,6 +271,22 @@ function printStepsPreview(steps) {
   console.log("");
 }
 
+function filterExistingWriteFiles(steps, projectRoot) {
+  const kept = [];
+  const skipped = [];
+  for (const step of steps || []) {
+    if (step && step.type === "writeFile" && typeof step.path === "string") {
+      const target = path.resolve(projectRoot, step.path);
+      if (fs.existsSync(target)) {
+        skipped.push(step.path);
+        continue;
+      }
+    }
+    kept.push(step);
+  }
+  return { kept, skipped };
+}
+
 function printList() {
   for (const lang of getLanguages()) {
     console.log(`${lang}:`);
@@ -361,6 +387,8 @@ async function main(options = {}) {
             { name: "Add Library / Dependency", value: "add" },
             { name: "Add GitHub Actions CI", value: "ci" },
             { name: "Add Dockerfile", value: "docker" },
+            { name: "Add Dev Container (VS Code)", value: "devcontainer" },
+            { name: "Add License", value: "license" },
             new inquirer.Separator(),
             { name: "Start New Project Here", value: "new" },
             { name: "Exit", value: "exit" },
@@ -376,20 +404,31 @@ async function main(options = {}) {
         return;
       }
 
-      if (action === "ci" || action === "docker") {
+      if (action === "ci" || action === "docker" || action === "devcontainer") {
         const pm = detectPackageManager(process.cwd());
         let langArg = detected;
         if (detected === "JavaScript/TypeScript") langArg = "JavaScript";
         if (detected === "Java/Kotlin") langArg = "Java";
 
-        const steps =
-          action === "ci"
-            ? generateCI(process.cwd(), langArg, pm)
-            : generateDocker(process.cwd(), langArg);
+        let steps = [];
+        if (action === "ci") steps = generateCI(process.cwd(), langArg, pm);
+        else if (action === "docker")
+          steps = generateDocker(process.cwd(), langArg);
+        else steps = generateDevContainer(process.cwd(), langArg);
+
+        const { kept, skipped } = filterExistingWriteFiles(
+          steps,
+          process.cwd()
+        );
 
-        if (steps.length > 0) {
+        if (kept.length > 0) {
           console.log("\nApplying changes...");
-          await runSteps(steps, { projectRoot: process.cwd() });
+          await runSteps(kept, { projectRoot: process.cwd() });
+          if (skipped.length > 0) {
+            console.log(
+              chalk.dim(`Skipped existing files: ${skipped.join(", ")}`)
+            );
+          }
           console.log(chalk.green("Done!"));
         } else {
           console.log(
@@ -401,6 +440,40 @@ async function main(options = {}) {
         return;
       }
 
+      if (action === "license") {
+        const { type, author } = await prompt([
+          {
+            type: "list",
+            name: "type",
+            message: "Choose a license:",
+            choices: licenseTypes,
+          },
+          {
+            type: "input",
+            name: "author",
+            message: "Author Name:",
+            default: userConfig.author || "The Authors",
+          },
+        ]);
+        const steps = generateLicense(process.cwd(), type, author);
+        const { kept, skipped } = filterExistingWriteFiles(
+          steps,
+          process.cwd()
+        );
+        if (kept.length === 0) {
+          console.log(chalk.dim("Nothing to do (LICENSE already exists)."));
+          return;
+        }
+        await runSteps(kept, { projectRoot: process.cwd() });
+        if (skipped.length > 0) {
+          console.log(
+            chalk.dim(`Skipped existing files: ${skipped.join(", ")}`)
+          );
+        }
+        console.log(chalk.green("Done!"));
+        return;
+      }
+
       // If 'new', fall through to normal wizard
     }
   }
@@ -445,6 +518,17 @@ async function main(options = {}) {
     args.learning = true;
   }
 
+  const defaultLicenseType =
+    typeof userConfig.defaultLicense === "string" &&
+    licenseTypes.includes(userConfig.defaultLicense)
+      ? userConfig.defaultLicense
+      : null;
+
+  const defaultAuthor =
+    typeof userConfig.author === "string" && userConfig.author.trim()
+      ? userConfig.author.trim()
+      : "The Authors";
+
   const state = {
     template: args.template || undefined,
     language:
@@ -737,6 +821,104 @@ async function main(options = {}) {
           // Remove .git to make it a fresh project
           removeGitFolder(projectRoot);
 
+          // Optional extras after cloning
+          const detectedTemplate = detectLanguage(projectRoot);
+          const pmTemplate = detectPackageManager(projectRoot);
+
+          let langArg = detectedTemplate;
+          if (detectedTemplate === "JavaScript/TypeScript")
+            langArg = "JavaScript";
+          if (detectedTemplate === "Java/Kotlin") langArg = "Java";
+
+          let wantCi = Boolean(args.ci);
+          let wantDocker = Boolean(args.docker);
+          let wantDevContainer = Boolean(args.devcontainer);
+          let wantLicense =
+            typeof args.license === "boolean"
+              ? args.license
+              : defaultLicenseType !== null;
+
+          if (!args.yes) {
+            const licenseLabel =
+              defaultLicenseType !== null
+                ? `LICENSE (${defaultLicenseType})`
+                : "LICENSE (skip)";
+
+            const { extras } = await prompt([
+              {
+                type: "checkbox",
+                name: "extras",
+                message: "Extras to apply after clone:",
+                choices: [
+                  { name: "GitHub Actions CI", value: "ci", checked: wantCi },
+                  {
+                    name: "Dockerfile",
+                    value: "docker",
+                    checked: wantDocker,
+                  },
+                  {
+                    name: "Dev Container (VS Code)",
+                    value: "devcontainer",
+                    checked: wantDevContainer,
+                  },
+                  {
+                    name: licenseLabel,
+                    value: "license",
+                    checked: wantLicense,
+                    disabled:
+                      defaultLicenseType === null
+                        ? "Configure a default license in 'projectcli config'"
+                        : false,
+                  },
+                ],
+              },
+            ]);
+            if (extras) {
+              wantCi = extras.includes("ci");
+              wantDocker = extras.includes("docker");
+              wantDevContainer = extras.includes("devcontainer");
+              wantLicense = extras.includes("license");
+            }
+          }
+
+          const extraSteps = [];
+          if (wantCi)
+            extraSteps.push(...generateCI(projectRoot, langArg, pmTemplate));
+          if (wantDocker)
+            extraSteps.push(...generateDocker(projectRoot, langArg));
+          if (wantDevContainer) {
+            extraSteps.push(...generateDevContainer(projectRoot, langArg));
+          }
+          if (wantLicense && defaultLicenseType !== null) {
+            extraSteps.push(
+              ...generateLicense(projectRoot, defaultLicenseType, defaultAuthor)
+            );
+          }
+
+          if (wantLicense && defaultLicenseType === null) {
+            console.log(
+              chalk.dim(
+                "Skipping LICENSE (no default license configured; run 'projectcli config')."
+              )
+            );
+          }
+
+          if (extraSteps.length > 0) {
+            const { kept, skipped } = filterExistingWriteFiles(
+              extraSteps,
+              projectRoot
+            );
+            if (kept.length > 0) {
+              console.log(chalk.dim("\nApplying extras..."));
+              await runSteps(kept, { projectRoot });
+            }
+            if (skipped.length > 0) {
+              console.log(
+                chalk.dim(`Skipped existing files: ${skipped.join(", ")}`)
+              );
+            }
+          }
+
           console.log(
             chalk.green(`\nSuccess! Created project at ${projectRoot}`)
           );
@@ -921,10 +1103,15 @@ async function main(options = {}) {
         }
       }
 
-      // CI/CD & Docker
+      // CI/CD & Docker & DevContainer
       if (!args.dryRun) {
         let wantCi = args.ci;
         let wantDocker = args.docker;
+        let wantDevContainer = Boolean(args.devcontainer);
+        let wantLicense =
+          typeof args.license === "boolean"
+            ? args.license
+            : defaultLicenseType !== null;
 
         if (!args.yes) {
           const { extras } = await prompt([
@@ -935,12 +1122,31 @@ async function main(options = {}) {
               choices: [
                 { name: "GitHub Actions CI", value: "ci", checked: wantCi },
                 { name: "Dockerfile", value: "docker", checked: wantDocker },
+                {
+                  name: "Dev Container (VS Code)",
+                  value: "devcontainer",
+                  checked: wantDevContainer,
+                },
+                {
+                  name:
+                    defaultLicenseType !== null
+                      ? `LICENSE (${defaultLicenseType})`
+                      : "LICENSE (skip)",
+                  value: "license",
+                  checked: wantLicense,
+                  disabled:
+                    defaultLicenseType === null
+                      ? "Configure a default license in 'projectcli config'"
+                      : false,
+                },
               ],
             },
           ]);
           if (extras) {
             wantCi = extras.includes("ci");
             wantDocker = extras.includes("docker");
+            wantDevContainer = extras.includes("devcontainer");
+            wantLicense = extras.includes("license");
           }
         }
 
@@ -951,10 +1157,28 @@ async function main(options = {}) {
         if (wantDocker) {
           extraSteps.push(...generateDocker(projectRoot, state.language));
         }
+        if (wantDevContainer) {
+          extraSteps.push(...generateDevContainer(projectRoot, state.language));
+        }
+        if (wantLicense && defaultLicenseType !== null) {
+          extraSteps.push(
+            ...generateLicense(projectRoot, defaultLicenseType, defaultAuthor)
+          );
+        }
+
+        const { kept, skipped } = filterExistingWriteFiles(
+          extraSteps,
+          projectRoot
+        );
 
-        if (extraSteps.length > 0) {
+        if (kept.length > 0) {
           console.log("Adding extras...");
-          await runSteps(extraSteps, { projectRoot });
+          await runSteps(kept, { projectRoot });
+        }
+        if (skipped.length > 0) {
+          console.log(
+            chalk.dim(`Skipped existing files: ${skipped.join(", ")}`)
+          );
         }
       }
 

package/src/license.js

@@ -0,0 +1,80 @@
+const licenses = {
+  MIT: (year, author) => `MIT License
+
+Copyright (c) ${year} ${author}
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+`,
+  Apache2: (year, author) => `                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright ${year} ${author}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+`,
+  ISC: (year, author) => `ISC License
+
+Copyright (c) ${year}, ${author}
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+`,
+};
+
+function getLicense(type, author) {
+  const year = new Date().getFullYear();
+  const template = licenses[type] || licenses.MIT;
+  return template(year, author || "The Authors");
+}
+
+function generateLicense(projectRoot, type, author) {
+  return [
+    {
+      type: "writeFile",
+      path: "LICENSE",
+      content: getLicense(type, author),
+    },
+  ];
+}
+
+module.exports = {
+  getLicense,
+  generateLicense,
+  licenseTypes: ["MIT", "Apache2", "ISC"],
+};

package/src/settings.js

@@ -14,7 +14,7 @@ async function runConfig({ prompt }) {
       message: "Default Package Manager (for JS/TS):",
       choices: [
         { name: "None (Always ask)", value: null },
-        new inquirerSeparator(),
+        inquirerSeparator(),
         { name: "npm", value: "npm" },
         { name: "pnpm", value: "pnpm" },
         { name: "yarn", value: "yarn" },
@@ -22,6 +22,26 @@ async function runConfig({ prompt }) {
       ],
       default: config.packageManager || null,
     },
+    {
+      type: "input",
+      name: "author",
+      message: "Default Author Name (for LICENSE):",
+      default: config.author || "The Authors",
+      filter: (v) => String(v || "").trim(),
+    },
+    {
+      type: "list",
+      name: "defaultLicense",
+      message: "Default License Type:",
+      choices: [
+        { name: "None", value: null },
+        inquirerSeparator(),
+        { name: "MIT", value: "MIT" },
+        { name: "Apache-2.0", value: "Apache2" },
+        { name: "ISC", value: "ISC" },
+      ],
+      default: config.defaultLicense || "MIT",
+    },
     {
       type: "confirm",
       name: "learningMode",
@@ -37,8 +57,6 @@ async function runConfig({ prompt }) {
 // Helper for pure inquirer usage if needed,
 // though index.js passes the prompt instance.
 function inquirerSeparator() {
-  // We can't easily import inquirer.Separator here without adding dependency
-  // or passing it in. Let's just use a string for now or skip it.
   return { name: "──────────────", disabled: true };
 }