Make triggers group name configurable

Author: cesarParra

src/cli/commands/markdown.ts

@@ -42,6 +42,11 @@ export const markdownOptions: Record<keyof CliConfigurableMarkdownConfig, Option
     default: markdownDefaults.customObjectsGroupName,
     describe: 'The name under which custom objects will be grouped in the Reference Guide',
   },
+  triggersGroupName: {
+    type: 'string',
+    default: markdownDefaults.triggersGroupName,
+    describe: 'The name under which triggers will be grouped in the Reference Guide',
+  },
   namespace: {
     type: 'string',
     describe: 'The package namespace, if any. If provided, it will be added to the generated files.',

src/core/markdown/__test__/generating-reference-guide.spec.ts

@@ -1,7 +1,12 @@
 import { extendExpect } from './expect-extensions';
 import { pipe } from 'fp-ts/function';
 import * as E from 'fp-ts/Either';
-import { unparsedApexBundleFromRawString, generateDocs, unparsedObjectBundleFromRawString } from './test-helpers';
+import {
+  unparsedApexBundleFromRawString,
+  generateDocs,
+  unparsedObjectBundleFromRawString,
+  unparsedTriggerBundleFromRawString,
+} from './test-helpers';
 import { ReferenceGuidePageData } from '../../shared/types';
 import { assertEither } from '../../test-helpers/assert-either';
 import { CustomObjectXmlBuilder } from '../../test-helpers/test-data-builders/custom-object-xml-builder';
@@ -125,6 +130,22 @@ describe('When generating the Reference Guide', () => {
     );
   });
 
+  it('groups Triggers under the provided group', async () => {
+    const input = `
+      trigger TestTrigger on Account (before insert) {}
+      `;
+
+    const result = await generateDocs(
+      [unparsedTriggerBundleFromRawString({ rawContent: input, filePath: 'src/triggers/TestTrigger.trigger' })],
+      { triggersGroupName: 'MyTriggers' },
+    )();
+
+    expect(result).documentationBundleHasLength(1);
+    assertEither(result, (data) =>
+      expect((data.referenceGuide as ReferenceGuidePageData).content).toContain('## MyTriggers'),
+    );
+  });
+
   it('displays groups in alphabetical order', async () => {
     const input1 = `
       /**

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

@@ -1,4 +1,9 @@
-import { UnparsedApexBundle, UnparsedCustomObjectBundle, UnparsedSourceBundle } from '../../shared/types';
+import {
+  UnparsedApexBundle,
+  UnparsedCustomObjectBundle,
+  UnparsedSourceBundle,
+  UnparsedTriggerBundle,
+} from '../../shared/types';
 import { generateDocs as gen, MarkdownGeneratorConfig } from '../generate-docs';
 import { referenceGuideTemplate } from '../templates/reference-guide';
 
@@ -12,6 +17,19 @@ export function unparsedApexBundleFromRawString(raw: string, rawMetadata?: strin
   };
 }
 
+export function unparsedTriggerBundleFromRawString(meta: {
+  rawContent: string;
+  filePath: string;
+  name?: string;
+}): UnparsedTriggerBundle {
+  return {
+    type: 'trigger',
+    name: meta.name ?? 'TestTrigger',
+    filePath: meta.filePath,
+    content: meta.rawContent,
+  };
+}
+
 export function unparsedObjectBundleFromRawString(meta: {
   rawContent: string;
   filePath: string;
@@ -32,6 +50,7 @@ export function generateDocs(bundles: UnparsedSourceBundle[], config?: Partial<M
     customObjectVisibility: ['public'],
     defaultGroupName: 'Miscellaneous',
     customObjectsGroupName: 'Custom Objects',
+    triggersGroupName: 'Triggers',
     sortAlphabetically: false,
     referenceGuideTemplate: referenceGuideTemplate,
     linkingStrategy: 'relative',

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

@@ -15,6 +15,7 @@ const defaultMarkdownGeneratorConfig: MarkdownGeneratorConfig = {
   namespace: '',
   defaultGroupName: 'Miscellaneous',
   customObjectsGroupName: 'Custom Objects',
+  triggersGroupName: 'Triggers',
   referenceGuideTemplate: '',
   sortAlphabetically: false,
   linkingStrategy: 'relative',

src/core/shared/types.d.ts

@@ -25,6 +25,7 @@ export type CliConfigurableMarkdownConfig = {
   namespace?: string;
   defaultGroupName: string;
   customObjectsGroupName: string;
+  triggersGroupName: string;
   sortAlphabetically: boolean;
   includeMetadata: boolean;
   linkingStrategy: LinkingStrategy;

src/core/shared/utils.ts

@@ -54,8 +54,7 @@ export function getTypeGroup(
     case 'customobject':
       return config.customObjectsGroupName;
     case 'trigger':
-      // TODO: Avoid hardcoding this.
-      return 'Triggers';
+      return config.triggersGroupName;
     default:
       return getGroup(type, config);
   }

src/defaults.ts

@@ -13,6 +13,7 @@ export const markdownDefaults = {
   ...markdownAndChangelogDefaults,
   defaultGroupName: 'Miscellaneous',
   customObjectsGroupName: 'Custom Objects',
+  triggersGroupName: 'Triggers',
   includeMetadata: false,
   sortAlphabetically: false,
   linkingStrategy: 'relative' as const,