Merge remote-tracking branch 'origin/main' into hana-tms

Author: ecklie

.github/eslint-plugin/index.js

@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+
+// eslint plugin rule utility
+// ============================
+// node index.js generate-menu
+// generates the _menu.md file to make sure all rules are included.
+// node index.js generate-js-stub <rule-name>
+// generates a stub markdown file for a new JS rule with name <rule-name>.
+
+import * as fs from 'node:fs'
+import * as path from 'node:path'
+
+const RULES_BASE_PATH = path.join('tools', 'cds-lint', 'rules');
+const EXAMPLES_BASE_PATH = path.join('tools', 'cds-lint', 'examples');
+const MENU_FILE_NAME = '_menu.md';
+
+/**
+ * Get a list of all rule description files.
+ * @returns {string[]} An array of rule description file names.
+ */
+const getRuleDescriptionFiles = () =>
+    fs.readdirSync(RULES_BASE_PATH)
+        .filter(file => file.endsWith('.md'))
+        .filter(file => !['index.md', MENU_FILE_NAME].includes(file))
+        .sort()
+
+/**
+ * Generates the menu markdown file
+ * by completely overriding its current contents.
+ * The menu contains links to all rule description files
+ * in alphabetical order.
+ */
+function generateMenuMarkdown () {
+    const rules = getRuleDescriptionFiles();
+    const menu = rules.map(rule => {
+        const clean = rule.replace('.md', '');
+        return `# [${clean}](${clean})`
+    }).join('\n');
+    const menuFilePath = path.join(RULES_BASE_PATH, '_menu.md')
+    fs.writeFileSync(menuFilePath, menu);
+    console.info(`generated menu to ${menuFilePath}`)
+}
+
+/**
+ * Generates a stub markdown file for a new JS rule.
+ * The passed ruleName will be placed in the stub template
+ * where $RULE_NAME is defined.
+ * @param {string} ruleName - The name of the rule.
+ */
+function generateJsRuleStub (ruleName) {
+    if (!ruleName) {
+        console.error('Please provide a rule name, e.g. "no-shared-handler-variables" as second argument');
+        process.exit(1);
+    }
+    const stubFilePath = path.join(RULES_BASE_PATH, ruleName + '.md');
+    if (fs.existsSync(stubFilePath)) {
+        console.error(`file ${stubFilePath} already exists, will not overwrite`);
+        process.exit(2);
+    }
+    const stub = fs.readFileSync(path.join(import.meta.dirname, 'js-rule-stub.md'), 'utf-8').replaceAll('$RULE_NAME', ruleName);
+    fs.writeFileSync(stubFilePath, stub);
+    console.info(`generated stub to ${stubFilePath}`);
+    const correctPath = path.join(EXAMPLES_BASE_PATH, ruleName, 'correct', 'srv');
+    fs.mkdirSync(correctPath, { recursive: true });
+    const incorrectPath = path.join(EXAMPLES_BASE_PATH, ruleName, 'incorrect', 'srv');
+    fs.mkdirSync(incorrectPath, { recursive: true });
+    console.info(`generated example directories in ${path.join(EXAMPLES_BASE_PATH, ruleName)}`);
+    fs.writeFileSync(path.join(correctPath, 'admin-service.js'), '// correct example\n');
+    fs.writeFileSync(path.join(incorrectPath, 'admin-service.js'), '// incorrect example\n');
+}
+
+function main (argv) {
+    switch (argv[0]) {
+        case 'generate-menu':
+            generateMenuMarkdown();
+            break;
+        case 'generate-js-stub':
+            generateJsRuleStub(argv[1]);
+            generateMenuMarkdown();
+            break;
+        default:
+            console.log(`Unknown command: ${argv[0]}. Use one of: generate-menu, generate-stub`);
+    }
+}
+
+main(process.argv.slice(2));

.github/eslint-plugin/js-rule-stub.md

@@ -0,0 +1,44 @@
+---
+status: released
+---
+
+<script setup>
+  import PlaygroundBadge from '../components/PlaygroundBadge.vue'
+</script>
+
+# $RULE_NAME
+
+## Rule Details
+
+DETAILS
+
+#### Version
+This rule was introduced in `@sap/eslint-plugin-cds x.y.z`.
+
+## Examples
+
+### ✅ &nbsp; Correct example
+
+DESCRIPTION OF CORRECT EXAMPLE
+
+::: code-group
+<<< ../examples/$RULE_NAME/correct/srv/admin-service.js#snippet{js:line-numbers} [srv/admin-service.js]
+:::
+<PlaygroundBadge
+  name="$RULE_NAME"
+  kind="correct"
+  :files="['srv/admin-service.js']"
+/>
+
+### ❌ &nbsp; Incorrect example
+
+DESCRIPTION OF INCORRECT EXAMPLE
+
+::: code-group
+<<< ../examples/$RULE_NAME/incorrect/srv/admin-service.js#snippet{js:line-numbers} [srv/admin-service.js]
+:::
+<PlaygroundBadge
+  name="$RULE_NAME"
+  kind="incorrect"
+  :files="['srv/admin-service.js']"
+/>

.vitepress/config.js

@@ -106,8 +106,8 @@ config.rewrites = rewrites
 // Add custom capire info to the theme config
 config.themeConfig.capire = {
   versions: {
-    java_services: '4.2.0',
-    java_cds4j: '4.2.0'
+    java_services: '4.3.1',
+    java_cds4j: '4.3.0'
   },
   gotoLinks: []
 }

about/index.md

@@ -378,11 +378,16 @@ Keeping pace with a rapidly changing world of volatile cloud technologies and pl
 ## What about AI? <UnderConstruction/>
 
 - AI provides tremendous boosts to productivity → for example:
-  - **Coding Assists** → for example, by [Copilot](https://en.wikipedia.org/wiki/Microsoft_Copilot) in `.cds`, `.js`, even `.md` sources
+  - **Coding Assists** → for example, by [GitHub Copilot](https://github.com/features/copilot) in `.cds`, `.js`, even `.md` sources
   - **Code Analysis** → detecting [bad practices](bad-practices) → guiding to [best practices](best-practices)
   - **Code Generation** → for example, for tests, test data, ...
   - **Project Scaffolding** → for quick head starts
-  - **Search & Learning Assists** → like Maui, ...
+  - **Search & Learning Assists** → like SAP Joule, ...
 - But this doesn't replace the need for **Human Intelligence**!
   - There's a different between a GPT-generated one-off thesis and long-lived enterprise software, which needs to adapt and scale to new requirements.
-- **CAP itself** is a major contribution to AI → its simple, clear concepts, uniform ways to implement and consume services, capire, its openness and visibility in the public world, ...
+
+By **embracing and advocating standard tooling** like VS Code and GitHub Actions, CAP ensures its projects are day-one beneficiaries of new AI features rolled out there.
+
+**CAP itself** is a major contribution to AI → its simple, clear concepts, uniform ways to implement and consume services make it easier for AIs and humans alike to reason about the system.
+
+Its openness and public visibility helped influence the very first AI models — even the original ChatGPT knew some CAP, and its baked-in knowledge of it has since improved dramatically.