@cparra/apexdocs 3.12.0 → 3.12.2

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
 

package/dist/cli/generate.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger$1 = require('../logger-DZpyHcLp.js');
-var module$1 = require('module');
+var logger$1 = require('../logger-B8yR_O0h.js');
+var require$$0 = require('yargs');
 var cosmiconfig = require('cosmiconfig');
 var E = require('fp-ts/Either');
 var cosmiconfigTypescriptLoader = require('cosmiconfig-typescript-loader');
@@ -24,32 +24,25 @@ require('minimatch');
 require('@salesforce/source-deploy-retrieve');
 require('chalk');
 
-var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function _interopNamespaceDefault(e) {
-	var n = Object.create(null);
-	if (e) {
-		Object.keys(e).forEach(function (k) {
-			if (k !== 'default') {
-				var d = Object.getOwnPropertyDescriptor(e, k);
-				Object.defineProperty(n, k, d.get ? d : {
-					enumerable: true,
-					get: function () { return e[k]; }
-				});
-			}
-		});
-	}
-	n.default = e;
-	return Object.freeze(n);
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
 }
 
 var E__namespace = /*#__PURE__*/_interopNamespaceDefault(E);
 
-var require$1 = (
-			false
-				? /* @__PURE__ */ module$1.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli/generate.js', document.baseURI).href)))
-				: require
-		);
-
 const markdownOptions = {
   sourceDir: {
     type: "string",
@@ -122,6 +115,10 @@ const markdownOptions = {
     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."
   }
 };
 
@@ -244,7 +241,7 @@ var __async$1 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const yargs = require$1("yargs");
+const yargs = require$$0;
 const configOnlyMarkdownDefaults = {
   targetGenerator: "markdown",
   excludeTags: [],
@@ -424,8 +421,8 @@ function main() {
     logger.error(`\u274C An error occurred while processing the request: ${error}`);
     process.exit(1);
   }
-  extractArgs().then((maybeConfigs) => __async(this, null, function* () {
-    E__namespace.match(catchUnexpectedError, (configs) => __async(this, null, function* () {
+  extractArgs().then((maybeConfigs) => __async(null, null, function* () {
+    E__namespace.match(catchUnexpectedError, (configs) => __async(null, null, function* () {
       for (const config of configs) {
         yield logger$1.Apexdocs.generate(config, logger).then(parseResult);
       }

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/{logger-DZpyHcLp.js → logger-B8yR_O0h.js}

@@ -714,8 +714,9 @@ function fieldMetadataToRenderable(field, config, headingLevel) {
     apiName: getApiName(field.name, config),
     fieldType: field.type,
     required: field.required,
-    complianceCategory: renderComplianceCategory(field.complianceCategory, config),
-    securityClassification: renderComplianceCategory(field.securityClassification, config),
+    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",
@@ -744,9 +745,16 @@ function getApiName(currentName, config) {
   }
   return currentName;
 }
-function renderComplianceCategory(complianceCategory, config) {
+function renderComplianceGroup(complianceGroup, config) {
   if (config.includeFieldSecurityMetadata) {
-    return complianceCategory;
+    return complianceGroup;
+  } else {
+    return null;
+  }
+}
+function renderInlineHelpText(inlineHelpText, config) {
+  if (config.includeInlineHelpTextMetadata) {
+    return inlineHelpText;
   } else {
     return null;
   }
@@ -1537,7 +1545,8 @@ const markdownDefaults = __spreadProps$i(__spreadValues$i({}, markdownAndChangel
   linkingStrategy: "relative",
   referenceGuideTitle: "Reference Guide",
   excludeTags: [],
-  includeFieldSecurityMetadata: false
+  includeFieldSecurityMetadata: false,
+  includeInlineHelpTextMetadata: false
 });
 const openApiDefaults = __spreadProps$i(__spreadValues$i({}, commonDefaults), {
   fileName: "openapi",
@@ -1576,9 +1585,14 @@ const customObjectTemplate = `
 {{{renderContent description}}}
 {{/if}}
 
-{{#if complianceCategory}}
-**Compliance Category**
-{{complianceCategory}}
+{{#if inlineHelpText}}
+**Inline Help Text**
+{{inlineHelpText}}
+{{/if}}
+
+{{#if complianceGroup}}
+**Compliance Group**
+{{complianceGroup}}
 {{/if}}
 
 {{#if securityClassification}}
@@ -2183,7 +2197,8 @@ function convertInlineFieldsToCustomFieldMetadata(inlineField, parentName) {
   const type = inlineField.type ? inlineField.type : null;
   const required = inlineField.required ? inlineField.required : false;
   const securityClassification = inlineField.securityClassification ? inlineField.securityClassification : null;
-  const complianceCategory = inlineField.complianceCategory ? inlineField.complianceCategory : null;
+  const complianceGroup = inlineField.complianceGroup ? inlineField.complianceGroup : null;
+  const inlineHelpText = inlineField.inlineHelpText ? inlineField.inlineHelpText : null;
   return {
     type_name: "customfield",
     description,
@@ -2193,7 +2208,8 @@ function convertInlineFieldsToCustomFieldMetadata(inlineField, parentName) {
     type,
     required,
     securityClassification,
-    complianceCategory,
+    complianceGroup,
+    inlineHelpText,
     pickListValues: getPickListValues(inlineField)
   };
 }
@@ -2267,7 +2283,8 @@ function toCustomFieldMetadata(parserResult) {
     description: null,
     required: false,
     securityClassification: null,
-    complianceCategory: null
+    complianceGroup: null,
+    inlineHelpText: null
   };
   return __spreadProps$c(__spreadValues$c(__spreadValues$c({}, defaultValues), customField), {
     type_name: "customfield",
@@ -2702,8 +2719,8 @@ function transformDocumentationBundleHook(config) {
     (error) => new HookError(error)
   );
 }
-const execTransformReferenceHook = (_0, ..._1) => __async$3(void 0, [_0, ..._1], function* (references, hook = passThroughHook) {
-  const hooked = references.map((reference) => __async$3(void 0, null, function* () {
+const execTransformReferenceHook = (_0, ..._1) => __async$3(null, [_0, ..._1], function* (references, hook = passThroughHook) {
+  const hooked = references.map((reference) => __async$3(null, null, function* () {
     const hookedResult = yield hook(reference);
     return __spreadValues$8(__spreadValues$8({}, reference), hookedResult);
   }));
@@ -2713,24 +2730,24 @@ const execTransformReferenceHook = (_0, ..._1) => __async$3(void 0, [_0, ..._1],
     return acc;
   }, {});
 });
-const documentationBundleHook = (bundle, config) => __async$3(void 0, null, function* () {
+const documentationBundleHook = (bundle, config) => __async$3(null, null, function* () {
   return {
     referenceGuide: yield transformReferenceGuide(bundle.referenceGuide, config.transformReferenceGuide),
     docs: yield transformDocs(bundle.docs, config.transformDocs, config.transformDocPage)
   };
 });
-const transformReferenceGuide = (_0, ..._1) => __async$3(void 0, [_0, ..._1], function* (referenceGuide, hook = passThroughHook) {
+const transformReferenceGuide = (_0, ..._1) => __async$3(null, [_0, ..._1], function* (referenceGuide, hook = passThroughHook) {
   const result = yield hook(referenceGuide);
   if (isSkip(result)) {
     return result;
   }
   return __spreadValues$8(__spreadValues$8({}, referenceGuide), yield hook(referenceGuide));
 });
-const transformDocs = (_0, ..._1) => __async$3(void 0, [_0, ..._1], function* (docs, transformDocsHook = passThroughHook, transformDocPageHook = passThroughHook) {
+const transformDocs = (_0, ..._1) => __async$3(null, [_0, ..._1], function* (docs, transformDocsHook = passThroughHook, transformDocPageHook = passThroughHook) {
   const transformed = yield transformDocsHook(docs);
   return Promise.all(transformed.map((doc) => transformDocPage(doc, transformDocPageHook)));
 });
-const transformDocPage = (_0, ..._1) => __async$3(void 0, [_0, ..._1], function* (doc, hook = passThroughHook) {
+const transformDocPage = (_0, ..._1) => __async$3(null, [_0, ..._1], function* (doc, hook = passThroughHook) {
   return __spreadValues$8(__spreadValues$8({}, doc), yield hook(doc));
 });
 function postHookCompile$1(bundle) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.12.0",
+  "version": "3.12.2",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -94,7 +94,7 @@
   },
   "dependencies": {
     "@cparra/apex-reflection": "2.19.0",
-    "@salesforce/source-deploy-retrieve": "^12.8.1",
+    "@salesforce/source-deploy-retrieve": "^12.20.1",
     "@types/js-yaml": "^4.0.9",
     "@types/yargs": "^17.0.32",
     "chalk": "^4.1.2",