Skip to content

@W-21580913 - feat: update command help text with new supported types #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
william-xie-sf merged 1 commit into from
Apr 3, 2026
Merged

@W-21580913 - feat: update command help text with new supported types #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion messages/metadata.enrich.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ To enrich multiple metadata components, specify multiple --metadata <name> flags

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).

Currently, this command supports enriching only Lightning Web Components, represented by the LightningComponentBundle metadata type.
This command currently supports the following metadata types:
Copy link
Copy Markdown
Collaborator

@jshackell-sfdc jshackell-sfdc Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This command currently supports the following metadata types:
This command supports the following metadata types:

Copy link
Copy Markdown
Collaborator

@jshackell-sfdc jshackell-sfdc Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I might have originally used the word "currently", but it's actually bad form because it implies that we're going to support more types in the future. which might be true, but then we never REALLY know what's going to happen! So it's best not to try to predict the future in docs :)


- LightningComponentBundle
- FlexiPage
- CustomObject
- LightningTypeBundle

Your org must be eligible for metadata enrichment. Your Salesforce admin can help with that.

Expand All @@ -34,6 +39,10 @@ Your org must be eligible for metadata enrichment. Your Salesforce admin can hel

<%= config.bin %> <%= command.id %> --metadata "LightningComponentBundle:Component\*"

- Enrich metadata for a LightningComponentBundle and CustomObject:

<%= config.bin %> <%= command.id %> --metadata LightningComponentBundle:Component1 --metadata CustomObject:Component2

# flags.metadata.summary

Metadata type and optional component name to enrich.
Expand Down
Loading