@cparra/apexdocs 3.15.0-alpha.1 → 3.15.0-beta.0

package/README.md

@@ -18,14 +18,14 @@ create a documentation site that fits your needs, hosted in any static web hosti
 - [🚀 Features](#-features)
 - [💿 Installation](#-installation)
 - [⚡ Quick Start](#-quick-start)
-  - [CLI](#cli)
-    - [Markdown](#markdown)
-    - [OpenApi](#openapi)
-    - [Changelog](#changelog)
+    - [CLI](#cli)
+        - [Markdown](#markdown)
+        - [OpenApi](#openapi)
+        - [Changelog](#changelog)
 - [▶️ Available Commands](#️-available-commands)
-  - [Markdown](#markdown-1)
-  - [OpenApi](#openapi-1)
-  - [Changelog](#changelog-1)
+    - [Markdown](#markdown-1)
+    - [OpenApi](#openapi-1)
+    - [Changelog](#changelog-1)
 - [🔬 Defining a configuration file](#-defining-a-configuration-file)
 - [🌐 Translation](#-translation)
 - [⤵︎ Importing to your project](#︎-importing-to-your-project)
@@ -77,7 +77,7 @@ Here are some live projects using ApexDocs:
 
 ## 🚀 Features
 
-* Generate documentation for Salesforce Apex classes as Markdown files
+* Generate documentation for Salesforce code (Apex, triggers, custom objects, LWCs) as Markdown files
 * Generate an OpenApi REST specification based on `@RestResource` classes
 * Generate a changelog based on the differences between two versions of your Salesforce Apex classes
 * Support for grouping blocks of related code within a class
@@ -110,7 +110,7 @@ apexdocs markdown -s force-app
 apexdocs markdown --useSfdxProjectJson
 
 # Specify multiple source directories
-apexdocs markdown --sourceDirs force-app force-lwc force-utils
+apexdocs markdown --sourceDir force-app force-lwc force-utils
 ```
 
 #### OpenApi
@@ -140,9 +140,8 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
 
 | Flag                              | Alias | Description                                                                                                                                                                                              | Default          | Required |
 |-----------------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------|
-| `--sourceDir`                     | `-s`  | The directory where the source files are located.                                                                                                                                                        | N/A              | *        |
-| `--sourceDirs`                    | N/A   | Multiple source directories (space-separated). Cannot be used with `--sourceDir` or `--useSfdxProjectJson`.                                                                                              | N/A              | *        |
-| `--useSfdxProjectJson`            | N/A   | Read source directories from `sfdx-project.json` packageDirectories. Cannot be used with `--sourceDir` or `--sourceDirs`.                                                                                | `false`          | *        |
+| `--sourceDir`                     | `-s`  | The directory or directories where the source files are located.                                                                                                                                         | N/A              | *        |
+| `--useSfdxProjectJson`            | N/A   | Read source directories from `sfdx-project.json` packageDirectories. Cannot be used with `--sourceDir`.                                                                                                  | `false`          | *        |
 | `--sfdxProjectPath`               | N/A   | Path to directory containing `sfdx-project.json` (defaults to current directory). Only used with `--useSfdxProjectJson`.                                                                                 | `process.cwd()`  | No       |
 | `--targetDir`                     | `-t`  | The directory where the generated files will be placed.                                                                                                                                                  | `docs`           | No       |
 | `--scope`                         | `-p`  | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible.                                                                                      | `[global]`       | No       |
@@ -150,18 +149,16 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
 | `--defaultGroupName`              | N/A   | The default group name to use when a group is not specified.                                                                                                                                             | `Miscellaneous`  | No       |
 | `--namespace`                     | N/A   | The package namespace, if any. If provided, it will be added to the generated files.                                                                                                                     | N/A              | No       |
 | `--sortAlphabetically`            | N/A   | Sorts files appearing in the Reference Guide alphabetically, as well as the members of a class, interface or enum alphabetically. If false, the members will be displayed in the same order as the code. | `false`          | No       |
-| `--includeMetadata `              | N/A   | Whether to include the file's meta.xml information: Whether it is active and and the API version                                                                                                         | `false`          | No       |
+| `--includeMetadata `              | N/A   | Whether to include the file's meta.xml information: Whether it is active and the API version                                                                                                             | `false`          | No       |
 | `--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       |
-|| `--parallelProcessing`            | N/A   | Whether to use parallel processing for reflection operations.                                                                                                                                            | `true`           | No       |
-|| `--workerThreads`                 | N/A   | Number of worker threads to use for parallel processing (defaults to number of CPU cores).                                                                                                              | CPU cores        | No       |
+| `--includeInlineHelpTextMetadata` | N/A   | Whether to include the inline help text for fields in the generated files.                                                                                                                               | `false`          | No       |
 
 > **Note:** The `*` in the Required column indicates that **one** of the source directory options must be specified:
-> - `--sourceDir` (single directory)
-> - `--sourceDirs` (multiple directories)
+> - `--sourceDir` (single directory or array of directories)
 > - `--useSfdxProjectJson` (read from sfdx-project.json)
 >
 > These options are mutually exclusive - you cannot use more than one at the same time.
@@ -235,9 +232,7 @@ apexdocs openapi -s force-app -t docs -n MyNamespace --title "My Custom OpenApi
 | `--fileName`               | N/A   | The name of the changelog file to be generated.                                      | `changelog` | No       |
 | `--scope`                  | N/A   | The list of scope to respect when generating the changelog.                          | ['global']  | No       |
 | `--customObjectVisibility` | `-v`  | Controls which custom objects are documented. Values should be separated by a space. | ['public']  | No       |
-|| `--skipIfNoChanges`        | N/A   | Whether to skip generating the changelog if there are no changes.                    | `true`      | No       |
-|| `--parallelProcessing`     | N/A   | Whether to use parallel processing for reflection operations.                         | `true`      | No       |
-|| `--workerThreads`          | N/A   | Number of worker threads to use for parallel processing (defaults to number of CPU cores). | CPU cores   | No       |
+| `--skipIfNoChanges`        | N/A   | Whether to skip generating the changelog if there are no changes.                    | `true`      | No       |
 
 #### Sample Usage
 
@@ -247,62 +242,6 @@ apexdocs changelog -p force-app-previous -t force-app
 
 ---
 
-## ⚡ Parallel Processing
-
-ApexDocs supports parallel processing for reflection operations, significantly improving performance when processing large numbers of Apex files. This feature uses Node.js Worker Threads to process files in parallel while maintaining full compatibility with existing configurations.
-
-### Key Features
-
-- **Automatic**: Enabled by default in production environments
-- **Adaptive**: Automatically chooses between parallel and sequential processing based on file count and environment
-- **Configurable**: Control the number of worker threads used
-- **Safe**: Automatically disabled during tests to prevent interference
-
-### Configuration
-
-```typescript
-import { defineMarkdownConfig } from '@cparra/apexdocs';
-
-export default defineMarkdownConfig({
-  sourceDir: 'force-app',
-  targetDir: 'docs',
-  
-  // Enable/disable parallel processing (default: true in production)
-  parallelProcessing: true,
-  
-  // Set number of worker threads (default: CPU cores)
-  workerThreads: 4,
-});
-```
-
-### CLI Usage
-
-```bash
-# Use parallel processing (default)
-apexdocs markdown -s force-app
-
-# Disable parallel processing
-apexdocs markdown -s force-app --parallelProcessing false
-
-# Set custom worker thread count
-apexdocs markdown -s force-app --workerThreads 8
-```
-
-### Performance Benefits
-
-- **Large codebases**: Significant performance improvements for projects with many files
-- **Multi-core systems**: Better utilization of available CPU cores
-- **CI/CD pipelines**: Faster documentation generation in automated environments
-
-### When It's Used
-
-- **Parallel**: Multiple files + production environment + parallel enabled
-- **Sequential**: Single file OR test environment OR parallel disabled
-
-For more detailed information, see [PARALLEL_PROCESSING.md](PARALLEL_PROCESSING.md).
-
----
-
 ## 🔬 Defining a configuration file
 
 You can also use a configuration file to define the parameters that will be used when generating the documentation.
@@ -398,6 +337,15 @@ Then you only need to run the top level `apexdocs` command, and it will generate
 Note that you can still run the individual commands if you only want to generate one type of documentation by
 providing the subcommand, e.g `apexdocs markdown` or `apexdocs changelog`.
 
+### LWC Documentation Limitations
+
+ApexDocs supports generating documentation for Lightning Web Components (LWC) as well, but please
+be aware of the following limitations:
+
+* Only components marked as `isExposed=true` in the component's meta.xml file will be documented.
+* At the moment, any JSDoc comments are ignored, documentation is based solely on the component's metadata.
+* Changelog generation does not include changes to LWCs.
+
 ### Excluding Files from Being Documented
 
 Any pattern included in the `.forceignore` file will be excluded from the documentation.
@@ -456,61 +404,6 @@ There are hooks for both Markdown and Changelog operations (but not for OpenApi)
 
 #### Markdown Hooks
 
-##### **macros**
-
-Allows defining custom macros that can be used in the documentation.
-
-Macros are reusable pieces of text that can be injected into the documentation,
-allowing you to define common pieces of text that you can use across multiple files.
-
-A common use case is injecting copyright or license information, without
-having to copy-paste the same text across multiple classes, polluting your
-source code.
-
-A macro can be defined in your documentation using the `{{macro_name}}` syntax.
-In the configuration file, you can then define the macro behavior as a key-value pair, where the key is the name of the
-macro, and the value is a function that returns the text to inject in place of the macro.
-
-**Type**
-
-```typescript
-type MacroSourceMetadata = {
-  type: 'apex' | 'customobject' | 'customfield' | 'custommetadata' | 'trigger';
-  name: string;
-  filePath: string;
-};
-
-type MacroFunction = (metadata: MacroSourceMetadata) => string;
-```
-
-Notice that the `metadata` object contains information about the source of the file for which the macro is being
-injected. This allows you to optionally
-return different text based on the source of the file.
-
-Example: Injecting a copyright notice
-
-```typescript
-//...
-macros: {
-  copyright: () => {
-    return `@copyright Copyright (c) ${new Date().getFullYear()} My Name`;
-  }
-}
-//...
-```
-
-And then in your source code, you can use the macro like this:
-
-```apex
-/**
- * {{copyright}}
- * @description This is a class
- */
-public class MyClass {
-    //...
-}
-```
-
 ##### **transformReferenceGuide**
 
 Allows changing the frontmatter and content of the reference guide, or if creating a reference guide page altogether
@@ -623,6 +516,61 @@ export default {
 };
 ```
 
+##### **macros**
+
+Allows defining custom macros that can be used in the documentation.
+
+Macros are reusable pieces of text that can be injected into the documentation,
+allowing you to define common pieces of text that you can use across multiple files.
+
+A common use case is injecting copyright or license information, without
+having to copy-paste the same text across multiple classes, polluting your
+source code.
+
+A macro can be defined in your documentation using the `{{macro_name}}` syntax.
+In the configuration file, you can then define the macro behavior as a key-value pair, where the key is the name of the
+macro, and the value is a function that returns the text to inject in place of the macro.
+
+**Type**
+
+```typescript
+type MacroSourceMetadata = {
+  type: 'apex' | 'customobject' | 'customfield' | 'custommetadata' | 'trigger' | 'lwc';
+  name: string;
+  filePath: string;
+};
+
+type MacroFunction = (metadata: MacroSourceMetadata) => string;
+```
+
+Notice that the `metadata` object contains information about the source of the file for which the macro is being
+injected. This allows you to optionally
+return different text based on the source of the file.
+
+Example: Injecting a copyright notice
+
+```typescript
+//...
+macros: {
+  copyright: () => {
+    return `@copyright Copyright (c) ${new Date().getFullYear()} My Name`;
+  }
+}
+//...
+```
+
+And then in your source code, you can use the macro like this:
+
+```apex
+/**
+ * {{copyright}}
+ * @description This is a class
+ */
+public class MyClass {
+    //...
+}
+```
+
 #### Changelog Hooks
 
 ##### **transformChangeLogPage**

package/dist/cli/generate.js

@@ -1,26 +1,23 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger$1 = require('../logger-B7fARcrW.js');
-var require$$0 = require('yargs');
+var logger$1 = require('../logger-DaV___bL.js');
 var cosmiconfig = require('cosmiconfig');
+var yargs = require('yargs');
 var E = require('fp-ts/Either');
 var cosmiconfigTypescriptLoader = require('cosmiconfig-typescript-loader');
 var _function = require('fp-ts/function');
 require('fp-ts/TaskEither');
 require('js-yaml');
 require('path');
+require('fp-ts/Task');
+require('fp-ts/lib/Array');
+require('@cparra/apex-reflection');
 require('fp-ts/Option');
+require('fast-xml-parser');
 require('handlebars');
 require('fp-ts/boolean');
-require('fast-xml-parser');
-require('fp-ts/Task');
 require('fp-ts/Array');
-require('worker_threads');
-require('os');
-require('fp-ts/lib/Array');
-require('@cparra/apex-reflection');
-require('uuid');
 require('fs');
 require('fp-ts/lib/TaskEither');
 require('minimatch');
@@ -111,6 +108,11 @@ const markdownOptions = {
     default: logger$1.markdownDefaults.triggersGroupName,
     describe: "The name under which triggers will be grouped in the Reference Guide"
   },
+  lwcGroupName: {
+    type: "string",
+    default: logger$1.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."
@@ -144,15 +146,6 @@ const markdownOptions = {
   includeInlineHelpTextMetadata: {
     type: "boolean",
     describe: "Whether to include the inline help text for fields in the generated files."
-  },
-  parallelProcessing: {
-    type: "boolean",
-    describe: "Whether to use parallel processing for reflection operations.",
-    default: logger$1.markdownDefaults.parallelProcessing
-  },
-  workerThreads: {
-    type: "number",
-    describe: "Number of worker threads to use for parallel processing (defaults to number of CPU cores)."
   }
 };
 
@@ -268,15 +261,6 @@ const changeLogOptions = {
     type: "boolean",
     default: logger$1.changeLogDefaults.skipIfNoChanges,
     describe: "Skip the changelog generation if there are no changes between the previous and current version."
-  },
-  parallelProcessing: {
-    type: "boolean",
-    describe: "Whether to use parallel processing for reflection operations.",
-    default: logger$1.changeLogDefaults.parallelProcessing
-  },
-  workerThreads: {
-    type: "number",
-    describe: "Number of worker threads to use for parallel processing (defaults to number of CPU cores)."
   }
 };
 
@@ -319,7 +303,6 @@ var __async$1 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const yargs = require$$0;
 const configOnlyMarkdownDefaults = {
   targetGenerator: "markdown",
   excludeTags: [],

package/dist/index.d.ts

@@ -121,6 +121,12 @@ type Translations = {
             inheritance: string;
             implements: string;
         };
+        lwc: {
+            exposed: string;
+            targets: string;
+            targetConfigs: string;
+            properties: string;
+        };
     };
 };
 
@@ -149,7 +155,7 @@ type LinkingStrategy =
   | 'none';
 
 type MacroSourceMetadata = {
-  type: 'apex' | 'customobject' | 'customfield' | 'custommetadata' | 'trigger';
+  type: 'apex' | 'customobject' | 'customfield' | 'custommetadata' | 'trigger' | 'lwc';
   name: string;
   filePath: string;
 };
@@ -167,14 +173,13 @@ type CliConfigurableMarkdownConfig = {
   defaultGroupName: string;
   customObjectsGroupName: string;
   triggersGroupName: string;
+  lwcGroupName: string;
   sortAlphabetically: boolean;
   includeMetadata: boolean;
   linkingStrategy: LinkingStrategy;
   referenceGuideTitle: string;
   includeFieldSecurityMetadata: boolean;
   includeInlineHelpTextMetadata: boolean;
-  parallelProcessing?: boolean;
-  workerThreads?: number;
 };
 
 type UserDefinedMarkdownConfig = {
@@ -209,13 +214,19 @@ type UserDefinedChangelogConfig = {
   exclude: string[];
   skipIfNoChanges: boolean;
   translations?: UserTranslations['changelog'];
-  parallelProcessing?: boolean;
-  workerThreads?: number;
 } & Partial<ChangelogConfigurableHooks>;
 
 type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig | UserDefinedChangelogConfig;
 
-type MetadataTypes = 'interface' | 'class' | 'enum' | 'customobject' | 'customfield' | 'custommetadata' | 'trigger';
+type MetadataTypes =
+  | 'interface'
+  | 'class'
+  | 'enum'
+  | 'customobject'
+  | 'customfield'
+  | 'custommetadata'
+  | 'trigger'
+  | 'lwc';
 
 type SourceFileMetadata = {
   filePath: string;
@@ -262,7 +273,7 @@ type DocPageData = {
   outputDocPath: string;
   frontmatter: Frontmatter;
   content: string;
-  type: 'class' | 'interface' | 'enum' | 'customobject' | 'trigger';
+  type: 'class' | 'interface' | 'enum' | 'customobject' | 'trigger' | 'lwc';
 };
 
 type FileChange = {
@@ -390,4 +401,5 @@ type ConfigurableChangelogConfig = Omit<Partial<UserDefinedChangelogConfig>, 'ta
  */
 declare function defineChangelogConfig(config: ConfigurableChangelogConfig): Partial<UserDefinedChangelogConfig>;
 
-export { type ChangeLogPageData, type ChangelogConfigurableHooks, type ConfigurableChangelogConfig, type ConfigurableDocPageData, type ConfigurableDocPageReference, type ConfigurableMarkdownConfig, type ConfigurableOpenApiConfig, type DocPageData, type DocPageReference, type MacroFunction, type MacroSourceMetadata, type MarkdownConfigurableHooks, type ReferenceGuidePageData, type Skip, type SourceChangelog, type TransformChangelogPage, type TransformDocPage, type TransformDocs, type TransformReference, type TransformReferenceGuide, type Translations, type UserTranslations, defineChangelogConfig, defineMarkdownConfig, defineOpenApiConfig, process, skip };
+export { defineChangelogConfig, defineMarkdownConfig, defineOpenApiConfig, process, skip };
+export type { ChangeLogPageData, ChangelogConfigurableHooks, ConfigurableChangelogConfig, ConfigurableDocPageData, ConfigurableDocPageReference, ConfigurableMarkdownConfig, ConfigurableOpenApiConfig, DocPageData, DocPageReference, MacroFunction, MacroSourceMetadata, MarkdownConfigurableHooks, ReferenceGuidePageData, Skip, SourceChangelog, TransformChangelogPage, TransformDocPage, TransformDocs, TransformReference, TransformReferenceGuide, Translations, UserTranslations };

package/dist/index.js

@@ -1,22 +1,20 @@
+#!/usr/bin/env node
 'use strict';
 
-var logger = require('./logger-B7fARcrW.js');
+var logger = require('./logger-DaV___bL.js');
 var E = require('fp-ts/Either');
 require('fp-ts/function');
 require('fp-ts/TaskEither');
 require('js-yaml');
 require('path');
+require('fp-ts/Task');
+require('fp-ts/lib/Array');
+require('@cparra/apex-reflection');
 require('fp-ts/Option');
+require('fast-xml-parser');
 require('handlebars');
 require('fp-ts/boolean');
-require('fast-xml-parser');
-require('fp-ts/Task');
 require('fp-ts/Array');
-require('worker_threads');
-require('os');
-require('fp-ts/lib/Array');
-require('@cparra/apex-reflection');
-require('uuid');
 require('fs');
 require('fp-ts/lib/TaskEither');
 require('minimatch');