Use a constant for the metadata property definition instead of a function that returns a static string

Author: jeskew

packages/service-types-generator/__tests__/Components/Type/Exception.ts

@@ -1,9 +1,9 @@
 import {Exception} from "../../../lib/Components/Type/Exception";
 import {IndentedSection} from "../../../lib/Components/IndentedSection";
 import {
-    getOutputMetadataPropertyDefinition,
-    METADATA_PROPERTY_IMPORT
-} from "../../../lib/Components/Type/getOutputMetadataPropertyDefinition";
+    METADATA_PROPERTY_IMPORT,
+    OUTPUT_METADATA_PROPERTY,
+} from "../../../lib/Components/Type/constants";
 
 describe('Exception', () => {
     it('should include standard exception members if not defined', () => {
@@ -38,7 +38,7 @@ export interface MyException {
      */
     message?: string;
     
-${new IndentedSection(getOutputMetadataPropertyDefinition())}
+${new IndentedSection(OUTPUT_METADATA_PROPERTY)}
 }`
         );
     });
@@ -82,7 +82,7 @@ export interface MyException {
      */
     message?: string;
     
-${new IndentedSection(getOutputMetadataPropertyDefinition())}
+${new IndentedSection(OUTPUT_METADATA_PROPERTY)}
 }`
         );
     });
@@ -126,7 +126,7 @@ export interface MyException {
      */
     name?: string;
     
-${new IndentedSection(getOutputMetadataPropertyDefinition())}
+${new IndentedSection(OUTPUT_METADATA_PROPERTY)}
 }`
         );
     });
@@ -170,7 +170,7 @@ export interface MyException {
      */
     stack?: string;
     
-${new IndentedSection(getOutputMetadataPropertyDefinition())}
+${new IndentedSection(OUTPUT_METADATA_PROPERTY)}
 }`
         );
     });

packages/service-types-generator/__tests__/Components/Type/Output.ts

@@ -14,8 +14,8 @@ import {
 import {IndentedSection} from "../../../lib/Components/IndentedSection";
 import {
     METADATA_PROPERTY_IMPORT,
-    getOutputMetadataPropertyDefinition
-} from "../../../lib/Components/Type/getOutputMetadataPropertyDefinition";
+    OUTPUT_METADATA_PROPERTY,
+} from "../../../lib/Components/Type/constants";
 
 describe('Output', () => {
     it(
@@ -37,7 +37,7 @@ describe('Output', () => {
  * Operation output
  */
 export interface ${name} {
-${new IndentedSection(getOutputMetadataPropertyDefinition())}
+${new IndentedSection(OUTPUT_METADATA_PROPERTY)}
 }`
             );
         }
@@ -71,7 +71,7 @@ export interface ${name}<${GENERIC_STREAM_TYPE}> {
      */
     data?: ${getMemberType(StreamingBlob)};
     
-${new IndentedSection(getOutputMetadataPropertyDefinition())}
+${new IndentedSection(OUTPUT_METADATA_PROPERTY)}
 }`
             );
         }
@@ -108,7 +108,7 @@ export interface ${name}<${GENERIC_STREAM_TYPE}> {
      */
     data?: ${getMemberType(dataMember.shape, dataMember)};
     
-${new IndentedSection(getOutputMetadataPropertyDefinition())}
+${new IndentedSection(OUTPUT_METADATA_PROPERTY)}
 }`
             );
         }
@@ -148,7 +148,7 @@ export interface ${name} {
      */
     data?: ${getMemberType(structure)};
     
-${new IndentedSection(getOutputMetadataPropertyDefinition())}
+${new IndentedSection(OUTPUT_METADATA_PROPERTY)}
 }`
         );
     });
@@ -195,7 +195,7 @@ export interface ${name} {
      */
     data?: ${getMemberType(structureList)};
     
-${new IndentedSection(getOutputMetadataPropertyDefinition())}
+${new IndentedSection(OUTPUT_METADATA_PROPERTY)}
 }`
         );
     });
@@ -253,7 +253,7 @@ export interface ${name} {
      */
     data?: ${getMemberType(structureMap)};
     
-${new IndentedSection(getOutputMetadataPropertyDefinition())}
+${new IndentedSection(OUTPUT_METADATA_PROPERTY)}
 }`
         );
     });

packages/service-types-generator/lib/Components/Type/Exception.ts

@@ -4,9 +4,9 @@ import {IndentedSection} from "../IndentedSection";
 import {getUnmarshalledShapeName} from "./helpers";
 import {Import} from "../Import";
 import {
-    getOutputMetadataPropertyDefinition,
     METADATA_PROPERTY_IMPORT,
-} from "./getOutputMetadataPropertyDefinition";
+    OUTPUT_METADATA_PROPERTY,
+} from "./constants";
 
 interface InnateMember {
     memberName: string;
@@ -22,7 +22,7 @@ export class Exception extends Structure {
             .concat(
                 Object.keys(this.shape.members)
                     .map(this.getMemberDefinition, this),
-                getOutputMetadataPropertyDefinition()
+                OUTPUT_METADATA_PROPERTY
             );
         return `
 ${this.imports}

packages/service-types-generator/lib/Components/Type/Output.ts

@@ -4,9 +4,9 @@ import {GENERIC_STREAM_TYPE} from '../../constants';
 import {IndentedSection} from "../IndentedSection";
 import {getUnmarshalledShapeName, hasStreamingBody} from "./helpers";
 import {
-    getOutputMetadataPropertyDefinition,
     METADATA_PROPERTY_IMPORT,
-} from './getOutputMetadataPropertyDefinition';
+    OUTPUT_METADATA_PROPERTY,
+} from './constants';
 
 export class Output extends Structure {
     toString(): string {
@@ -18,7 +18,7 @@ export interface ${this.shape.name}${hasStreamingBody(this.shape) ? `<${GENERIC_
 ${new IndentedSection(
     Object.keys(this.shape.members)
         .map(this.getMemberDefinition, this)
-        .concat(getOutputMetadataPropertyDefinition())
+        .concat(OUTPUT_METADATA_PROPERTY)
         .join('\n\n')
 )}
 }

packages/service-types-generator/lib/Components/Type/getOutputMetadataPropertyDefinition.ts renamed to packages/service-types-generator/lib/Components/Type/constants.ts

@@ -7,12 +7,10 @@ export const METADATA_PROPERTY_IMPORT = new Import(
     `ResponseMetadata as ${MD_PROP_ALIAS}`
 );
 
-export function getOutputMetadataPropertyDefinition(): string {
-    return `
+export const OUTPUT_METADATA_PROPERTY = `
 /**
  * Metadata about the response received, including the HTTP status code, HTTP
  * headers, and any request identifiers recognized by the SDK.
  */
 $metadata: ${MD_PROP_ALIAS};
-    `.trim();
-}
+`.trim();