@cparra/apexdocs 3.8.0-alpha.0 → 3.9.0

package/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.

package/dist/cli/generate.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger$1 = require('../logger-Y4IyA77j.js');
+var logger$1 = require('../logger-Cr61RvjC.js');
 var module$1 = require('module');
 var cosmiconfig = require('cosmiconfig');
 var E = require('fp-ts/Either');
@@ -70,6 +70,14 @@ const markdownOptions = {
     default: logger$1.markdownDefaults.scope,
     describe: "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: logger$1.markdownDefaults.customObjectVisibility,
+    choices: ["public", "protected", "packageprotected"],
+    describe: "Controls which custom objects are documented. Values should be separated by a space."
+  },
   defaultGroupName: {
     type: "string",
     default: logger$1.markdownDefaults.defaultGroupName,
@@ -172,6 +180,14 @@ const changeLogOptions = {
     default: logger$1.changeLogDefaults.scope,
     describe: "The list of scope to respect when generating the changelog. 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: logger$1.changeLogDefaults.customObjectVisibility,
+    choices: ["public", "protected", "packageprotected"],
+    describe: "Controls which custom objects are documented. Values should be separated by a space."
+  },
   skipIfNoChanges: {
     type: "boolean",
     default: logger$1.changeLogDefaults.skipIfNoChanges,

package/dist/index.d.ts

@@ -15,6 +15,7 @@ type CliConfigurableMarkdownConfig = {
   sourceDir: string;
   targetDir: string;
   scope: string[];
+  customObjectVisibility: string[];
   namespace?: string;
   defaultGroupName: string;
   customObjectsGroupName: string;
@@ -25,7 +26,7 @@ type CliConfigurableMarkdownConfig = {
 };
 
 type UserDefinedMarkdownConfig = {
-  targetGenerator: 'markdown' /** Glob patterns to exclude files from the documentation. */;
+  targetGenerator: 'markdown';
   excludeTags: string[];
   exclude: string[];
 } & CliConfigurableMarkdownConfig &
@@ -49,13 +50,14 @@ type UserDefinedChangelogConfig = {
   targetDir: string;
   fileName: string;
   scope: string[];
+  customObjectVisibility: string[];
   exclude: string[];
   skipIfNoChanges: boolean;
 } & Partial<ChangelogConfigurableHooks>;
 
 type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig | UserDefinedChangelogConfig;
 
-type MetadataTypes = 'interface' | 'class' | 'enum' | 'customobject' | 'customfield';
+type MetadataTypes = 'interface' | 'class' | 'enum' | 'customobject' | 'customfield' | 'custommetadata';
 
 type SourceFileMetadata = {
   filePath: string;

package/dist/index.js

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