Configurable custom object visibility

.github/workflows/ci.yaml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: ["master", "develop"]
+    branches: [ "master", "develop" ]
   pull_request:
-    branches: ["main", "master", "develop"]
+    branches: [ "main", "master", "develop" ]
   workflow_dispatch:
 
 jobs:
@@ -17,6 +17,9 @@ jobs:
         with:
           node-version: "20"
           cache: "npm"
+
+      # Set up GitHub Actions caching for Wireit.
+      - uses: google/wireit@setup-github-actions-caching/v2
+
       - run: npm ci
-      - run: npm run build --if-present
       - run: npm test

.gitignore

@@ -8,6 +8,7 @@ npm-debug.log
 /dist/
 /lib/
 .sfdx/
+.wireit/
 
 # Added by Illuminated Cloud
 .localdev/
@@ -16,4 +17,4 @@ npm-debug.log
 target/
 /.illuminatedCloud/
 **/tsconfig*.json
-**/*.tsbuildinfo
+**/*.tsbuildinfo

README.md

@@ -115,7 +115,8 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
 |----------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------|
 | `--sourceDir`              | `-s`  | The directory where the source files are located.                                                                                                                                                        | N/A              | Yes      |
 | `--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       |
+| `--scope`                  | `-p`  | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible.                                                                                      | `[global]`       | No       |
+| `--customObjectVisibility` | `-v`  | Controls which custom objects are documented. Values should be separated by a space.                                                                                                                     | `[public]`       | No       |
 | `--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       |
@@ -184,14 +185,15 @@ apexdocs openapi -s force-app -t docs -n MyNamespace --title "My Custom OpenApi
 
 #### Flags
 
-| Flag                   | Alias | Description                                                        | Default     | Required |
-|------------------------|-------|--------------------------------------------------------------------|-------------|----------|
-| `--previousVersionDir` | `-p`  | The directory location of the previous version of the source code. | N/A         | Yes      |
-| `--currentVersionDir`  | `-t`  | The directory location of the current version of the source code.  | N/A         | Yes      |
-| `--targetDir`          | `-t`  | The directory location where the changelog file will be generated. | `./docs/`   | No       |
-| `--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       |
-| `--skipIfNoChanges`    | N/A   | Whether to skip generating the changelog if there are no changes.  | `true`      | No       |
+| Flag                       | Alias | Description                                                                          | Default     | Required |
+|----------------------------|-------|--------------------------------------------------------------------------------------|-------------|----------|
+| `--previousVersionDir`     | `-p`  | The directory location of the previous version of the source code.                   | N/A         | Yes      |
+| `--currentVersionDir`      | `-t`  | The directory location of the current version of the source code.                    | N/A         | Yes      |
+| `--targetDir`              | `-t`  | The directory location where the changelog file will be generated.                   | `./docs/`   | No       |
+| `--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       |
 
 #### Sample Usage
 
@@ -309,6 +311,15 @@ export default defineMarkdownConfig({
 });
 ```
 
+You can also leverage the `exclude` property to indirectly modify things like custom metadata records you do
+not want included in the custom metadata type object documentation.
+
+```typescript
+//...
+exclude: ['**/*.md-meta.xml']
+//...
+```
+
 ### Excluding Tags from Appearing in the Documentation
 
 Note: Only works for Markdown documentation.

examples/changelog/docs/changelog.md

@@ -51,7 +51,7 @@ These members have been added or modified.
 - New Method: newMethod
 - Removed Method: deprecatedMethod
 
-## New or Removed Fields in Existing Objects
+## New or Removed Fields to Custom Objects or Standard Objects
 
 These custom fields have been added or removed.
 
@@ -66,4 +66,8 @@ These custom fields have been added or removed.
 
 ### Product__c
 
-- New Field: Description__c
+- New Field: Description__c
+
+### Contact
+
+- New Field: PhotoUrl__c

examples/markdown/docs/custom-objects/Event__c.md

@@ -18,6 +18,7 @@ Represents an event that people can register for.
 
 ---
 ### End Date
+**Required**
 
 **API Name**
 
@@ -29,6 +30,7 @@ Represents an event that people can register for.
 
 ---
 ### Location
+**Required**
 
 **API Name**
 
@@ -40,6 +42,7 @@ Represents an event that people can register for.
 
 ---
 ### Start Date
+**Required**
 
 **API Name**
 

examples/markdown/docs/custom-objects/Price_Component__c.md

@@ -55,11 +55,17 @@ Use this when the Price Component represents a Flat Price. To represent a Percen
 
 ---
 ### Type
+**Required**
 
 **API Name**
 
 `ns__Type__c`
 
 **Type**
 
-*Picklist*
+*Picklist*
+
+#### Possible values are
+* List Price
+* Surcharge
+* Discount

examples/markdown/docs/custom-objects/Product__c.md

@@ -18,6 +18,7 @@ Product that is sold or available for sale.
 
 ---
 ### Event
+**Required**
 
 **API Name**
 

examples/markdown/docs/custom-objects/Sales_Order_Line__c.md

@@ -7,6 +7,7 @@ Represents a line item on a sales order.
 
 ## Fields
 ### Amount
+**Required**
 
 **API Name**
 
@@ -18,6 +19,7 @@ Represents a line item on a sales order.
 
 ---
 ### Product
+**Required**
 
 **API Name**
 
@@ -51,11 +53,16 @@ Represents a line item on a sales order.
 
 ---
 ### Type
+**Required**
 
 **API Name**
 
 `ns__Type__c`
 
 **Type**
 
-*Picklist*
+*Picklist*
+
+#### Possible values are
+* Charge
+* Discount