@db-ux/agent-cli 3.0.2-copilot2-e7bf98b → 3.1.18

package/README.md

@@ -7,17 +7,19 @@
 
 ## Usage
 
-We provide a cli tool to copy `@db-ux` docs to your repository to provide it for AI Agents.
+We provide a command-line interface (CLI) tool that copies the `@db-ux` documentation to your repository, making it available to AI agents.
+
+### Running the CLI Tool
+
 Use this command in your repository:
 
 ```shell
 npx @db-ux/agent-cli
 ```
 
-This will search for all `@db-ux` packages inside your `node_modules` and copy the documentation to your repository.
-A new folder will be created named `_db-ux-docs`.
+The DB UX Design System documentation will be added to (or replaced in subsequent runs, e.g. after a DB UX Design System update) in the file `.github/copilot-instructions.md` (if this file does not yet exist in your codebase, it will be created).
 
-You might want to add this folder to your `.gitignore` file.
+### Advanced Usage
 
 You can also change the root path where the tool should check for `node_modules`:
 
@@ -25,6 +27,23 @@ You can also change the root path where the tool should check for `node_modules`
 npx @db-ux/agent-cli packages/frontend
 ```
 
+This is useful in monorepo setups where your DB UX packages might be installed in a specific workspace directory.
+
+### What the tool does
+
+1. **Scans your project's node_modules** for installed `@db-ux` packages
+2. **Extracts relevant documentation** based on your installed versions
+3. **Creates or updates** `.github/copilot-instructions.md` with component documentation
+4. **Provides AI agents** with context about available components and their usage patterns
+
+### Best practices
+
+We've had the best experience with GitHub Copilot when using the following settings:
+
+- Agent mode works best for code generation and may also offer the best developer experience.
+- Regarding the provided models, GPT-4o seemed to strike the best balance between "used tokens" and performance, although "Claude Sonnet 4" is still better. However, you run out of tokens quite quickly with this model.
+- If you're primarily interested in testing this functionality at the moment, we have quite a bit of experience using a prompt that is both equal and non-trivial, but rather complex, such as "Can you create a new page with a dashboard? It should contain selections for KPIs. Each KPI is a card containing information and buttons."
+
 ## Deutsche Bahn brand
 
 As we'd like to perfectly support our users and customers on their digital journey, the usage of Deutsche Bahn brand and trademarks are bound of clear guidelines and restrictions even if being used with the code that we're providing with this product; Deutsche Bahn fully reserves all rights regarding the Deutsche Bahn brand, even though that we're providing the code of DB UX Design System products free to use and release it under the Apache 2.0 license.

package/build/index.js

@@ -10,7 +10,7 @@ function findAllNodeModulesDirectories(directory, found = []) {
   if (!fs.existsSync(directory)) {
     return found;
   }
-  const entries = fs.readdirSync(directory, { withFileTypes: true });
+  const entries = fs.readdirSync(directory, { withFileTypes: true }).sort((a, b) => a.name.localeCompare(b.name, "en"));
   for (const entry of entries) {
     if (entry.isDirectory()) {
       if (entry.name === "node_modules") {
@@ -35,8 +35,8 @@ var generateCopilot = (rootPath) => {
   let copilotInstructionsContent = "";
   for (const nodeModulesPath of nodeModulesDirectories) {
     const databaseUxPaths = [
-      path.join(nodeModulesPath, "@db-ux"),
-      path.join(nodeModulesPath, "@db-ux-inner-source")
+      path.join(nodeModulesPath, "@db-ux/"),
+      path.join(nodeModulesPath, "@db-ux-inner-source/")
     ];
     for (const databaseUxPath of databaseUxPaths) {
       if (!fs.existsSync(databaseUxPath)) {
@@ -90,8 +90,8 @@ ${content}
       copilotInstructionsPath,
       "utf8"
     );
-    const startMarker = "--- START: DB UX Copilot Instructions ---";
-    const endMarker = "--- END: DB UX Copilot Instructions ---";
+    const startMarker = "--- START: DB UX Copilot Instructions \u2013 do not edit below ---";
+    const endMarker = "--- END: DB UX Copilot Instructions \u2013 do not edit above ---";
     const startIndex = copilotFileContent.indexOf(startMarker);
     const endIndex = copilotFileContent.indexOf(endMarker);
     if (startIndex !== -1 && endIndex !== -1 && endIndex > startIndex) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@db-ux/agent-cli",
-  "version": "3.0.2-copilot2-e7bf98b",
+  "version": "3.1.18",
   "type": "module",
   "description": "CLI for DB UX Design System generate AI agent instructions",
   "repository": {
@@ -11,28 +11,28 @@
   "bin": {
     "@db-ux/agent-cli": "build/index.js"
   },
-  "main": "build.js",
+  "main": "build/index.js",
   "files": [
-    "build"
+    "build",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "node esbuild.js",
     "copy-build": "npm-run-all copy-build:*",
-    "copy-build:build": "cpr build ../../build-outputs/agent-cli/build -o",
-    "copy-build:package.json": "cpr package.json ../../build-outputs/agent-cli/package.json -o",
-    "copy-build:readme": "cpr README.md ../../build-outputs/agent-cli/README.md -o",
+    "copy-build:build": "cpr build ../../build-outputs/agent-cli/build --overwrite",
+    "copy-build:package.json": "cpr package.json ../../build-outputs/agent-cli/package.json --overwrite",
+    "copy-build:readme": "cpr README.md ../../build-outputs/agent-cli/README.md --overwrite",
     "test": "vitest run --config vitest.config.ts",
     "test:cli": "tsx src/cli.ts --help"
   },
   "dependencies": {
-    "commander": "^14.0.0",
-    "glob": "^11.0.2"
+    "commander": "14.0.1"
   },
   "devDependencies": {
     "cpr": "3.0.1",
-    "esbuild": "0.25.5",
-    "tsx": "^4.19.4",
-    "vitest": "^3.2.1"
+    "esbuild": "0.25.10",
+    "tsx": "4.20.6",
+    "vitest": "3.2.4"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",