Merge pull request #213 from cesarParra/custom-object-mark-if-required

Marking required fields when generating custom field documentation

Author: cesarParra

examples/vitepress/docs/custom-objects/Event__c.md

@@ -22,6 +22,7 @@ Represents an event that people can register for.
 
 ---
 ### End Date
+**Required**
 
 **API Name**
 
@@ -33,6 +34,7 @@ Represents an event that people can register for.
 
 ---
 ### Location
+**Required**
 
 **API Name**
 
@@ -44,6 +46,7 @@ Represents an event that people can register for.
 
 ---
 ### Start Date
+**Required**
 
 **API Name**
 

examples/vitepress/docs/custom-objects/Price_Component__c.md

@@ -59,6 +59,7 @@ Use this when the Price Component represents a Flat Price. To represent a Percen
 
 ---
 ### Type
+**Required**
 
 **API Name**
 

examples/vitepress/docs/custom-objects/Product_Inline_Fields__c.md

@@ -35,6 +35,7 @@ The date the product got discontinued
 
 ---
 ### Name
+**Required**
 
 Product name
 
@@ -98,6 +99,7 @@ ReleaseDate
 
 ---
 ### Type
+**Required**
 
 **API Name**
 

examples/vitepress/docs/custom-objects/Product__c.md

@@ -22,6 +22,7 @@ Product that is sold or available for sale.
 
 ---
 ### Event
+**Required**
 
 **API Name**
 

examples/vitepress/docs/custom-objects/Sales_Order_Line__c.md

@@ -11,6 +11,7 @@ Represents a line item on a sales order.
 
 ## Fields
 ### Amount
+**Required**
 
 **API Name**
 
@@ -22,6 +23,7 @@ Represents a line item on a sales order.
 
 ---
 ### Product
+**Required**
 
 **API Name**
 
@@ -55,6 +57,7 @@ Represents a line item on a sales order.
 
 ---
 ### Type
+**Required**
 
 **API Name**
 

examples/vitepress/force-app/main/default/objects/Product_Inline_Fields__c/Product_Inline_Fields__c.object-meta.xml

@@ -78,7 +78,7 @@
         <isSortingDisabled>false</isSortingDisabled>
         <label>Name</label>
         <length>128</length>
-        <required>false</required>
+        <required>true</required>
         <type>Text</type>
         <unique>false</unique>
     </fields>

src/core/changelog/__test__/processing-changelog.spec.ts

@@ -34,6 +34,7 @@ class CustomFieldMetadataBuilder {
       name: this.name,
       description: this.description,
       parentName: 'MyObject',
+      required: false,
     };
   }
 }

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,
+    required: field.required,
     pickListValues: field.pickListValues
       ? {
           headingLevel: headingLevel + 1,

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

@@ -10,6 +10,9 @@ export const customObjectTemplate = `
 {{ heading fields.headingLevel fields.heading }}
 {{#each fields.value}}
 {{ heading headingLevel heading }}
+{{#if required}}
+**Required**
+{{/if}}
 
 {{#if description}}
 {{{renderContent description}}}

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

@@ -17,6 +17,7 @@ export type CustomFieldMetadata = {
   type?: string | null;
   parentName: string;
   pickListValues?: string[];
+  required: boolean;
 };
 
 export function reflectCustomFieldSources(
@@ -64,6 +65,7 @@ function toCustomFieldMetadata(parserResult: { CustomField: unknown }): CustomFi
     parserResult?.CustomField != null && typeof parserResult.CustomField === 'object' ? parserResult.CustomField : {};
   const defaultValues = {
     description: null,
+    required: false,
   };
 
   return {