@salesforce/plugin-metadata-enrichment 0.0.8 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -5
- package/messages/metadata.enrich.md +10 -1
- package/npm-shrinkwrap.json +6 -6
- package/oclif.lock +4 -4
- package/oclif.manifest.json +4 -3
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -43,11 +43,11 @@ git clone git@github.com:salesforcecli/plugin-metadata-enrichment
|
|
|
43
43
|
yarn && yarn build
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
|
|
46
|
+
To use your plugin, run using the local `./bin/dev.js` or `./bin/dev.cmd` file.
|
|
47
47
|
|
|
48
48
|
```bash
|
|
49
49
|
# Run using local run file.
|
|
50
|
-
./bin/dev metadata enrich
|
|
50
|
+
./bin/dev.js metadata enrich
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
|
|
@@ -99,8 +99,12 @@ DESCRIPTION
|
|
|
99
99
|
Even though this command updates only local files in your DX project, you're still required to authorize and specify
|
|
100
100
|
an org, which is how the command accesses a large language model (LLM).
|
|
101
101
|
|
|
102
|
-
|
|
103
|
-
|
|
102
|
+
This command currently supports the following metadata types:
|
|
103
|
+
|
|
104
|
+
- LightningComponentBundle
|
|
105
|
+
- FlexiPage
|
|
106
|
+
- CustomObject
|
|
107
|
+
- LightningTypeBundle
|
|
104
108
|
|
|
105
109
|
Your org must be eligible for metadata enrichment. Your Salesforce admin can help with that.
|
|
106
110
|
|
|
@@ -122,12 +126,16 @@ EXAMPLES
|
|
|
122
126
|
|
|
123
127
|
$ sf metadata enrich --metadata "LightningComponentBundle:Component\*"
|
|
124
128
|
|
|
129
|
+
Enrich metadata for a LightningComponentBundle and CustomObject:
|
|
130
|
+
|
|
131
|
+
$ sf metadata enrich --metadata LightningComponentBundle:Component1 --metadata CustomObject:Component2
|
|
132
|
+
|
|
125
133
|
FLAG DESCRIPTIONS
|
|
126
134
|
-m, --metadata=<value>... Metadata type and optional component name to enrich.
|
|
127
135
|
|
|
128
136
|
Wildcards ("_") are supported as long as you use double quotes, such as "LightningComponentBundle:MyClass_".
|
|
129
137
|
```
|
|
130
138
|
|
|
131
|
-
_See code: [src/commands/metadata/enrich.ts](https://github.com/salesforcecli/plugin-metadata-enrichment/blob/0.0
|
|
139
|
+
_See code: [src/commands/metadata/enrich.ts](https://github.com/salesforcecli/plugin-metadata-enrichment/blob/0.1.0/src/commands/metadata/enrich.ts)_
|
|
132
140
|
|
|
133
141
|
<!-- commandsstop -->
|
|
@@ -12,7 +12,12 @@ To enrich multiple metadata components, specify multiple --metadata <name> flags
|
|
|
12
12
|
|
|
13
13
|
Even 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).
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
This command currently supports the following metadata types:
|
|
16
|
+
|
|
17
|
+
- LightningComponentBundle
|
|
18
|
+
- FlexiPage
|
|
19
|
+
- CustomObject
|
|
20
|
+
- LightningTypeBundle
|
|
16
21
|
|
|
17
22
|
Your org must be eligible for metadata enrichment. Your Salesforce admin can help with that.
|
|
18
23
|
|
|
@@ -34,6 +39,10 @@ Your org must be eligible for metadata enrichment. Your Salesforce admin can hel
|
|
|
34
39
|
|
|
35
40
|
<%= config.bin %> <%= command.id %> --metadata "LightningComponentBundle:Component\*"
|
|
36
41
|
|
|
42
|
+
- Enrich metadata for a LightningComponentBundle and CustomObject:
|
|
43
|
+
|
|
44
|
+
<%= config.bin %> <%= command.id %> --metadata LightningComponentBundle:Component1 --metadata CustomObject:Component2
|
|
45
|
+
|
|
37
46
|
# flags.metadata.summary
|
|
38
47
|
|
|
39
48
|
Metadata type and optional component name to enrich.
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-metadata-enrichment",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@salesforce/plugin-metadata-enrichment",
|
|
9
|
-
"version": "0.0
|
|
9
|
+
"version": "0.1.0",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@oclif/core": "^4",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"@oclif/table": "^0.5.1",
|
|
15
15
|
"@salesforce/core": "^8.24.3",
|
|
16
16
|
"@salesforce/kit": "^3.2.4",
|
|
17
|
-
"@salesforce/metadata-enrichment": "^0.0.
|
|
17
|
+
"@salesforce/metadata-enrichment": "^0.0.14",
|
|
18
18
|
"@salesforce/sf-plugins-core": "^12",
|
|
19
19
|
"@salesforce/source-deploy-retrieve": "^12.31.14"
|
|
20
20
|
},
|
|
@@ -3882,9 +3882,9 @@
|
|
|
3882
3882
|
}
|
|
3883
3883
|
},
|
|
3884
3884
|
"node_modules/@salesforce/metadata-enrichment": {
|
|
3885
|
-
"version": "0.0.
|
|
3886
|
-
"resolved": "https://registry.npmjs.org/@salesforce/metadata-enrichment/-/metadata-enrichment-0.0.
|
|
3887
|
-
"integrity": "sha512-
|
|
3885
|
+
"version": "0.0.14",
|
|
3886
|
+
"resolved": "https://registry.npmjs.org/@salesforce/metadata-enrichment/-/metadata-enrichment-0.0.14.tgz",
|
|
3887
|
+
"integrity": "sha512-A9d2jN3msPn1JGtm+4Vk3UpXxRtXNm6/c5gLcJwBQCT4tMHXkgi3jhqCkls9Fl+ZoGGW41LMzmMda/lzu/Ojig==",
|
|
3888
3888
|
"license": "Apache-2.0",
|
|
3889
3889
|
"dependencies": {
|
|
3890
3890
|
"@salesforce/core": "^8.24.3",
|
package/oclif.lock
CHANGED
|
@@ -1624,10 +1624,10 @@
|
|
|
1624
1624
|
dependencies:
|
|
1625
1625
|
"@salesforce/ts-types" "^2.0.12"
|
|
1626
1626
|
|
|
1627
|
-
"@salesforce/metadata-enrichment@^0.0.
|
|
1628
|
-
version "0.0.
|
|
1629
|
-
resolved "https://registry.yarnpkg.com/@salesforce/metadata-enrichment/-/metadata-enrichment-0.0.
|
|
1630
|
-
integrity sha512-
|
|
1627
|
+
"@salesforce/metadata-enrichment@^0.0.14":
|
|
1628
|
+
version "0.0.14"
|
|
1629
|
+
resolved "https://registry.yarnpkg.com/@salesforce/metadata-enrichment/-/metadata-enrichment-0.0.14.tgz#a8c8bf4367d363cd4789d86915eddfa406b95901"
|
|
1630
|
+
integrity sha512-A9d2jN3msPn1JGtm+4Vk3UpXxRtXNm6/c5gLcJwBQCT4tMHXkgi3jhqCkls9Fl+ZoGGW41LMzmMda/lzu/Ojig==
|
|
1631
1631
|
dependencies:
|
|
1632
1632
|
"@salesforce/core" "^8.24.3"
|
|
1633
1633
|
"@salesforce/kit" "^3.2.4"
|
package/oclif.manifest.json
CHANGED
|
@@ -3,12 +3,13 @@
|
|
|
3
3
|
"metadata:enrich": {
|
|
4
4
|
"aliases": [],
|
|
5
5
|
"args": {},
|
|
6
|
-
"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\
|
|
6
|
+
"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\nThis command currently supports the following metadata types:\n\n- LightningComponentBundle\n- FlexiPage\n- CustomObject\n- LightningTypeBundle\n\nYour org must be eligible for metadata enrichment. Your Salesforce admin can help with that.",
|
|
7
7
|
"examples": [
|
|
8
8
|
"Enrich the \"HelloWorld\" LightningComponentBundle metadata component in the local DX project; use your default org:\n<%= config.bin %> <%= command.id %> --metadata LightningComponentBundle:HelloWorld",
|
|
9
9
|
"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",
|
|
10
10
|
"Enrich metadata for multiple LightningComponentBundles using your default org:\n<%= config.bin %> <%= command.id %> --metadata LightningComponentBundle:Component1 --metadata LightningComponentBundle:Component2",
|
|
11
|
-
"Enrich metadata for multiple LightningComponentBundles using a matching wildcard:\n<%= config.bin %> <%= command.id %> --metadata \"LightningComponentBundle:Component\\*\""
|
|
11
|
+
"Enrich metadata for multiple LightningComponentBundles using a matching wildcard:\n<%= config.bin %> <%= command.id %> --metadata \"LightningComponentBundle:Component\\*\"",
|
|
12
|
+
"Enrich metadata for a LightningComponentBundle and CustomObject:\n<%= config.bin %> <%= command.id %> --metadata LightningComponentBundle:Component1 --metadata CustomObject:Component2"
|
|
12
13
|
],
|
|
13
14
|
"flags": {
|
|
14
15
|
"json": {
|
|
@@ -71,5 +72,5 @@
|
|
|
71
72
|
]
|
|
72
73
|
}
|
|
73
74
|
},
|
|
74
|
-
"version": "0.0
|
|
75
|
+
"version": "0.1.0"
|
|
75
76
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-metadata-enrichment",
|
|
3
3
|
"description": "A Salesforce CLI plugin to enrich metadata for Salesforce resources",
|
|
4
|
-
"version": "0.0
|
|
4
|
+
"version": "0.1.0",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"@oclif/table": "^0.5.1",
|
|
11
11
|
"@salesforce/core": "^8.24.3",
|
|
12
12
|
"@salesforce/kit": "^3.2.4",
|
|
13
|
-
"@salesforce/metadata-enrichment": "^0.0.
|
|
13
|
+
"@salesforce/metadata-enrichment": "^0.0.14",
|
|
14
14
|
"@salesforce/sf-plugins-core": "^12",
|
|
15
15
|
"@salesforce/source-deploy-retrieve": "^12.31.14"
|
|
16
16
|
},
|
|
@@ -207,7 +207,7 @@
|
|
|
207
207
|
"type": "module",
|
|
208
208
|
"packageManager": "yarn@1.22.22",
|
|
209
209
|
"sfdx": {
|
|
210
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-metadata-enrichment/0.0.
|
|
211
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-metadata-enrichment/0.0.
|
|
210
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-metadata-enrichment/0.1.0.crt",
|
|
211
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-metadata-enrichment/0.1.0.sig"
|
|
212
212
|
}
|
|
213
213
|
}
|