feat: sorted labels when recomposed

src/convert/convertContext/decomposedCustomLabelFinalizer.ts

@@ -7,6 +7,7 @@
 import { join } from 'node:path';
 import { ensure, JsonMap } from '@salesforce/ts-types';
 import type { CustomLabel } from '@jsforce/jsforce-node/lib/api/metadata';
+import { customLabelHasFullName } from '../../utils/metadata';
 import { MetadataType } from '../../registry';
 import { XML_NS_KEY, XML_NS_URL } from '../../common/constants';
 import { JsToXml } from '../streams';
@@ -65,6 +66,11 @@ const generateXml = (children: Map<string, CustomLabel>): JsonMap => ({
   ['CustomLabels']: {
     [XML_NS_KEY]: XML_NS_URL,
     // for CustomLabels, that's `labels`
-    labels: Array.from(children.values()),
+    labels: Array.from(children.values()).filter(customLabelHasFullName).sort(sortLabelsByFullName),
   },
 });
+
+type CustomLabelWithFullName = CustomLabel & { fullName: string };
+
+const sortLabelsByFullName = (a: CustomLabelWithFullName, b: CustomLabelWithFullName): number =>
+  a.fullName.localeCompare(b.fullName);

src/convert/transformers/decomposeLabelsTransformer.ts

@@ -6,7 +6,7 @@
  */
 
 import type { CustomLabel } from '@jsforce/jsforce-node/lib/api/metadata';
-import { SfError } from '@salesforce/core/sfError';
+import { customLabelHasFullName } from '../../utils/metadata';
 import { calculateRelativePath } from '../../utils/path';
 import { SourceComponent } from '../../resolve/sourceComponent';
 import { ToSourceFormatInput, WriteInfo } from '../types';
@@ -48,10 +48,3 @@ export class LabelMetadataTransformer extends DefaultMetadataTransformer {
 
   // toSourceFormat uses the default (merge them with the existing label)
 }
-
-const customLabelHasFullName = (label: CustomLabel): label is CustomLabel & { fullName: string } => {
-  if (label.fullName === undefined) {
-    throw SfError.create({ message: 'Label does not have a fullName', data: label });
-  }
-  return true;
-};

src/utils/metadata.ts

@@ -5,6 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
+import type { CustomLabel } from '@jsforce/jsforce-node/lib/api/metadata';
+import { SfError } from '@salesforce/core';
 import { META_XML_SUFFIX } from '../common';
 
 export function generateMetaXML(typeName: string, apiVersion: string, status: string): string {
@@ -25,3 +27,10 @@ export function generateMetaXMLPath(sourcePath: string): string {
 export function trimMetaXmlSuffix(sourcePath: string): string {
   return sourcePath.endsWith(META_XML_SUFFIX) ? sourcePath.replace(META_XML_SUFFIX, '') : sourcePath;
 }
+
+export const customLabelHasFullName = (label: CustomLabel): label is CustomLabel & { fullName: string } => {
+  if (label.fullName === undefined) {
+    throw SfError.create({ message: 'Label does not have a fullName', data: label });
+  }
+  return true;
+};