@cparra/apexdocs 3.8.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
 

package/dist/cli/generate.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger$1 = require('../logger-B0wNVQij.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;
@@ -49,6 +50,7 @@ type UserDefinedChangelogConfig = {
   targetDir: string;
   fileName: string;
   scope: string[];
+  customObjectVisibility: string[];
   exclude: string[];
   skipIfNoChanges: boolean;
 } & Partial<ChangelogConfigurableHooks>;

package/dist/index.js

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

package/dist/{logger-B0wNVQij.js → logger-Cr61RvjC.js}

@@ -624,6 +624,16 @@ function singleGroup(headingLevel, groupName, adapter, members, linkGenerator) {
 }
 function objectMetadataToRenderable(objectMetadata, config) {
   var _a;
+  function toRenderablePublishBehavior(publishBehavior) {
+    switch (publishBehavior) {
+      case "PublishImmediately":
+        return "Publish Immediately";
+      case "PublishAfterCommit":
+        return "Publish After Commit";
+      default:
+        return null;
+    }
+  }
   return {
     type: "customobject",
     headingLevel: 1,
@@ -645,7 +655,8 @@ function objectMetadataToRenderable(objectMetadata, config) {
       headingLevel: 2,
       heading: "Records",
       value: objectMetadata.metadataRecords.map((metadata) => customMetadataToRenderable(metadata, 3))
-    }
+    },
+    publishBehavior: toRenderablePublishBehavior(objectMetadata.publishBehavior)
   };
 }
 function fieldMetadataToRenderable(field, config, headingLevel) {
@@ -1458,16 +1469,19 @@ var __spreadProps$h = (a, b) => __defProps$h(a, __getOwnPropDescs$h(b));
 const commonDefaults = {
   targetDir: "./docs/"
 };
-const markdownDefaults = __spreadProps$h(__spreadValues$h({}, commonDefaults), {
+const markdownAndChangelogDefaults = __spreadProps$h(__spreadValues$h({}, commonDefaults), {
   scope: ["global"],
+  customObjectVisibility: ["public"],
+  exclude: []
+});
+const markdownDefaults = __spreadProps$h(__spreadValues$h({}, markdownAndChangelogDefaults), {
   defaultGroupName: "Miscellaneous",
   customObjectsGroupName: "Custom Objects",
   includeMetadata: false,
   sortAlphabetically: false,
   linkingStrategy: "relative",
   referenceGuideTitle: "Reference Guide",
-  excludeTags: [],
-  exclude: []
+  excludeTags: []
 });
 const openApiDefaults = __spreadProps$h(__spreadValues$h({}, commonDefaults), {
   fileName: "openapi",
@@ -1475,10 +1489,8 @@ const openApiDefaults = __spreadProps$h(__spreadValues$h({}, commonDefaults), {
   apiVersion: "1.0.0",
   exclude: []
 });
-const changeLogDefaults = __spreadProps$h(__spreadValues$h({}, commonDefaults), {
+const changeLogDefaults = __spreadProps$h(__spreadValues$h({}, markdownAndChangelogDefaults), {
   fileName: "changelog",
-  scope: ["global"],
-  exclude: [],
   skipIfNoChanges: true
 });
 
@@ -1490,6 +1502,12 @@ const customObjectTemplate = `
 ## API Name
 \`{{apiName}}\`
 
+{{#if publishBehavior}}
+## Publish Behavior
+
+**{{publishBehavior}}**
+{{/if}}
+
 {{#if hasFields}}
 {{ heading fields.headingLevel fields.heading }}
 {{#each fields.value}}
@@ -2265,12 +2283,17 @@ var __spreadValues$9 = (a, b) => {
   return a;
 };
 var __spreadProps$9 = (a, b) => __defProps$9(a, __getOwnPropDescs$9(b));
-function reflectCustomFieldsAndObjectsAndMetadataRecords(objectBundles) {
+function reflectCustomFieldsAndObjectsAndMetadataRecords(objectBundles, visibilitiesToDocument) {
   function filterNonPublished(parsedFiles) {
     return parsedFiles.filter((parsedFile) => parsedFile.type.deploymentStatus === "Deployed");
   }
-  function filterNonPublic(parsedFiles) {
-    return parsedFiles.filter((parsedFile) => parsedFile.type.visibility === "Public");
+  function filter(parsedFiles) {
+    function shouldBeDocumented(parsedFile) {
+      return visibilitiesToDocument.includes(parsedFile.type.visibility.toLowerCase());
+    }
+    const objectsToDocument = parsedFiles.filter(shouldBeDocumented);
+    const objectsToIgnore = parsedFiles.filter((parsedFile) => !shouldBeDocumented(parsedFile)).map((parsedFile) => parsedFile.type.name);
+    return [objectsToDocument, objectsToIgnore];
   }
   const customObjects = objectBundles.filter(
     (object) => object.type === "customobject"
@@ -2291,12 +2314,12 @@ function reflectCustomFieldsAndObjectsAndMetadataRecords(objectBundles) {
     customObjects,
     reflectCustomObjectSources,
     TE__namespace.map(filterNonPublished),
-    TE__namespace.map(filterNonPublic),
-    TE__namespace.bindTo("objects"),
+    TE__namespace.map(filter),
+    TE__namespace.bindTo("filterResult"),
     TE__namespace.bind("fields", () => generateForFields(customFields)),
     TE__namespace.bind("metadata", () => generateForMetadata(customMetadata)),
-    TE__namespace.map(({ objects, fields, metadata }) => {
-      return [...mapFieldsAndMetadata(objects, fields, metadata), ...mapExtensionFields(objects, fields)];
+    TE__namespace.map(({ filterResult, fields, metadata }) => {
+      return [...mapFieldsAndMetadata(filterResult[0], fields, metadata), ...mapExtensionFields(filterResult, fields)];
     })
   );
 }
@@ -2312,9 +2335,11 @@ function mapFieldsAndMetadata(objects, fields, metadata) {
     });
   });
 }
-function mapExtensionFields(objects, fields) {
+function mapExtensionFields(filterResult, fields) {
+  const objects = filterResult[0];
+  const ignoredObjectNames = filterResult[1];
   const extensionFields = fields.filter(
-    (field) => !objects.some((object) => object.type.name === field.type.parentName)
+    (field) => !objects.some((object) => object.type.name.toLowerCase() === field.type.parentName.toLowerCase()) && !ignoredObjectNames.map((name) => name.toLowerCase()).includes(field.type.parentName.toLowerCase())
   );
   const extensionFieldsByParent = extensionFields.reduce(
     (acc, field) => {
@@ -2413,7 +2438,10 @@ function generateDocs(unparsedBundles, config) {
     generateForApex(filterApexSourceFiles(unparsedBundles), config),
     TE__namespace.chain((parsedApexFiles) => {
       return _function.pipe(
-        reflectCustomFieldsAndObjectsAndMetadataRecords(filterCustomObjectsFieldsAndMetadataRecords(unparsedBundles)),
+        reflectCustomFieldsAndObjectsAndMetadataRecords(
+          filterCustomObjectsFieldsAndMetadataRecords(unparsedBundles),
+          config.customObjectVisibility
+        ),
         TE__namespace.map((parsedObjectFiles) => [...parsedApexFiles, ...parsedObjectFiles])
       );
     }),
@@ -4234,7 +4262,10 @@ function reflect(bundles, config) {
     reflectApexFiles(filterApexSourceFiles(bundles)),
     TE__namespace.chain((parsedApexFiles) => {
       return _function.pipe(
-        reflectCustomFieldsAndObjectsAndMetadataRecords(filterCustomObjectsFieldsAndMetadataRecords(bundles)),
+        reflectCustomFieldsAndObjectsAndMetadataRecords(
+          filterCustomObjectsFieldsAndMetadataRecords(bundles),
+          config.customObjectVisibility
+        ),
         TE__namespace.map((parsedObjectFiles) => [...parsedApexFiles, ...parsedObjectFiles])
       );
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.8.0",
+  "version": "3.9.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -19,14 +19,46 @@
     "apexdocs": "./dist/cli/generate.js"
   },
   "scripts": {
-    "test": "npm run build && jest",
+    "test": "wireit",
     "test:cov": "npm run build && jest --coverage",
-    "build": "rimraf ./dist && npm run lint && tsc --noEmit && pkgroll",
-    "lint": "eslint \"./src/**/*.{js,ts}\" --quiet --fix",
+    "build": "wireit",
+    "lint": "wireit",
     "prepare": "npm run build",
     "version": "npm run format && git add -A src",
     "postversion": "git push && git push --tags"
   },
+  "wireit": {
+    "lint": {
+      "command": "eslint \"./src/**/*.{js,ts}\" --quiet --fix",
+      "files": [
+        "src/**/*.ts"
+      ],
+      "output": []
+    },
+    "build": {
+      "command": "tsc --noEmit --pretty && pkgroll",
+      "dependencies": [
+        "lint"
+      ],
+      "files": [
+        "src/**/*.ts",
+        "tsconfig.json"
+      ],
+      "output": [
+        "dist"
+      ]
+    },
+    "test": {
+      "command": "jest",
+      "dependencies": [
+        "build"
+      ],
+      "files": [
+        "src/**/*.ts"
+      ],
+      "output": []
+    }
+  },
   "author": "Cesar Parra",
   "license": "MIT",
   "repository": {
@@ -45,10 +77,10 @@
     "lint-staged": "^15.2.7",
     "pkgroll": "^2.4.2",
     "prettier": "^3.3.2",
-    "rimraf": "^6.0.1",
     "ts-jest": "^29.2.0",
-    "typescript": "^5.5.3",
-    "typescript-eslint": "^7.16.0"
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^7.16.0",
+    "wireit": "^0.14.10"
   },
   "husky": {
     "hooks": {