@salesforce/plugin-metadata-enrichment 0.0.1

package/oclif.manifest.json

@@ -0,0 +1,74 @@
+{
+  "commands": {
+    "metadata:enrich": {
+      "aliases": [],
+      "args": {},
+      "description": "Use this command to add AI-generated descriptions right in the metadata source files in your local DX project. These enriched descriptions succinctly outline the metadata component’s purpose and capabilities, which in turn provide context when vibe coding with an AI tool, such as Agentforce Vibes.\n\nThis command updates only the local metadata source files in your DX project; it doesn't change the components in your org. If you want the AI-generated descriptions in your org, then you must explicitly deploy the updated metadata components to your org by using, for example, the \"project deploy start\" CLI command.\n\nTo enrich multiple metadata components, specify multiple --metadata <name> flags. Enclose names that contain spaces in double quotes.\n\nEven though this command updates only local files in your DX project, you're still required to authorize and specify an org, which is how the command accesses a large language model (LLM).\n\nCurrently, this command supports enriching only Lightning Web Components, represented by the LightningComponentBundle metadata type.",
+      "examples": [
+        "Enrich the \"HelloWorld\" LightningComponentBundle metadata component in the local DX project; use your default org:\n<%= config.bin %> <%= command.id %> --metadata LightningComponentBundle:HelloWorld",
+        "Enrich the \"HelloWorld\" LightningComponentBundle metadata component and use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --metadata LightningComponentBundle:HelloWorld --target-org my-org",
+        "Enrich metadata for multiple LightningComponentBundles using your default org:\n<%= config.bin %> <%= command.id %> --metadata LightningComponentBundle:Component1 --metadata LightningComponentBundle:Component2",
+        "Enrich metadata for multiple LightningComponentBundles using a matching wildcard:\n<%= config.bin %> <%= command.id %> --metadata \"LightningComponentBundle:Component\\*\""
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "metadata": {
+          "char": "m",
+          "description": "Wildcards (\"_\") are supported as long as you use double quotes, such as \"LightningComponentBundle:MyClass_\".",
+          "name": "metadata",
+          "required": true,
+          "summary": "Metadata type and optional component name to enrich.",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "metadata:enrich",
+      "pluginAlias": "@salesforce/plugin-metadata-enrichment",
+      "pluginName": "@salesforce/plugin-metadata-enrichment",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Enrich metadata components in your DX project by adding AI-generated descriptions.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "metadata",
+        "enrich.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "metadata:enrich",
+        "enrich:metadata"
+      ]
+    }
+  },
+  "version": "0.0.1"
+}

package/package.json

@@ -0,0 +1,207 @@
+{
+    "name": "@salesforce/plugin-metadata-enrichment",
+    "description": "A Salesforce CLI plugin to enrich metadata for Salesforce resources",
+    "version": "0.0.1",
+    "author": "Salesforce",
+    "bugs": "https://github.com/forcedotcom/cli/issues",
+    "dependencies": {
+        "@oclif/core": "^4",
+        "@salesforce/core": "^8.24.0",
+        "@salesforce/kit": "^3.2.4",
+        "@salesforce/metadata-enrichment": "^0.0.1",
+        "@salesforce/sf-plugins-core": "^12",
+        "@salesforce/source-deploy-retrieve": "^12.0.1"
+    },
+    "devDependencies": {
+        "@oclif/plugin-command-snapshot": "^5.3.8",
+        "@salesforce/cli-plugins-testkit": "^5.3.41",
+        "@salesforce/dev-scripts": "^11.0.4",
+        "@salesforce/plugin-command-reference": "^3.1.79",
+        "@salesforce/source-testkit": "^2.2.172",
+        "eslint-plugin-sf-plugin": "^1.20.33",
+        "oclif": "^4.22.59",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.5.4"
+    },
+    "engines": {
+        "node": ">=20.0.0"
+    },
+    "files": [
+        "/lib",
+        "/messages",
+        "/npm-shrinkwrap.json",
+        "/oclif.lock",
+        "/oclif.manifest.json",
+        "/schemas"
+    ],
+    "homepage": "https://github.com/salesforcecli/plugin-metadata-enrichment",
+    "keywords": [
+        "force",
+        "salesforce",
+        "salesforcedx",
+        "sf",
+        "sf-plugin",
+        "sfdx",
+        "sfdx-plugin"
+    ],
+    "license": "Apache-2.0",
+    "oclif": {
+        "commands": "./lib/commands",
+        "bin": "sf",
+        "topicSeparator": " ",
+        "devPlugins": [
+            "@oclif/plugin-help",
+            "@oclif/plugin-command-snapshot",
+            "@salesforce/plugin-command-reference"
+        ],
+        "topics": {
+            "metadata": {
+                "description": "Commands to enrich metadata for Salesforce resources"
+            }
+        },
+        "flexibleTaxonomy": true
+    },
+    "repository": "salesforcecli/plugin-metadata-enrichment",
+    "scripts": {
+        "build": "wireit",
+        "clean": "sf-clean",
+        "clean-all": "sf-clean all",
+        "compile": "wireit",
+        "docs": "sf-docs",
+        "fix-license": "eslint src test --fix --rule \"header/header: [2]\"",
+        "format": "wireit",
+        "link-check": "wireit",
+        "lint": "wireit",
+        "postpack": "sf-clean --ignore-signing-artifacts",
+        "prepack": "sf-prepack",
+        "prepare": "sf-install",
+        "test": "wireit",
+        "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
+        "test:only": "wireit",
+        "version": "oclif readme"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "wireit": {
+        "build": {
+            "dependencies": [
+                "compile",
+                "lint"
+            ]
+        },
+        "compile": {
+            "command": "tsc -p . --pretty --incremental",
+            "files": [
+                "src/**/*.ts",
+                "**/tsconfig.json",
+                "messages/**"
+            ],
+            "output": [
+                "lib/**",
+                "*.tsbuildinfo"
+            ],
+            "clean": "if-file-deleted"
+        },
+        "format": {
+            "command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
+            "files": [
+                "src/**/*.ts",
+                "test/**/*.ts",
+                "schemas/**/*.json",
+                "command-snapshot.json",
+                ".prettier*"
+            ],
+            "output": []
+        },
+        "lint": {
+            "command": "eslint src test --color --cache --cache-location .eslintcache",
+            "files": [
+                "src/**/*.ts",
+                "test/**/*.ts",
+                "messages/**",
+                "**/.eslint*",
+                "**/tsconfig.json"
+            ],
+            "output": []
+        },
+        "test:compile": {
+            "command": "tsc -p \"./test\" --pretty",
+            "files": [
+                "test/**/*.ts",
+                "**/tsconfig.json"
+            ],
+            "output": []
+        },
+        "test": {
+            "dependencies": [
+                "test:compile",
+                "test:only",
+                "test:command-reference",
+                "test:deprecation-policy",
+                "lint",
+                "test:json-schema",
+                "link-check"
+            ]
+        },
+        "test:only": {
+            "command": "nyc mocha \"test/**/*.test.ts\"",
+            "env": {
+                "FORCE_COLOR": "2"
+            },
+            "files": [
+                "test/**/*.ts",
+                "src/**/*.ts",
+                "**/tsconfig.json",
+                ".mocha*",
+                "!*.nut.ts",
+                ".nycrc"
+            ],
+            "output": []
+        },
+        "test:command-reference": {
+            "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" commandreference:generate --erroronwarnings",
+            "files": [
+                "src/**/*.ts",
+                "messages/**",
+                "package.json"
+            ],
+            "output": [
+                "tmp/root"
+            ]
+        },
+        "test:deprecation-policy": {
+            "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" snapshot:compare",
+            "files": [
+                "src/**/*.ts"
+            ],
+            "output": [],
+            "dependencies": [
+                "compile"
+            ]
+        },
+        "test:json-schema": {
+            "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" schema:compare",
+            "files": [
+                "src/**/*.ts",
+                "schemas"
+            ],
+            "output": []
+        },
+        "link-check": {
+            "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"**/*.md\" --skip \"CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|localhost|%s\" --markdown --retry --directory-listing --verbosity error",
+            "files": [
+                "./*.md",
+                "./!(CHANGELOG).md",
+                "messages/**/*.md"
+            ],
+            "output": []
+        }
+    },
+    "exports": "./lib/index.js",
+    "type": "module",
+    "sfdx": {
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-metadata-enrichment/0.0.1.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-metadata-enrichment/0.0.1.sig"
+    }
+}

package/schemas/metadata-enrich.json

@@ -0,0 +1,80 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/EnrichmentMetrics",
+  "definitions": {
+    "EnrichmentMetrics": {
+      "type": "object",
+      "properties": {
+        "success": {
+          "type": "object",
+          "properties": {
+            "count": {
+              "type": "number"
+            },
+            "components": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/ComponentEnrichmentStatus"
+              }
+            }
+          },
+          "required": ["count", "components"],
+          "additionalProperties": false
+        },
+        "fail": {
+          "type": "object",
+          "properties": {
+            "count": {
+              "type": "number"
+            },
+            "components": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/ComponentEnrichmentStatus"
+              }
+            }
+          },
+          "required": ["count", "components"],
+          "additionalProperties": false
+        },
+        "skipped": {
+          "type": "object",
+          "properties": {
+            "count": {
+              "type": "number"
+            },
+            "components": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/ComponentEnrichmentStatus"
+              }
+            }
+          },
+          "required": ["count", "components"],
+          "additionalProperties": false
+        },
+        "total": {
+          "type": "number"
+        }
+      },
+      "required": ["success", "fail", "skipped", "total"],
+      "additionalProperties": false
+    },
+    "ComponentEnrichmentStatus": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "message": {
+          "type": "string"
+        },
+        "typeName": {
+          "type": "string"
+        },
+        "componentName": {
+          "type": "string"
+        }
+      },
+      "required": ["componentName", "message", "typeName"]
+    }
+  }
+}