feat: add schemas for registry customization #84
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mshanemc
reviewed
Apr 1, 2024
src/registryVariants.ts
Outdated
| transformer?: | ||
| | "decomposed" | ||
| | "staticResource" | ||
| | "nonDecomposed" |
There was a problem hiding this comment.
I think I'd like to NOT expose the stuff that CustomLabels was using. I don't want more people creating dependencies on those behaviors since they've been so bad.
mshanemc
requested changes
Apr 1, 2024
src/registryVariants.ts
Outdated
| | "nonDecomposed" | ||
| | "standard"; | ||
| decomposition?: "topLevel" | "folderPerType"; | ||
| recomposition?: "startEmpty"; |
There was a problem hiding this comment.
Suggested change
| recomposition?: "startEmpty"; |
src/registryVariants.ts
Outdated
| transformer?: | ||
| | "decomposed" | ||
| | "staticResource" | ||
| | "nonDecomposed" |
There was a problem hiding this comment.
Suggested change
| | "nonDecomposed" |
src/registryVariants.ts
Outdated
| | "mixedContent" | ||
| | "matchingContentFile" | ||
| | "decomposed" | ||
| | "digitalExperience" |
There was a problem hiding this comment.
Suggested change
| | "digitalExperience" |
and maybe not let people use DEB's weird stuff either.
src/registryVariants.ts
Outdated
Comment on lines
30
to
37
| /** | ||
| * Whether or not components are stored in folders. | ||
| * | ||
| * __Examples:__ Reports, Dashboards, Documents, EmailTemplates | ||
| * | ||
| * @deprecated use `folderType` to get the related folder type, if one exists | ||
| */ | ||
| inFolder?: boolean; |
There was a problem hiding this comment.
Suggested change
| /** | |
| * Whether or not components are stored in folders. | |
| * | |
| * __Examples:__ Reports, Dashboards, Documents, EmailTemplates | |
| * | |
| * @deprecated use `folderType` to get the related folder type, if one exists | |
| */ | |
| inFolder?: boolean; |
because it's deprecated
src/registryVariants.ts
Outdated
Comment on lines
46
to
53
| /** | ||
| * MetaFile suffix | ||
| * | ||
| * An override to the default "-meta.xml" suffix. | ||
| * | ||
| * __Examples:__ "_meta.json" for DigitalExperience. | ||
| */ | ||
| metaFileSuffix?: string; |
There was a problem hiding this comment.
Suggested change
| /** | |
| * MetaFile suffix | |
| * | |
| * An override to the default "-meta.xml" suffix. | |
| * | |
| * __Examples:__ "_meta.json" for DigitalExperience. | |
| */ | |
| metaFileSuffix?: string; |
another thing I'd like to avoid exposing
src/registryVariants.ts
Outdated
Comment on lines
71
to
74
| /** | ||
| * If the parent name should be ignored when constructing the type's fullName | ||
| */ | ||
| ignoreParentName?: boolean; |
There was a problem hiding this comment.
Suggested change
| /** | |
| * If the parent name should be ignored when constructing the type's fullName | |
| */ | |
| ignoreParentName?: boolean; |
hide, also only currently for customLabels/nonDecomposed
src/registryVariants.ts
Outdated
Comment on lines
79
to
83
| /** | ||
| * When converting deploying source, this will update the suffix in the output or temporary directory (metadata format) | ||
| * Use this, along with additional suffix keys in the registry, to support incorrect suffixes from existing code | ||
| */ | ||
| legacySuffix?: string; |
There was a problem hiding this comment.
Let's keep that hidden unless someone needs it. This was really just for things toolbelt had wrong.
Suggested change
| /** | |
| * When converting deploying source, this will update the suffix in the output or temporary directory (metadata format) | |
| * Use this, along with additional suffix keys in the registry, to support incorrect suffixes from existing code | |
| */ | |
| legacySuffix?: string; |
mshanemc
reviewed
Apr 1, 2024
| }, | ||
| "registryPresets": { | ||
| "title": "Custom predefined presets for decomposing metadata types", | ||
| "description": "filenames from https://github.com/forcedotcom/source-deploy-retrieve/tree/main/src/registry/presets ", |
mshanemc
approved these changes
Apr 1, 2024
mshanemc
approved these changes
Apr 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
adds custom registry schema information
What issues does this PR fix or reference?
@W-14609009@
Functionality Before
red lines when using
registryCustomizationsorregistryPresetsFunctionality After
full type support