Configurable custom object visibility

Author: cesarParra

src/cli/commands/markdown.ts

@@ -24,6 +24,14 @@ export const markdownOptions: Record<keyof CliConfigurableMarkdownConfig, Option
       'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
       'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled.',
   },
+  customObjectVisibility: {
+    type: 'string',
+    array: true,
+    alias: 'v',
+    default: markdownDefaults.customObjectVisibility,
+    choices: ['public', 'protected', 'packageprotected'],
+    describe: 'Controls which custom objects are documented. Values should be separated by a space.',
+  },
   defaultGroupName: {
     type: 'string',
     default: markdownDefaults.defaultGroupName,

src/core/changelog/generate-change-log.ts

@@ -71,7 +71,9 @@ function reflect(bundles: UnparsedSourceBundle[], config: Omit<UserDefinedChange
     reflectApexFiles(filterApexSourceFiles(bundles)),
     TE.chain((parsedApexFiles) => {
       return pipe(
-        reflectCustomFieldsAndObjectsAndMetadataRecords(filterCustomObjectsFieldsAndMetadataRecords(bundles)),
+        reflectCustomFieldsAndObjectsAndMetadataRecords(filterCustomObjectsFieldsAndMetadataRecords(bundles), [
+          'public', // TODO: Do not hardcode
+        ]),
         TE.map((parsedObjectFiles) => [...parsedApexFiles, ...parsedObjectFiles]),
       );
     }),

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

@@ -160,11 +160,25 @@ describe('When generating documentation', () => {
       expect(result).documentationBundleHasLength(0);
     });
 
-    it('does not return non-public custom objects', async () => {
-      const input = new CustomObjectXmlBuilder().withVisibility('Protected').build();
-
-      const result = await generateDocs([unparsedObjectBundleFromRawString({ rawContent: input, filePath: 'test' })])();
-      expect(result).documentationBundleHasLength(0);
+    describe('and the custom object visibility', () => {
+      it('is not set, it does not return non-public custom objects', async () => {
+        const input = new CustomObjectXmlBuilder().withVisibility('Protected').build();
+
+        const result = await generateDocs([
+          unparsedObjectBundleFromRawString({ rawContent: input, filePath: 'test' }),
+        ])();
+        expect(result).documentationBundleHasLength(0);
+      });
+
+      it('is configured, it respects the configured visibility', async () => {
+        const input = new CustomObjectXmlBuilder().withVisibility('Protected').build();
+
+        const result = await generateDocs(
+          [unparsedObjectBundleFromRawString({ rawContent: input, filePath: 'test' })],
+          { customObjectVisibility: ['protected'] },
+        )();
+        expect(result).documentationBundleHasLength(1);
+      });
     });
 
     it('do not return files that have an @ignore in the docs', async () => {

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

@@ -29,6 +29,7 @@ export function generateDocs(bundles: UnparsedSourceBundle[], config?: Partial<M
   return gen(bundles, {
     targetDir: 'target',
     scope: ['global', 'public'],
+    customObjectVisibility: ['public'],
     defaultGroupName: 'Miscellaneous',
     customObjectsGroupName: 'Custom Objects',
     sortAlphabetically: false,

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

@@ -11,6 +11,7 @@ function linkGenerator(type: string): string {
 const defaultMarkdownGeneratorConfig: MarkdownGeneratorConfig = {
   targetDir: '',
   scope: ['global', 'public'],
+  customObjectVisibility: ['public'],
   namespace: '',
   defaultGroupName: 'Miscellaneous',
   customObjectsGroupName: 'Custom Objects',

src/core/markdown/generate-docs.ts

@@ -63,7 +63,10 @@ export function generateDocs(unparsedBundles: UnparsedSourceBundle[], config: Ma
     generateForApex(filterApexSourceFiles(unparsedBundles), config),
     TE.chain((parsedApexFiles) => {
       return pipe(
-        reflectCustomFieldsAndObjectsAndMetadataRecords(filterCustomObjectsFieldsAndMetadataRecords(unparsedBundles)),
+        reflectCustomFieldsAndObjectsAndMetadataRecords(
+          filterCustomObjectsFieldsAndMetadataRecords(unparsedBundles),
+          config.customObjectVisibility,
+        ),
         TE.map((parsedObjectFiles) => [...parsedApexFiles, ...parsedObjectFiles]),
       );
     }),

src/core/reflection/sobject/reflectCustomFieldsAndObjectsAndMetadataRecords.ts

@@ -14,13 +14,16 @@ import { CustomMetadataMetadata, reflectCustomMetadataSources } from './reflect-
 
 export function reflectCustomFieldsAndObjectsAndMetadataRecords(
   objectBundles: (UnparsedCustomObjectBundle | UnparsedCustomFieldBundle | UnparsedCustomMetadataBundle)[],
+  visibilitiesToDocument: string[],
 ): TaskEither<ReflectionErrors, ParsedFile<CustomObjectMetadata>[]> {
   function filterNonPublished(parsedFiles: ParsedFile<CustomObjectMetadata>[]): ParsedFile<CustomObjectMetadata>[] {
     return parsedFiles.filter((parsedFile) => parsedFile.type.deploymentStatus === 'Deployed');
   }
 
   function filterNonPublic(parsedFiles: ParsedFile<CustomObjectMetadata>[]): ParsedFile<CustomObjectMetadata>[] {
-    return parsedFiles.filter((parsedFile) => parsedFile.type.visibility === 'Public');
+    return parsedFiles.filter((parsedFile) =>
+      visibilitiesToDocument.includes(parsedFile.type.visibility.toLowerCase()),
+    );
   }
 
   const customObjects = objectBundles.filter(

src/core/shared/types.d.ts

@@ -20,6 +20,7 @@ export type CliConfigurableMarkdownConfig = {
   sourceDir: string;
   targetDir: string;
   scope: string[];
+  customObjectVisibility: string[];
   namespace?: string;
   defaultGroupName: string;
   customObjectsGroupName: string;

src/defaults.ts

@@ -3,6 +3,7 @@ const commonDefaults = {
 };
 
 export const markdownDefaults = {
+  customObjectVisibility: ['public'],
   ...commonDefaults,
   scope: ['global'],
   defaultGroupName: 'Miscellaneous',