@W-21194676 - refactor: use oclif libraries for outputs #16

william-xie-sf · 2026-02-09T23:28:49Z

What does this PR do?

Set flag so that command is in preview state

Use @oclif/multi-stage-output library instead of spinner for execution messages

Use @oclif/table (abstracted within sf-plugins-core) for non-json results output instead of custom metricsFormatter

Update command help text to call out org needs to be metadata enrichment eligible

Update README.md with updated help text

What issues does this PR fix or reference?

GUS: @W-21194676@

jshackell-sfdc · 2026-02-10T00:20:25Z

messages/metadata.enrich.md


 Currently, this command supports enriching only Lightning Web Components, represented by the LightningComponentBundle metadata type.

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


Suggested change

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

Your org must be enabled with the MetadataAiEnrichmentPilot org perm to use the metadata enrichment feature. Contact your Salesforce admin.

I think it's useful to explicitly say what's needed to use the feature.

If, however, there's more that has to happen beyond just enabling an org perm, then reject my suggestion and just keep the more vague original message.

Valid point. I think for future proofing and to not expose the pilot perm (it's something we need to enable from our end - access requirements will likely change in the near future), we will keep it for now and revisit later!

ankit-patro-sf · 2026-02-10T00:15:45Z

messages/metadata.enrich.md

-Executing metadata enrichment for %s eligible components
+Executing metadata enrichment

-# spinner.updating.files


what do spinner and stage mean here?

These are both from oclif libraries as part CLI output formatting. Both do basically the same thing but just in slightly different ways (Spinner, Stage).

CLI team recommended us to use multi stage output for consistency with other plugins and make it clear what stage the execution is that, which is what this change is.

ankit-patro-sf · 2026-02-10T00:16:24Z

src/commands/metadata/enrich.ts

+import { MultiStageOutput } from '@oclif/multi-stage-output';
 import { Messages, SfProject } from '@salesforce/core';
-import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Flags, SfCommand, Ux } from '@salesforce/sf-plugins-core';
 import { ComponentSetBuilder } from '@salesforce/source-deploy-retrieve';
 import { EnrichmentHandler, EnrichmentMetrics, EnrichmentStatus, FileProcessor } from '@salesforce/metadata-enrichment';
 import { ComponentProcessor } from '../../component/index.js';
-import { MetricsFormatter, EnrichmentRecords } from '../../utils/index.js';
+import { EnrichmentRecords } from '../../utils/index.js';


Organizing imports or something?

Yes the only two actual changes were:

Removing MetricsFormatter (this was removed in favor of using oclif library)

Adding Ux from sf-plugins-core

ankit-patro-sf · 2026-02-10T00:18:28Z

src/commands/metadata/enrich.ts

+      commandMessages.getMessage('stage.executing'), 
+      commandMessages.getMessage('stage.updating.files'),
+    ];
+    const mso = new MultiStageOutput({


nit - can we rename the const to MULTI_STAGE_OUTPUT as this is a constant and provides better readability

It's actually not a constant but an initialized object that we call in order to move stages and change the output to the console. (see mso.goto() and mso.next() calls) It's inline with other plugins in salesforcecli org

Though the const stages above could be moved to constants. Will update.

ankit-patro-sf · 2026-02-10T00:19:16Z

src/commands/metadata/enrich.ts

    const metrics = EnrichmentMetrics.createEnrichmentMetrics(Array.from(enrichmentRecords.recordSet));
-    MetricsFormatter.logMetrics(this.log.bind(this), metrics, metricsMessages);
+    const ux = new Ux();
+    ux.log('');


Do we need this?
ux.log('');

Yea this is basically to print a newline

ankit-patro-sf · 2026-02-10T00:19:31Z

src/commands/metadata/enrich.ts

+        overflow: 'wrap',
+      });
+    }
+    ux.log('');


do we need this?
ux.log('');

Same as https://github.com/salesforcecli/plugin-metadata-enrichment/pull/16/changes/BASE..399abd9eb89f6fe5737448be33754064ed9c146b#r2785287228

ankit-patro-sf · 2026-02-10T00:22:51Z

README.md

-  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
-                             configuration variable is already set.
+  -m, --metadata=<value>...  (required) Metadata type and optional component name to enrich.
+  -o, --target-org=<value>   (required) [default: epic.out.18fed7c5294a@orgfarm.salesforce.com] Username or alias of the target


[default: epic.out.18fed7c5294a@orgfarm.salesforce.com]
It might be default in one's system and not in others

Can we specify this as an example isntead if need be to avoid confusion

--target-org=epic.out.18fed7c5294a@orgfarm.salesforce.com

Good catch - this needs to be removed. This was printed out from my local context which won't apply in the README.md. Will update.

refactor: use oclif libraries for outputs

7f2fa5b

william-xie-sf requested a review from a team as a code owner February 9, 2026 23:28

update package.json

399abd9

jshackell-sfdc reviewed Feb 10, 2026

View reviewed changes

ankit-patro-sf reviewed Feb 10, 2026

View reviewed changes

rename const and update README.md

76f80f7

ankit-patro-sf approved these changes Feb 10, 2026

View reviewed changes

william-xie-sf merged commit 4fabd9d into main Feb 10, 2026
15 checks passed

william-xie-sf deleted the t/metadata-intelligence/use-libraries-refactor branch February 10, 2026 20:36


		Currently, this command supports enriching only Lightning Web Components, represented by the LightningComponentBundle metadata type.

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

	Your org must be eligible for metadata enrichment. Your Salesforce admin can help with that.
	Your org must be enabled with the MetadataAiEnrichmentPilot org perm to use the metadata enrichment feature. Contact your Salesforce admin.

@W-21194676 - refactor: use oclif libraries for outputs #16

@W-21194676 - refactor: use oclif libraries for outputs #16

Uh oh!

Conversation

william-xie-sf commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

What issues does this PR fix or reference?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

william-xie-sf commented Feb 9, 2026 •

edited

Loading