W-16324102 Sm/levenshtein-missing-types

[mshanemc]

nuts require salesforcecli/plugin-source#1251 and salesforcecli/plugin-deploy-retrieve#1103

What does this PR do?

nicer error messages for unresolvable types.

Error (RegistryError): Missing metadata type definition in registry for id 'Worflow'.

Try this:

Did you mean one of the following types? [Workflow]

Confirm the metadata type name is correct. Validate against the registry at:
<https://github.com/forcedotcom/source-deploy-retrieve/blob/main/src/registry/metadataRegistry.json>

If the type is not listed in the registry, check that it has Metadata API support via the Metadata Coverage Report:
<https://developer.salesforce.com/docs/metadata-coverage>

If the type is available via Metadata API but not in the registry

- Open an issue <https://github.com/forcedotcom/cli/issues>
- Add the type via PR. Instructions: <https://github.com/forcedotcom/source-deploy-retrieve/blob/main/contributing/metadata.md>

shares a bunch of logic with suffix-levenshtein, so that's all now in one place.

What issues does this PR fix or reference?

@W-16324102@

[WillieRuemmele]

Does the ComponentSetBuilder.build not need the catch anymore? It was just moved down a level to the RegistryAccess itself?

[mshanemc]

Does the ComponentSetBuilder.build not need the catch anymore? It was just moved down a level to the RegistryAccess itself?

yeah, it was intercepting only that one error (where something was missing from the registry) and re-throwing all others. Now that the RegistryAccess returns a nicer error, there was nothing left to catch.

[WillieRuemmele]

QA Notes

---

✅ :

➜  dreamhouse-lwc git:(main)  hub:(GLOBAL - DevHub) scratch:([email protected])
 ➜  sf project deploy start -m Foox
Error (SfError): The specified metadata type is unsupported: [foox]

➜  dreamhouse-lwc git:(main)  hub:(GLOBAL - DevHub) scratch:([email protected])
 ➜  ../../oss/plugin-deploy-retrieve/bin/run.js project deploy start -m Foox
Error (RegistryError): Missing metadata type definition in registry for id 'Foox'.

Try this:

Did you mean one of the following types? [Flow,Form]

Confirm the metadata type name is correct. Validate against the registry at:
<https://github.com/forcedotcom/source-deploy-retrieve/blob/main/src/registry/metadataRegistry.json>

If the type is not listed in the registry, check that it has Metadata API support via the Metadata Coverage Report:
<https://developer.salesforce.com/docs/metadata-coverage>

If the type is available via Metadata API but not in the registry

- Open an issue <https://github.com/forcedotcom/cli/issues>
- Add the type via PR. Instructions: <https://github.com/forcedotcom/source-deploy-retrieve/blob/main/contributing/metadata.md>