feat: render picklist values in doc template

Author: RaviVaranasi

src/core/markdown/__test__/generating-custom-object-docs.spec.ts

@@ -1,6 +1,7 @@
 import { extendExpect } from './expect-extensions';
 import {
   customField,
+  customFieldPickListValues,
   customObjectGenerator,
   generateDocs,
   unparsedFieldBundleFromRawString,
@@ -46,7 +47,7 @@ describe('Generates Custom Object documentation', () => {
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('`TestObject__c`'));
     });
-
+    
     it('displays the Fields heading if fields are present', async () => {
       const customObjectBundle = unparsedObjectBundleFromRawString({
         rawContent: customObjectGenerator(),
@@ -64,6 +65,25 @@ describe('Generates Custom Object documentation', () => {
       assertEither(result, (data) => expect(data).firstDocContains('## Fields'));
     });
 
+    it('displays the pick list values name', async () => {
+      const customObjectBundle = unparsedObjectBundleFromRawString({
+        rawContent: customObjectGenerator(),
+        filePath: 'src/object/TestObject__c.object-meta.xml',
+      });
+
+      const customFieldBundle = unparsedFieldBundleFromRawString({
+        rawContent: customFieldPickListValues,
+        filePath: 'src/object/TestField__c.field-meta.xml',
+        parentName: 'TestObject__c',
+      });
+
+      const result = await generateDocs([customObjectBundle, customFieldBundle])();
+      expect(result).documentationBundleHasLength(1);
+      assertEither(result, (data) => expect(data).firstDocContains('* Staging'));
+      assertEither(result, (data) => expect(data).firstDocContains('* Active'));
+      assertEither(result, (data) => expect(data).firstDocContains('* Inactive'));
+    });
+
     it('does not display the Fields heading if no fields are present', async () => {
       const input = unparsedObjectBundleFromRawString({
         rawContent: customObjectGenerator(),

src/core/markdown/__test__/test-helpers.ts

@@ -84,3 +84,36 @@ export const customField = `
     <type>Url</type>
     <description>A URL that points to a photo</description>
 </CustomField>`;
+
+export const customFieldPickListValues = `
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
+    <fullName>Status__c</fullName>
+          <externalId>false</externalId>
+          <label>Status</label>
+          <required>true</required>
+          <trackFeedHistory>false</trackFeedHistory>
+          <description>Status</description>
+          <type>Picklist</type>
+          <valueSet>
+              <restricted>true</restricted>
+              <valueSetDefinition>
+                  <sorted>false</sorted>
+                  <value>
+                      <fullName>Staging</fullName>
+                      <default>false</default>
+                      <label>Staging</label>
+                  </value>
+                  <value>
+                      <fullName>Active</fullName>
+                      <default>false</default>
+                      <label>Active</label>
+                  </value>
+                  <value>
+                      <fullName>Inactive</fullName>
+                      <default>false</default>
+                      <label>Inactive</label>
+                  </value>
+              </valueSetDefinition>
+          </valueSet>
+</CustomField>`;

src/core/markdown/adapters/type-to-renderable.ts

@@ -281,6 +281,7 @@ function fieldMetadataToRenderable(
     description: field.description ? [field.description] : [],
     apiName: getApiName(field.name, config),
     fieldType: field.type,
+    pickListValues: field.pickListValues
   };
 }
 

src/core/markdown/templates/custom-object-template.ts

@@ -23,6 +23,9 @@ export const customObjectTemplate = `
 **Type**
 
 *{{fieldType}}*
+{{#each pickListValues}}
+* {{this}}
+{{/each}}
 {{/if}}
 
 {{#unless @last}}---{{/unless}}

src/core/reflection/sobject/reflect-custom-field-source.ts

@@ -66,7 +66,7 @@ function toCustomFieldMetadata(parserResult: { CustomField: unknown }): CustomFi
   };
 
   const pickListValues =
-    isCustomField(customField) && customField.type === 'Picklist' ? toPickListValues(customField) : [];
+    hasType(customField) && customField.type?.toLowerCase() === 'picklist' ? toPickListValues(customField) : [];
   return { ...defaultValues, ...customField, type_name: 'customfield', pickListValues } as CustomFieldMetadata;
 }
 
@@ -85,7 +85,7 @@ function toPickListValues(customField: object): string[] {
   return [];
 }
 
-function isCustomField(customField: object): customField is CustomFieldMetadata {
+function hasType(customField: object): customField is CustomFieldMetadata {
   return (customField as CustomFieldMetadata).type != undefined;
 }
 

src/core/renderables/types.d.ts

@@ -189,6 +189,7 @@ export type RenderableCustomField = {
   heading: string;
   apiName: string;
   description: RenderableContent[];
+  pickListValues: string[];
   type: 'field';
   fieldType?: string | null;
 };