@cparra/apexdocs 3.11.0 → 3.12.1

package/README.md

@@ -124,6 +124,8 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
 | `--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       |
+| `--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       |
 
 ##### Linking Strategy
 
@@ -386,7 +388,7 @@ Example: Injecting a copyright notice
 //...
 macros: {
   copyright: () => {
-    return `Copyright (c) ${new Date().getFullYear()} My Name`;
+    return `@copyright Copyright (c) ${new Date().getFullYear()} My Name`;
   }
 }
 //...

package/dist/cli/generate.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger$1 = require('../logger-C1Ezw_pW.js');
+var logger$1 = require('../logger-dCI_xpGU.js');
 var module$1 = require('module');
 var cosmiconfig = require('cosmiconfig');
 var E = require('fp-ts/Either');
@@ -117,6 +117,15 @@ const markdownOptions = {
     type: "string",
     describe: "The title of the reference guide.",
     default: logger$1.markdownDefaults.referenceGuideTitle
+  },
+  includeFieldSecurityMetadata: {
+    type: "boolean",
+    describe: "Whether to include the compliance category and security classification for fields in the generated files.",
+    default: logger$1.markdownDefaults.includeFieldSecurityMetadata
+  },
+  includeInlineHelpTextMetadata: {
+    type: "boolean",
+    describe: "Whether to include the inline help text for fields in the generated files."
   }
 };
 

package/dist/index.d.ts

@@ -32,6 +32,8 @@ type CliConfigurableMarkdownConfig = {
   includeMetadata: boolean;
   linkingStrategy: LinkingStrategy;
   referenceGuideTitle: string;
+  includeFieldSecurityMetadata: boolean;
+  includeInlineHelpTextMetadata: boolean;
 };
 
 type UserDefinedMarkdownConfig = {

package/dist/index.js

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

package/dist/{logger-C1Ezw_pW.js → logger-dCI_xpGU.js}

@@ -714,6 +714,9 @@ function fieldMetadataToRenderable(field, config, headingLevel) {
     apiName: getApiName(field.name, config),
     fieldType: field.type,
     required: field.required,
+    complianceGroup: renderComplianceGroup(field.complianceGroup, config),
+    securityClassification: renderComplianceGroup(field.securityClassification, config),
+    inlineHelpText: renderInlineHelpText(field.inlineHelpText, config),
     pickListValues: field.pickListValues ? {
       headingLevel: headingLevel + 1,
       heading: "Possible values are",
@@ -742,6 +745,20 @@ function getApiName(currentName, config) {
   }
   return currentName;
 }
+function renderComplianceGroup(complianceGroup, config) {
+  if (config.includeFieldSecurityMetadata) {
+    return complianceGroup;
+  } else {
+    return null;
+  }
+}
+function renderInlineHelpText(inlineHelpText, config) {
+  if (config.includeInlineHelpTextMetadata) {
+    return inlineHelpText;
+  } else {
+    return null;
+  }
+}
 
 const generateLink = (strategy) => {
   switch (strategy) {
@@ -1527,7 +1544,9 @@ const markdownDefaults = __spreadProps$i(__spreadValues$i({}, markdownAndChangel
   sortAlphabetically: false,
   linkingStrategy: "relative",
   referenceGuideTitle: "Reference Guide",
-  excludeTags: []
+  excludeTags: [],
+  includeFieldSecurityMetadata: false,
+  includeInlineHelpTextMetadata: false
 });
 const openApiDefaults = __spreadProps$i(__spreadValues$i({}, commonDefaults), {
   fileName: "openapi",
@@ -1566,6 +1585,21 @@ const customObjectTemplate = `
 {{{renderContent description}}}
 {{/if}}
 
+{{#if inlineHelpText}}
+**Inline Help Text**
+{{inlineHelpText}}
+{{/if}}
+
+{{#if complianceGroup}}
+**Compliance Group**
+{{complianceGroup}}
+{{/if}}
+
+{{#if securityClassification}}
+**Security Classification**
+{{securityClassification}}
+{{/if}}
+
 **API Name**
 
 \`{{{apiName}}}\`
@@ -2162,6 +2196,9 @@ function convertInlineFieldsToCustomFieldMetadata(inlineField, parentName) {
   const label = inlineField.label ? inlineField.label : name;
   const type = inlineField.type ? inlineField.type : null;
   const required = inlineField.required ? inlineField.required : false;
+  const securityClassification = inlineField.securityClassification ? inlineField.securityClassification : null;
+  const complianceGroup = inlineField.complianceGroup ? inlineField.complianceGroup : null;
+  const inlineHelpText = inlineField.inlineHelpText ? inlineField.inlineHelpText : null;
   return {
     type_name: "customfield",
     description,
@@ -2170,6 +2207,9 @@ function convertInlineFieldsToCustomFieldMetadata(inlineField, parentName) {
     parentName,
     type,
     required,
+    securityClassification,
+    complianceGroup,
+    inlineHelpText,
     pickListValues: getPickListValues(inlineField)
   };
 }
@@ -2241,7 +2281,10 @@ function toCustomFieldMetadata(parserResult) {
   const customField = (parserResult == null ? void 0 : parserResult.CustomField) != null && typeof parserResult.CustomField === "object" ? parserResult.CustomField : {};
   const defaultValues = {
     description: null,
-    required: false
+    required: false,
+    securityClassification: null,
+    complianceGroup: null,
+    inlineHelpText: null
   };
   return __spreadProps$c(__spreadValues$c(__spreadValues$c({}, defaultValues), customField), {
     type_name: "customfield",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.11.0",
+  "version": "3.12.1",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -80,7 +80,7 @@
     "ts-jest": "^29.2.0",
     "typescript": "^5.7.3",
     "typescript-eslint": "^7.16.0",
-    "wireit": "^0.14.10"
+    "wireit": "^0.14.12"
   },
   "husky": {
     "hooks": {