@db-ux/agent-cli - npm Package Compare versions

Comparing version 3.0.2-copilot3-1616965 to 3.1.18

build/index.js

@@ -13,3 +13,3 @@ #!/usr/bin/env node
   }
-  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) {
@@ -39,4 +39,4 @@ if (entry.isDirectory()) {
     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/")
     ];
@@ -95,4 +95,4 @@ for (const databaseUxPath of databaseUxPaths) {
     );
-    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);
@@ -99,0 +99,0 @@ const endIndex = copilotFileContent.indexOf(endMarker);

package.json

 {
   "name": "@db-ux/agent-cli",
-  "version": "3.0.2-copilot3-1616965",
+  "version": "3.1.18",
   "type": "module",
@@ -14,5 +14,6 @@ "description": "CLI for DB UX Design System generate AI agent instructions",
   },
-  "main": "build.js",
+  "main": "build/index.js",
   "files": [
-    "build"
+    "build",
+    "CHANGELOG.md"
   ],
@@ -22,5 +23,5 @@ "scripts": {
     "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",
@@ -30,9 +31,8 @@ "test:cli": "tsx src/cli.ts --help"
   "dependencies": {
-    "commander": "14.0.0",
-    "glob": "11.0.3"
+    "commander": "14.0.1"
   },
   "devDependencies": {
     "cpr": "3.0.1",
-    "esbuild": "0.25.5",
-    "tsx": "4.19.4",
+    "esbuild": "0.25.10",
+    "tsx": "4.20.6",
     "vitest": "3.2.4"
@@ -39,0 +39,0 @@ },

README.md

@@ -10,3 +10,6 @@ # @db-ux/agent-cli
 
-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:
@@ -18,4 +21,6 @@
 
-The DB UX Design System docs will get appended (or replaced in subsequent runs, e.g. after a DB UX Design System update) within the file `.github/copilot-instructions.md` (if the file doesn't exist in your codebase so far, it gets created).
+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).
 
+### Advanced Usage
+
 You can also change the root path where the tool should check for `node_modules`:
@@ -27,2 +32,19 @@
 
+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
@@ -29,0 +51,0 @@

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8870

19.32%

Dependency count

1

-50%

Number of low quality alerts

1

-50%

Number of lines in readme file

67

48.89%

Dependency changes

• + Added

  commander@14.0.1
  (transitive)

• - Removed

  glob@11.0.3

• - Removed

  @isaacs/cliui@9.0.0
  (transitive)

• - Removed

  balanced-match@4.0.4
  (transitive)

• - Removed

  brace-expansion@5.0.6
  (transitive)

• - Removed

  commander@14.0.0
  (transitive)

• - Removed

  cross-spawn@7.0.6
  (transitive)

• - Removed

  foreground-child@3.3.1
  (transitive)

• - Removed

  glob@11.0.3
  (transitive)

• - Removed

  isexe@2.0.0
  (transitive)

• - Removed

  jackspeak@4.2.3
  (transitive)

• - Removed

  lru-cache@11.5.1
  (transitive)

• - Removed

  minimatch@10.2.5
  (transitive)

• - Removed

  minipass@7.1.3
  (transitive)

• - Removed

  package-json-from-dist@1.0.1
  (transitive)

• - Removed

  path-key@3.1.1
  (transitive)

• - Removed

  path-scurry@2.0.2
  (transitive)

• - Removed

  shebang-command@2.0.0
  (transitive)

• - Removed

  shebang-regex@3.0.0
  (transitive)

• - Removed

  signal-exit@4.1.0
  (transitive)

• - Removed

  which@2.0.2
  (transitive)

• Updated

  commander@14.0.1