Add lwcGroupName to defaults and update documentation for Lightning Web Components grouping

Author: cesarParra

README.md

@@ -153,6 +153,7 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
 | `--linkingStrategy`               | N/A   | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none`                                                                                                 | `relative`       | No       |
 | `--customObjectsGroupName`        | N/A   | The name under which custom objects will be grouped in the Reference Guide                                                                                                                               | `Custom Objects` | No       |
 | `--triggersGroupName`             | N/A   | The name under which triggers will be grouped in the Reference Guide                                                                                                                                     | `Triggers`       | No       |
+| `--lwcGroupName`                  | N/A   | The name under which Lightning Web Components will be grouped in the Reference Guide                                                                                                                     | `Triggers`       | No       |
 | `--includeFieldSecurityMetadata`  | N/A   | Whether to include the compliance category and security classification for fields in the generated files.                                                                                                | `false`          | No       |
 | `--includeInlineHelpTextMetadata` | N/A   | Whether to include the inline help text for fields in the generated files.                                                                                                                               | `false`          | No       |
 

src/cli/commands/markdown.ts

@@ -79,6 +79,11 @@ export const markdownOptions: Record<keyof CliConfigurableMarkdownConfig, Option
     default: markdownDefaults.triggersGroupName,
     describe: 'The name under which triggers will be grouped in the Reference Guide',
   },
+  lwcGroupName: {
+    type: 'string',
+    default: markdownDefaults.lwcGroupName,
+    describe: 'The name under which Lightning Web Components 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/shared/types.d.ts

@@ -9,7 +9,7 @@ import { LwcMetadata } from '../reflection/lwc/reflect-lwc-source';
 export type Generators = 'markdown' | 'openapi' | 'changelog';
 
 type LinkingStrategy =
-// Links will be generated using relative paths.
+  // Links will be generated using relative paths.
   | 'relative'
   // No links will be generated.
   // If the reference is found, the display name will be used.
@@ -38,6 +38,7 @@ export type CliConfigurableMarkdownConfig = {
   defaultGroupName: string;
   customObjectsGroupName: string;
   triggersGroupName: string;
+  lwcGroupName: string;
   sortAlphabetically: boolean;
   includeMetadata: boolean;
   linkingStrategy: LinkingStrategy;
@@ -135,10 +136,10 @@ export type UnparsedLightningComponentBundle = {
   filePath: string;
   content: string;
   metadataContent: string;
-}
+};
 
 type MetadataTypes =
-  'interface'
+  | 'interface'
   | 'class'
   | 'enum'
   | 'customobject'
@@ -167,7 +168,7 @@ export type ExternalMetadata = {
 export type TopLevelType = Type | CustomObjectMetadata | TriggerMetadata | LwcMetadata;
 
 export type ParsedType =
-  Type
+  | Type
   | CustomObjectMetadata
   | CustomFieldMetadata
   | CustomMetadataMetadata
@@ -176,7 +177,7 @@ export type ParsedType =
 
 export type ParsedFile<
   T extends ParsedType =
-      | Type
+    | Type
     | CustomObjectMetadata
     | CustomFieldMetadata
     | CustomMetadataMetadata

src/core/shared/utils.ts

@@ -19,25 +19,19 @@ export function isSkip(value: unknown): value is Skip {
   return Object.prototype.hasOwnProperty.call(value, '_tag') && (value as Skip)._tag === 'Skip';
 }
 
-export function isObjectType(
-  type: ParsedType
-): type is CustomObjectMetadata {
+export function isObjectType(type: ParsedType): type is CustomObjectMetadata {
   return (type as CustomObjectMetadata).type_name === 'customobject';
 }
 
 export function isApexType(type: ParsedType): type is Type {
   return !isObjectType(type) && !isTriggerType(type) && !isLwcType(type);
 }
 
-function isTriggerType(
-  type: ParsedType,
-): type is TriggerMetadata {
+function isTriggerType(type: ParsedType): type is TriggerMetadata {
   return type.type_name === 'trigger';
 }
 
-export function isLwcType(
-  type: ParsedType,
-): type is LwcMetadata {
+export function isLwcType(type: ParsedType): type is LwcMetadata {
   return type.type_name === 'lwc';
 }
 
@@ -59,7 +53,7 @@ export function getTypeGroup(type: TopLevelType, config: MarkdownGeneratorConfig
     case 'trigger':
       return config.triggersGroupName;
     case 'lwc':
-      return 'Lightning Web Components'; // TODO: Make this configurable?
+      return config.lwcGroupName;
     default:
       return getGroup(type, config);
   }

src/defaults.ts

@@ -14,6 +14,7 @@ export const markdownDefaults = {
   defaultGroupName: 'Miscellaneous',
   customObjectsGroupName: 'Custom Objects',
   triggersGroupName: 'Triggers',
+  lwcGroupName: 'Lightning Web Components',
   includeMetadata: false,
   sortAlphabetically: false,
   linkingStrategy: 'relative' as const,