@cbs-consulting/generator-btp 1.0.3 → 1.1.0

package/generators/app/index.js

@@ -25,6 +25,10 @@ module.exports = class extends Generator {
             name: "Add best practices to existing UI5 project",
             value: "ui5",
           },
+          {
+            name: "Add devcontainer configuration",
+            value: "devcontainer",
+          },
         ],
       },
     ]);
@@ -37,6 +41,8 @@ module.exports = class extends Generator {
       this.composeWith(resolve(__dirname, "../cap/index.js"));
     } else if (this.kind === "ui5") {
       this.composeWith(resolve(__dirname, "../ui5/index.js"));
+    } else if (this.kind === "devcontainer") {
+      this.composeWith(resolve(__dirname, "../devcontainer/index.js"));
     } else {
       this.log(chalk.red("Unknown selection"));
     }

package/generators/cap/index.js

@@ -98,6 +98,7 @@ module.exports = class extends Generator {
   writing() {
     this.log(chalk.bold("\n✍️  Writing files..."));
 
+    // 1) Copy CAP-specific templates (excluding devcontainer)
     this.sourceRoot(join(__dirname, "templates"));
     globSync("**", {
       cwd: this.sourceRoot(),
@@ -106,6 +107,11 @@ module.exports = class extends Generator {
       let sOrigin;
       let sTarget;
 
+      // Skip devcontainer files - they come from the devcontainer generator
+      if (fileName.startsWith("_.devcontainer/")) {
+        return;
+      }
+
       if (fileName === "azure-pipelines.yaml" && !this.answers.useAzureDevOps) {
         return;
       }
@@ -118,7 +124,25 @@ module.exports = class extends Generator {
       this.fs.copyTpl(sOrigin, sTarget, this.answers);
     });
 
-    // 2) Merge additions into existing files (scripting.txt is excluded by design)
+    // 2) Copy devcontainer files from the devcontainer generator
+    const devcontainerTemplatesPath = resolve(
+      __dirname,
+      "../devcontainer/templates",
+    );
+    this.sourceRoot(devcontainerTemplatesPath);
+    globSync("**", {
+      cwd: this.sourceRoot(),
+      nodir: true,
+    }).forEach((fileName) => {
+      const sOrigin = join(devcontainerTemplatesPath, fileName);
+      const sTarget = this.destinationPath(
+        fileName.replace(/^_/, "").replace(/\/_/, "/"),
+      );
+
+      this.fs.copyTpl(sOrigin, sTarget, this.answers);
+    });
+
+    // 3) Merge additions into existing files (scripting.txt is excluded by design)
     // package.json
     const destPkgPath = this.destinationPath("package.json");
     const srcPkgPath = join(this._addRoot, "package.json");

package/generators/devcontainer/index.js

@@ -0,0 +1,78 @@
+const chalk = require("chalk");
+const glob = require("glob");
+const fs = require("node:fs");
+const { join, resolve } = require("node:path");
+const Generator = require("yeoman-generator");
+const globSync = glob.globSync || glob.sync;
+
+module.exports = class extends Generator {
+  _tplRoot = resolve(__dirname, "./templates");
+
+  async initializing() {
+    const aPrompt = [];
+
+    aPrompt.push(
+      {
+        type: "input",
+        name: "projectName",
+        message: "Enter the project name:",
+        validate(sInput) {
+          if (sInput.length > 0) {
+            return true;
+          }
+          return "Project name must not be empty.";
+        },
+        default: "My Project",
+      },
+      {
+        type: "input",
+        name: "customerName",
+        message: "Enter the customer's name:",
+        validate(sInput) {
+          if (sInput.length > 0) {
+            return true;
+          }
+          return "Customer name must not be empty.";
+        },
+        default: "My Customer",
+      },
+    );
+
+    const answers = await this.prompt(aPrompt);
+
+    answers.projectNameNormalized = answers.projectName
+      .toLowerCase()
+      .replace(/\s+/g, "-");
+    answers.customerNameNormalized = answers.customerName
+      .toLowerCase()
+      .replace(/\s+/g, "-");
+    this.answers = answers;
+  }
+
+  writing() {
+    this.log(chalk.bold("\n✍️  Writing .devcontainer files..."));
+
+    this.sourceRoot(join(__dirname, "templates"));
+    globSync("**", {
+      cwd: this.sourceRoot(),
+      nodir: true,
+    }).forEach((fileName) => {
+      let sOrigin;
+      let sTarget;
+
+      sOrigin = this.templatePath(fileName);
+      sTarget = this.destinationPath(
+        fileName.replace(/^_/, "").replace(/\/_/, "/"),
+      );
+
+      this.fs.copyTpl(sOrigin, sTarget, this.answers);
+    });
+  }
+
+  end() {
+    this.log(chalk.bold.green("\n✅ Dev container configuration added."));
+    this.log("Next steps:");
+    this.log("1) Review the .devcontainer folder.");
+    this.log("2) Customize the Dockerfile and devcontainer.json as needed.");
+  }
+};

package/generators/devcontainer/templates/_.devcontainer/Dockerfile

@@ -0,0 +1 @@
+FROM cbsgroupdocker/cbs-default:latest

package/generators/{cap → devcontainer}/templates/_.devcontainer/devcontainer.json

@@ -1,6 +1,6 @@
 {
   // Container configuration name - identifies this dev container setup
-    "name": "<%= customerName %> - <%= projectName %>",
+  "name": "<%= customerName %> - <%= projectName %>",
 
   // Build configuration - specifies how to build the container
   "build": {
@@ -9,7 +9,9 @@
   },
 
   // Name docker container
-  "runArgs": ["--name=<%= customerNameNormalized %>.<%= projectNameNormalized %>"],
+  "runArgs": [
+    "--name=<%= customerNameNormalized %>.<%= projectNameNormalized %>"
+  ],
 
   // Post-create command to set up npm authentication and install dependencies
   "postCreateCommand": "bash .devcontainer/post-create.sh",
@@ -21,7 +23,7 @@
       // Extensions automatically installed in the container
       // These are isolated from your local VS Code installation
       "extensions": [
-         // ====================
+        // ====================
         // General
         // ====================
         // GitHub Copilot
@@ -65,12 +67,11 @@
         "meganrogge.template-string-converter",
         // display errors inline
         "usernamehw.errorlens",
-        //live share VS code 
+        //live share VS code
         "MS-vsliveshare.vsliveshare",
         // show package.json dependencies updates
         "codeandstuff.package-json-upgrade",
 
-
         // ====================
         // CAP
         // ====================
@@ -154,7 +155,7 @@
         // ====================
         "cSpell.language": "en,de-DE"
       },
-      
+
       // MCP server configurations
       "mcp": {
         "servers": {

package/generators/{cap → devcontainer}/templates/_.devcontainer/post-create.sh

@@ -18,4 +18,4 @@ echo "✓ Azure extensions installed successfully!"
 # Update global npm packages
 echo "Updating global npm packages... (this can take a few minutes)"
 sudo npm update -g
-echo "✓ Global npm packages updated successfully!"
+echo "✓ Global npm packages updated successfully!"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cbs-consulting/generator-btp",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Yeoman generator for bootstrapping CAP/UI5 projects with TypeScript, ESLint, and other essential configurations",
   "main": "generators/app/index.js",
   "scripts": {

package/generators/cap/templates/_.devcontainer/Dockerfile

@@ -1 +0,0 @@
-FROM cbsgroupdocker/cbs-default:latest