Add flag to output field security metadata

Use the includeFieldSecurityMetadata to cause the field output to show both the compliance category and security classification metadata if set to true.

Author: williamsalexisSFDC

src/cli/commands/markdown.ts

@@ -72,4 +72,9 @@ export const markdownOptions: Record<keyof CliConfigurableMarkdownConfig, Option
     describe: 'The title of the reference guide.',
     default: markdownDefaults.referenceGuideTitle,
   },
+  includeFieldSecurityMetadata: {
+    type: 'boolean',
+    describe: 'Whether to include the compliance category and security classification for fields in the generated files.',
+    default: markdownDefaults.includeFieldSecurityMetadata,
+  }
 };

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

@@ -56,6 +56,7 @@ export function generateDocs(bundles: UnparsedSourceBundle[], config?: Partial<M
     linkingStrategy: 'relative',
     excludeTags: [],
     referenceGuideTitle: 'Apex Reference Guide',
+    includeFieldSecurityMetadata: true,
     exclude: [],
     ...config,
   });

src/core/markdown/adapters/__tests__/interface-adapter.spec.ts

@@ -20,6 +20,7 @@ const defaultMarkdownGeneratorConfig: MarkdownGeneratorConfig = {
   sortAlphabetically: false,
   linkingStrategy: 'relative',
   referenceGuideTitle: 'Apex Reference Guide',
+  includeFieldSecurityMetadata: true,
   exclude: [],
   excludeTags: [],
 };

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

@@ -357,8 +357,8 @@ function fieldMetadataToRenderable(
     apiName: getApiName(field.name, config),
     fieldType: field.type,
     required: field.required,
-    complianceCategory: field.complianceCategory,
-    securityClassification: field.securityClassification,
+    complianceCategory: renderComplianceCategory(field.complianceCategory, config),
+    securityClassification: renderComplianceCategory(field.securityClassification, config),
     pickListValues: field.pickListValues
       ? {
           headingLevel: headingLevel + 1,
@@ -393,3 +393,11 @@ function getApiName(currentName: string, config: MarkdownGeneratorConfig) {
   }
   return currentName;
 }
+
+function renderComplianceCategory(complianceCategory: string | null, config: MarkdownGeneratorConfig) {
+  if(config.includeFieldSecurityMetadata) {
+    return complianceCategory;
+  } else {
+    return null;
+  }
+}

src/core/shared/types.d.ts

@@ -38,6 +38,7 @@ export type CliConfigurableMarkdownConfig = {
   includeMetadata: boolean;
   linkingStrategy: LinkingStrategy;
   referenceGuideTitle: string;
+  includeFieldSecurityMetadata: boolean;
 };
 
 export type UserDefinedMarkdownConfig = {

src/defaults.ts

@@ -19,6 +19,7 @@ export const markdownDefaults = {
   linkingStrategy: 'relative' as const,
   referenceGuideTitle: 'Reference Guide',
   excludeTags: [],
+  includeFieldSecurityMetadata: false,
 };
 
 export const openApiDefaults = {