@cparra/apexdocs 3.13.0 → 3.14.1

package/README.md

@@ -12,6 +12,26 @@ ApexDocs is a non-opinionated documentation generator for Salesforce Apex classe
 It can output documentation in Markdown format, which allows you to use the Static Site Generator of your choice to
 create a documentation site that fits your needs, hosted in any static web hosting service.
 
+## Table of Contents
+
+- [👀 Examples](#-examples)
+- [🚀 Features](#-features)
+- [💿 Installation](#-installation)
+- [⚡ Quick Start](#-quick-start)
+    - [CLI](#cli)
+        - [Markdown](#markdown)
+        - [OpenApi](#openapi)
+        - [Changelog](#changelog)
+- [▶️ Available Commands](#️-available-commands)
+    - [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)
+- [📖 Documentation Guide](#-documentation-guide)
+- [📄 Generating OpenApi REST Definitions](#-generating-openapi-rest-definitions)
+
 ## 👀 Examples
 
 ApexDocs generates Markdown files, which can be integrated into any Static Site Generation (SSG) engine,
@@ -64,6 +84,7 @@ Here are some live projects using ApexDocs:
 * Support for ignoring files and members from being documented
 * Namespace support
 * Configuration file support
+* Translation support for different languages and custom terminology
 * Single line ApexDoc Blocks
 * Custom tag support
 * And much, much more!
@@ -89,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
@@ -119,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       |
@@ -137,8 +157,7 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
 | `--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.
@@ -274,6 +293,12 @@ export default defineMarkdownConfig({
   sourceDir: 'force-app',
   targetDir: 'docs',
   scope: ['global', 'public'],
+  translations: {
+    sections: {
+      methods: 'Methods',
+      properties: 'Properties',
+    },
+  },
   ...
 });
 ```
@@ -369,61 +394,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
@@ -536,6 +506,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';
+  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**
@@ -595,6 +620,74 @@ export default {
 };
 ```
 
+## 🌐 Translation
+
+ApexDocs supports translations to customize the language and terminology used in the generated documentation.
+This feature allows you to:
+
+- **Translate documentation to different languages** (Spanish, French, etc.)
+- **Use custom business terminology** (e.g., "Business Operations" instead of "Methods")
+- **Partially override specific terms** while keeping the rest in English
+
+### How It Works
+
+The translation system uses:
+
+- **Default English translations** built into the system
+- **User-provided overrides** that can be partial or complete
+
+### Configuration
+
+Add a `translations` property to your ApexDocs configuration (JS or TS file) and pass
+the appropriate translation object, depending on the generator you're using:
+
+```javascript
+import { defineMarkdownConfig } from '@cparra/apexdocs';
+
+export default defineMarkdownConfig({
+  sourceDir: 'src',
+  targetDir: 'docs',
+  scope: ['public', 'global'],
+  translations: {
+    sections: {
+      methods: 'Métodos',
+      properties: 'Propiedades',
+      fields: 'Campos',
+    },
+  },
+});
+```
+
+### TypeScript Support
+
+For TypeScript projects, import the translation types for better autocomplete and type safety:
+
+```typescript
+import { defineMarkdownConfig } from '@cparra/apexdocs';
+import type { UserTranslations } from '@cparra/apexdocs';
+
+const markdownTranslations: UserTranslations['markdown'] = {
+  sections: {
+    methods: 'Functions',
+  },
+  // ...other translation keys as needed
+};
+
+export default defineMarkdownConfig({
+  sourceDir: 'src',
+  targetDir: 'docs',
+  scope: ['public', 'global'],
+  translations: markdownTranslations,
+});
+```
+
+### Notes
+
+- Only the **markdown** and **changelog** generators support translations
+- All translations are optional - anything not specified uses the English default
+
+For a complete example, see the [translation example](examples/translation/) in this repository.
+
 ## ⤵︎ Importing to your project
 
 ### Reflection

package/dist/cli/generate.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger$1 = require('../logger-BiPQ_i9-.js');
+var logger$1 = require('../logger-D4Q3KA6D.js');
 var require$$0 = require('yargs');
 var cosmiconfig = require('cosmiconfig');
 var E = require('fp-ts/Either');

package/dist/index.d.ts

@@ -1,3 +1,140 @@
+/**
+ * Default English translations for ApexDocs.
+ * These can be overridden by users in their configuration.
+ */
+type Translations = {
+    changelog: {
+        title: string;
+        newClasses: {
+            heading: string;
+            description: string;
+        };
+        newInterfaces: {
+            heading: string;
+            description: string;
+        };
+        newEnums: {
+            heading: string;
+            description: string;
+        };
+        newCustomObjects: {
+            heading: string;
+            description: string;
+        };
+        newTriggers: {
+            heading: string;
+            description: string;
+        };
+        removedTypes: {
+            heading: string;
+            description: string;
+        };
+        removedCustomObjects: {
+            heading: string;
+            description: string;
+        };
+        removedTriggers: {
+            heading: string;
+            description: string;
+        };
+        newOrModifiedMembers: {
+            heading: string;
+            description: string;
+        };
+        newOrRemovedCustomFields: {
+            heading: string;
+            description: string;
+        };
+        newOrRemovedCustomMetadataTypeRecords: {
+            heading: string;
+            description: string;
+        };
+        memberModifications: {
+            newEnumValue: string;
+            removedEnumValue: string;
+            newMethod: string;
+            removedMethod: string;
+            newProperty: string;
+            removedProperty: string;
+            newField: string;
+            removedField: string;
+            newType: string;
+            removedType: string;
+            newCustomMetadataRecord: string;
+            removedCustomMetadataRecord: string;
+            newTrigger: string;
+            removedTrigger: string;
+        };
+    };
+    markdown: {
+        sections: {
+            methods: string;
+            properties: string;
+            fields: string;
+            constructors: string;
+            values: string;
+            classes: string;
+            enums: string;
+            interfaces: string;
+            namespace: string;
+            records: string;
+            publishBehavior: string;
+        };
+        details: {
+            type: string;
+            signature: string;
+            group: string;
+            author: string;
+            date: string;
+            see: string;
+            possibleValues: string;
+            parameters: string;
+            throws: string;
+            returnType: string;
+            apiName: string;
+            required: string;
+            inlineHelpText: string;
+            complianceGroup: string;
+            securityClassification: string;
+            protected: string;
+        };
+        typeSuffixes: {
+            class: string;
+            interface: string;
+            enum: string;
+            trigger: string;
+        };
+        triggerEvents: {
+            beforeInsert: string;
+            beforeUpdate: string;
+            beforeDelete: string;
+            afterInsert: string;
+            afterUpdate: string;
+            afterDelete: string;
+            afterUndelete: string;
+        };
+        publishBehaviors: {
+            publishImmediately: string;
+            publishAfterCommit: string;
+        };
+        inheritance: {
+            inheritance: string;
+            implements: string;
+        };
+    };
+};
+
+/**
+ * User-provided partial translations that can override the defaults.
+ */
+type UserTranslations = DeepPartial<Translations>;
+/**
+ * Utility type to make all properties in T optional recursively.
+ */
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+
 type Generators = 'markdown' | 'openapi' | 'changelog';
 
 type LinkingStrategy =
@@ -42,6 +179,7 @@ type UserDefinedMarkdownConfig = {
   targetGenerator: 'markdown';
   excludeTags: string[];
   exclude: string[];
+  translations?: UserTranslations['markdown'];
 } & CliConfigurableMarkdownConfig &
   Partial<MarkdownConfigurableHooks>;
 
@@ -68,6 +206,7 @@ type UserDefinedChangelogConfig = {
   customObjectVisibility: string[];
   exclude: string[];
   skipIfNoChanges: boolean;
+  translations?: UserTranslations['changelog'];
 } & Partial<ChangelogConfigurableHooks>;
 
 type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig | UserDefinedChangelogConfig;
@@ -247,4 +386,4 @@ 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, defineChangelogConfig, defineMarkdownConfig, defineOpenApiConfig, process, skip };
+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 };

package/dist/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var logger = require('./logger-BiPQ_i9-.js');
+var logger = require('./logger-D4Q3KA6D.js');
 var E = require('fp-ts/Either');
 require('fp-ts/function');
 require('fp-ts/TaskEither');