Alphabetize methods

Author: TCourtneyOwen

packages/office-addin-manifest/src/manifestInfo.ts

@@ -32,10 +32,29 @@ function parseManifest(xml: Xml): ManifestInfo {
   return manifest;
 }
 
-async function readXmlFromManifestFile(manifestPath: string): Promise<Xml> {
-  const fileData: string = await readFileAsync(manifestPath, {encoding: "utf8"});
-  const xml = await parseXmlAsync(fileData, manifestPath);
-  return xml;
+export async function modifyManifestFile(manifestPath: string, guid?: string, displayName?: string): Promise<ManifestInfo> {
+  let manifestData: ManifestInfo = {};
+  if (manifestPath) {
+    if (!guid && !displayName) {
+      throw new Error("You need to specify something to change in the manifest.");
+    } else {
+      manifestData = await modifyManifestXml(manifestPath, guid, displayName);
+      await writeManifestData(manifestPath, manifestData);
+      return await readManifestFile(manifestPath);
+    }
+  } else {
+    throw new Error(`Please provide the path to the manifest file.`);
+  }
+}
+
+async function modifyManifestXml(manifestPath: string, guid?: string, displayName?: string): Promise<Xml> {
+  try {
+    const manifestXml: Xml = await readXmlFromManifestFile(manifestPath);
+    setModifiedXmlData(manifestXml.OfficeApp, guid, displayName);
+    return manifestXml;
+  } catch (err) {
+    throw new Error(`Unable to modify xml data for manifest file: ${manifestPath}. \n${err}`);
+  }
 }
 
 async function parseXmlAsync(xmlString: string, manifestPath: string): Promise<Xml> {
@@ -60,28 +79,22 @@ export async function readManifestFile(manifestPath: string): Promise<ManifestIn
   }
 }
 
-export async function modifyManifestFile(manifestPath: string, guid?: string, displayName?: string): Promise<ManifestInfo> {
-  let manifestData: ManifestInfo = {};
-  if (manifestPath) {
-    if (!guid && !displayName) {
-      throw new Error("You need to specify something to change in the manifest.");
-    } else {
-      manifestData = await modifyManifestXml(manifestPath, guid, displayName);
-      await writeManifestData(manifestPath, manifestData);
-      return await readManifestFile(manifestPath);
+async function readXmlFromManifestFile(manifestPath: string): Promise<Xml> {
+  const fileData: string = await readFileAsync(manifestPath, {encoding: "utf8"});
+  const xml = await parseXmlAsync(fileData, manifestPath);
+  return xml;
+}
+
+function setModifiedXmlData(xml: any, guid: string | undefined, displayName: string | undefined) {
+  if (guid) {
+    if (guid === "random") {
+      guid = uuid();
     }
-  } else {
-    throw new Error(`Please provide the path to the manifest file.`);
+    xmlMethods.setXmlElementValue(xml, "Id", guid);
   }
-}
 
-async function modifyManifestXml(manifestPath: string, guid?: string, displayName?: string): Promise<Xml> {
-  try {
-    const manifestXml: Xml = await readXmlFromManifestFile(manifestPath);
-    setModifiedXmlData(manifestXml.OfficeApp, guid, displayName);
-    return manifestXml;
-  } catch (err) {
-    throw new Error(`Unable to modify xml data for manifest file: ${manifestPath}. \n${err}`);
+  if (displayName) {
+    xmlMethods.setXmlElementAttributeValue(xml, "DisplayName", displayName);
   }
 }
 
@@ -103,16 +116,3 @@ async function writeManifestData(manifestPath: string, manifestData: any): Promi
       throw new Error(`Unable to write to file. ${manifestPath} \n${err}`);
     }
 }
-
-function setModifiedXmlData(xml: any, guid: string | undefined, displayName: string | undefined) {
-  if (guid) {
-    if (guid === "random") {
-      guid = uuid();
-    }
-    xmlMethods.setXmlElementValue(xml, "Id", guid);
-  }
-
-  if (displayName) {
-    xmlMethods.setElementAttributeValue(xml, "DisplayName", displayName);
-  }
-}

packages/office-addin-manifest/src/xml.ts

@@ -5,7 +5,7 @@ export function getXmlAttributeValue(xml: any, name: string): string | undefined
       // reading xml values is resilient to errors but you can uncomment the next line for debugging if attributes are missing
       // console.error(`Unable to get xml attribute value "${name}". ${err}`);
     }
-  }
+}
 
 export function getXmlElementAttributeValue(xml: any, elementName: string, attributeName: string = "DefaultValue"): string | undefined {
   const element = getXmlElementValue(xml, elementName);
@@ -25,12 +25,12 @@ export function getXmlElementValue(xml: any, name: string): string | undefined {
     // reading xml values is resilient to errors but you can uncomment the next line for debugging if elements are missing
     // console.error(`Unable to get xml element value "${name}". ${err}`);
     }
-  }
-
-export function setXmlElementValue(xml: any, elementName: string, input: any) {
-  xml[elementName] = input;
 }
 
-export function setElementAttributeValue(xml: any, elementName: string, input: string | undefined, attributeName: string = "DefaultValue") {
+export function setXmlElementAttributeValue(xml: any, elementName: string, input: string | undefined, attributeName: string = "DefaultValue") {
   xml[elementName][0].$[attributeName] = input;
 }
+
+export function setXmlElementValue(xml: any, elementName: string, input: any) {
+  xml[elementName] = input;
+}