@cbs-consulting/generator-btp 1.0.0

package/README.md

@@ -0,0 +1,105 @@
+# CAP/UI5 Foundation Generator
+
+A Yeoman generator for creating the foundation of CAP/UI5 projects with TypeScript, ESLint, Prettier, and other essential development configurations.
+
+## Features
+
+This generator sets up a solid foundation for your CAP/UI5 projects with:
+
+- ✅ **TypeScript** - Full TypeScript configuration with strict settings
+- ✅ **ESLint** - Code quality and linting rules optimized for TypeScript
+- ✅ **Prettier** - Consistent code formatting
+- ✅ **Husky** - Git hooks for pre-commit quality checks
+- ✅ **Jest** - Testing framework with TypeScript support
+- ✅ **GitHub Actions** - CI/CD pipeline for automated testing and building
+- ✅ **VS Code** - Optimized settings and recommended extensions
+- ✅ **Docker** - Container configuration for deployment (optional)
+
+## Installation
+
+First, install Yeoman and this generator globally:
+
+```bash
+npm install -g yo
+npm install -g @cbs-consulting/generator-btp
+```
+
+Or install locally in your project:
+
+```bash
+npm install --save-dev @cbs-consulting/generator-btp
+```
+
+## Usage
+
+This generator is split into two sub-generators.
+
+1. CAP flow
+
+```bash
+mkdir my-cap
+cd my-cap
+yo @cbs-consulting/btp:cap
+# read and execute the printed steps shown in the terminal
+```
+
+2. UI5 flow
+
+```bash
+mkdir my-ui5
+cd my-ui5
+# ensure you have a UI5 project skeleton (or after cds init)
+yo @cbs-consulting/btp:ui5
+# read and execute the printed steps in the terminal
+```
+
+The CAP sub-generator copies all templates from generators/app/templatesCAP into your project and merges additions from generators/app/additionsCAP into existing files. The scripting.txt is shown but not executed automatically.
+
+## Generated Project Structure
+
+```
+my-project/
+├── src/                     # Source TypeScript files
+├── tests/                   # Test files (if Jest is selected)
+├── dist/                    # Compiled output (after build)
+├── .github/workflows/       # GitHub Actions CI/CD (if selected)
+├── .vscode/                 # VS Code settings (if selected)
+├── .eslintrc.js            # ESLint configuration
+├── .prettierrc             # Prettier configuration
+├── .gitignore              # Git ignore rules
+├── tsconfig.json           # TypeScript configuration
+├── jest.config.js          # Jest configuration (if selected)
+├── package.json            # Project dependencies and scripts
+└── README.md               # Project documentation
+```
+
+## Available Scripts
+
+The generated project includes these npm scripts:
+
+- `npm run build` - Compile TypeScript to JavaScript
+- `npm run build:watch` - Watch mode compilation
+- `npm run lint` - Run ESLint on your code
+- `npm run lint:fix` - Fix auto-fixable ESLint issues
+- `npm run format` - Format code with Prettier
+- `npm run format:check` - Check if code is properly formatted
+- `npm test` - Run Jest tests (if enabled)
+- `npm run test:watch` - Run tests in watch mode
+- `npm run test:coverage` - Generate test coverage report
+
+## Development
+
+To develop this generator locally:
+
+1. Clone this repository
+2. Install dependencies: `npm install`
+3. Link the generator: `npm link`
+4. Test in a new directory: `yo @cbs-consulting/btp`
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests if applicable
+5. Submit a pull request

package/generators/app/index.js

@@ -0,0 +1,48 @@
+const Generator = require("yeoman-generator");
+const chalk = require("chalk");
+const yosay = require("yosay");
+const { resolve } = require("node:path");
+
+module.exports = class extends Generator {
+  async prompting() {
+    this.log(
+      yosay(
+        `Hey, welcome to the ${chalk.hex("e38330")("@cbs-consulting/generator-btp")}. I'm pretty sure, you will love me!`,
+      ),
+    );
+
+    const { kind } = await this.prompt([
+      {
+        type: "list",
+        name: "kind",
+        message: "What do you want to do?",
+        choices: [
+          {
+            name: "Bootstrap a new CAP project",
+            value: "cap",
+          },
+          {
+            name: "Add best practices to existing UI5 project",
+            value: "ui5",
+          },
+        ],
+      },
+    ]);
+
+    this.kind = kind;
+  }
+
+  writing() {
+    if (this.kind === "cap") {
+      this.composeWith(resolve(__dirname, "../cap/index.js"));
+    } else if (this.kind === "ui5") {
+      this.composeWith(resolve(__dirname, "../ui5/index.js"));
+    } else {
+      this.log(chalk.red("Unknown selection"));
+    }
+  }
+
+  end() {
+    this.log(chalk.green("Done."));
+  }
+};

package/generators/cap/additions/.vscode/extensions.json

@@ -0,0 +1,74 @@
+{
+  "recommendations": [
+    // GitHub Copilot
+    "GitHub.copilot-chat",
+    // JavaScript/TypeScript linting
+    "dbaeumer.vscode-eslint",
+    // Code formatting
+    "esbenp.prettier-vscode",
+    // Prettify TS errors
+    "YoavBls.pretty-ts-errors",
+    // CSV Editing
+    "janisdd.vscode-edit-csv",
+    // English spell checking
+    "streetsidesoftware.code-spell-checker",
+    // German spell checking
+    "streetsidesoftware.code-spell-checker-german",
+    // Enhanced git functionalities
+    "eamodio.gitlens",
+    // i18n tools and annotations
+    "lokalise.i18n-ally",
+    // Autocomplete path names
+    "christian-kohler.path-intellisense",
+    // XML language support
+    "redhat.vscode-xml",
+    // Markdown linting, editing and preview
+    "DavidAnson.vscode-markdownlint",
+    "yzhang.markdown-all-in-one",
+    "shd101wyy.markdown-preview-enhanced",
+
+    // easy switch between projects
+    "alefragnani.project-manager",
+    // resource monitor
+    "mutantdino.resourcemonitor",
+    // bookmark code places
+    "alefragnani.Bookmarks",
+    // structured view on ToDo. FixMe commandserrr
+    "Gruntfuggly.todo-tree",
+    // highlight columns in CSV, TSV
+    "mechatroner.rainbow-csv",
+    // useful for tempplate string
+    "meganrogge.template-string-converter",
+    // display errors inline
+    "usernamehw.errorlens",
+    //live share VS code
+    "MS-vsliveshare.vsliveshare",
+    // show package.json dependencies updates
+    "codeandstuff.package-json-upgrade",
+
+    // ====================
+    // CAP
+    // ====================
+    // SAP CDS language support
+    "SAPSE.vscode-cds",
+    // SQLite database viewer
+    "qwtel.sqlite-viewer",
+    // REST API testing
+    "humao.rest-client",
+
+    // ====================
+    // UI5 / Fiori
+    // ====================
+    // Auto Renaming e.g. XML tags
+    "formulahendry.auto-rename-tag",
+    // Multiple Fiori Tools
+    "SAPSE.sap-ux-fiori-tools-extension-pack",
+
+    // ====================
+    // Tasks
+    // ====================
+    // Better variables in tasks
+    "rioj7.command-variable"
+  ],
+  "unwantedRecommendations": []
+}

package/generators/cap/additions/.vscode/settings.json

@@ -0,0 +1,57 @@
+{
+  // ====================
+  // Editor
+  // ====================
+  "editor.formatOnSave": true,
+  "editor.formatOnPaste": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "always"
+  },
+  "editor.rulers": [80],
+  "editor.minimap.renderCharacters": false, // Small performance boost
+  "workbench.startupEditor": "none",
+
+  // Automatically update import paths when files are moved or renamed
+  "typescript.updateImportsOnFileMove.enabled": "always",
+  "javascript.updateImportsOnFileMove.enabled": "always",
+
+  // Default formatters for specific file types
+  "[cds]": {
+    "editor.defaultFormatter": "SAPSE.vscode-cds"
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "yzhang.markdown-all-in-one"
+  },
+  "[javascript][typescript][json][typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+
+  // ====================
+  // Extensions
+  // ====================
+  "extensions.ignoreRecommendations": true,
+  "github.copilot.nextEditSuggestions.enabled": true,
+  "gitlens.hovers.currentLine.over": "line",
+  "i18n-ally.displayLanguage": "de",
+  "i18n-ally.enabledFrameworks": ["ui5"],
+  "i18n-ally.keystyle": "flat",
+  "i18n-ally.localesPaths": ["i18n", "webapp/i18n"],
+  "i18n-ally.sourceLanguage": "de",
+  // Usage pattern for i18n keys in translation function t('key')
+  "i18n-ally.regex.usageMatchAppend": ["\\bt\\(['\"`]({key})['\"`]\\)"],
+
+  // ====================
+  // Scripts
+  // ====================
+  "npm.scriptRunner": "node",
+
+  // ====================
+  // Git
+  // ====================
+  "git.openRepositoryInParentFolders": "always",
+
+  // ====================
+  // Quality
+  // ====================
+  "cSpell.language": "en,de-DE"
+}

package/generators/cap/additions/package.json

@@ -0,0 +1,31 @@
+{
+  "scripts": {
+    "format": "prettier --write \"**/*.(ts|js|json|yml|yaml|xml)\"",
+    "lint": "eslint .",
+    "lint-fix": "eslint . --fix",
+    "lint-quiet": "eslint . --quiet",
+    "test": "CDS_TYPESCRIPT='true' jest",
+    "build": "rm -rf resources mta_archives dist gen && npx -p @sap/cds-dk cds build --production",
+    "deploy-dev": "npm run build && mbt build --mtar archive.mtar && cf deploy mta_archives/archive.mtar -e mta-ext/dev.mtaext --strategy blue-green --skip-testing-phase --skip-idle-start --abort-on-error",
+    "coverage-report": "npx serve coverage/lcov-report",
+    "git-config": "git config --local include.path ../.gitconfig.aliases",
+    "check-deps": "ncu",
+    "upgrade-deps": "ncu -u"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "npx lint-staged"
+  },
+  "lint-staged": {
+    "*.{ts,js,json,yml,yaml,xml}": "npm run format",
+    "*.{ts,js}": "npm run lint-fix"
+  },
+  "cds": {
+    "requires": {
+      "[test]": {
+        "auth": {
+          "kind": "dummy"
+        }
+      }
+    }
+  }
+}

package/generators/cap/dependencies.json

@@ -0,0 +1,17 @@
+{
+  "devDependencies": [
+    "cbs-tools",
+    "prettier",
+    "prettier-plugin-organize-imports",
+    "@prettier/plugin-xml",
+    "simple-git-hooks",
+    "lint-staged",
+    "eslint",
+    "typescript-eslint",
+    "eslint-config-prettier",
+    "@sap/eslint-plugin-cds@3",
+    "@cap-js/cds-test",
+    "ts-jest",
+    "npm-check-updates"
+  ]
+}

package/generators/cap/index.js

@@ -0,0 +1,194 @@
+const chalk = require("chalk");
+const glob = require("glob");
+const mergewith = require("lodash.mergewith");
+const fs = require("node:fs");
+const { join, resolve } = require("node:path");
+const Generator = require("yeoman-generator");
+const {
+  mergeArray,
+  readJsonC,
+  readJsonCSafe,
+} = require("../../utils/jsonFile");
+const globSync = glob.globSync || glob.sync;
+
+module.exports = class extends Generator {
+  _tplRoot = resolve(__dirname, "./templates");
+  _addRoot = resolve(__dirname, "./additions");
+  _capRoot = __dirname;
+
+  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 new CAP 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",
+      },
+      {
+        type: "input",
+        name: "dbSchema",
+        message: "Enter the database schema name?",
+        validate(sInput) {
+          if (sInput.length > 0) {
+            return true;
+          }
+          return "Database schema name must not be empty.";
+        },
+        default: "MY_DB_SCHEMA",
+      },
+      {
+        type: "confirm",
+        name: "useAzureDevOps",
+        message: "Is Azure DevOps used for version control and CI/CD?",
+        default: true,
+      },
+    );
+
+    const answers = await this.prompt(aPrompt);
+
+    // Check if .git directory exists, if not run git init
+    if (!fs.existsSync(this.destinationPath(".git"))) {
+      this.log(chalk.bold("\n🔧 Initializing git repository..."));
+      this.spawnCommandSync("git", ["init"]);
+    }
+    this.destinationRoot(this.destinationPath());
+
+    this.log(chalk.bold("\n🚀 Initializing CAP project..."));
+    this.spawnCommandSync(
+      "cds",
+      [
+        "init",
+        "--add",
+        "typescript,mta,xsuaa,hana,sqlite,html5-repo,tiny-sample,http",
+      ],
+      {
+        cwd: this.destinationPath(),
+      },
+    );
+
+    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 files..."));
+
+    this.sourceRoot(join(__dirname, "templates"));
+    globSync("**", {
+      cwd: this.sourceRoot(),
+      nodir: true,
+    }).forEach((fileName) => {
+      let sOrigin;
+      let sTarget;
+
+      if (fileName === "azure-pipelines.yaml" && !this.answers.useAzureDevOps) {
+        return;
+      }
+
+      sOrigin = this.templatePath(fileName);
+      sTarget = this.destinationPath(
+        fileName.replace(/^_/, "").replace(/\/_/, "/"),
+      );
+
+      this.fs.copyTpl(sOrigin, sTarget, this.answers);
+    });
+
+    // 2) 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");
+    const destPkg = readJsonCSafe(this, destPkgPath, {});
+    const addPkg = readJsonC(srcPkgPath, {});
+    const mergedPkg = mergewith({}, destPkg, addPkg, mergeArray);
+    mergedPkg.name = this.answers.projectNameNormalized;
+    this.fs.writeJSON(destPkgPath, mergedPkg);
+
+    // tsconfig.json -> ensure it extends base.tsconfig.json
+    const destTsPath = this.destinationPath("tsconfig.json");
+    const destTs = readJsonCSafe(this, destTsPath, {});
+    if (destTs.extends !== "./base.tsconfig.json") {
+      destTs.extends = "./base.tsconfig.json";
+    }
+    this.fs.writeJSON(destTsPath, destTs);
+
+    // .vscode/settings.json
+    const destVsSettingsPath = this.destinationPath(".vscode/settings.json");
+    const addVsSettingsPath = join(this._addRoot, ".vscode/settings.json");
+    const destVsSettings = readJsonCSafe(this, destVsSettingsPath, {});
+    const addVsSettings = readJsonC(addVsSettingsPath, {});
+    const mergedVsSettings = mergewith(
+      {},
+      destVsSettings,
+      addVsSettings,
+      mergeArray,
+    );
+    this.fs.writeJSON(destVsSettingsPath, mergedVsSettings);
+
+    // .vscode/extensions.json (merge arrays)
+    const destVsExtPath = this.destinationPath(".vscode/extensions.json");
+    const addVsExtPath = join(this._addRoot, ".vscode/extensions.json");
+    const destVsExt = readJsonCSafe(this, destVsExtPath, {
+      recommendations: [],
+      unwantedRecommendations: [],
+    });
+    const addVsExt = readJsonC(addVsExtPath, {
+      recommendations: [],
+      unwantedRecommendations: [],
+    });
+    const mergedVsExt = mergewith({}, destVsExt, addVsExt, mergeArray);
+    this.fs.writeJSON(destVsExtPath, mergedVsExt);
+
+    // Remove undeploy.json from db folder
+    const undeployPath = this.destinationPath("db/undeploy.json");
+    this.fs.delete(undeployPath);
+  }
+
+  install() {
+    this.log(chalk.bold("\n📦 Installing npm dependencies..."));
+    const dependenciesPath = join(this._capRoot, "dependencies.json");
+    const dependencies = readJsonCSafe(this, dependenciesPath, {});
+    const devDeps = Array.isArray(dependencies.devDependencies)
+      ? dependencies.devDependencies
+      : [];
+    if (devDeps.length > 0) {
+      this.spawnCommandSync(
+        "npm",
+        ["install", "--save-dev", "--save-exact"].concat(devDeps),
+      );
+    }
+  }
+
+  end() {
+    this.log(chalk.bold("\n🪝  Initializing simple git hooks..."));
+    this.spawnCommandSync("npx", ["simple-git-hooks"]);
+
+    this.log(chalk.bold.green("\n✅ CAP best practices applied."));
+    this.log("Next steps:");
+    this.log("1) Review/commit the changes.");
+  }
+};

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

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