@cparra/apexdocs 2.2.2 → 2.2.5

package/.github/workflows/close_stale.yml

@@ -0,0 +1,22 @@
+name: Close inactive issues
+on:
+  schedule:
+    - cron: "30 1 * * *"
+
+jobs:
+  close-issues:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v4
+        with:
+          days-before-issue-stale: -1
+          days-before-issue-close: 30
+          stale-issue-label: "stale"
+          stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
+          close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

package/README.md

@@ -207,23 +207,8 @@ the `Properties` title will be `<h2>`, each property name will be an `<h3>`, etc
 
 ### Importing to your project
 
-If you are just interested in the documentation parsing capabilities, you can import ApexDocs into your own project.
-
-Use the `docGenerator` function to create a list of `ClassModel` that includes all the parsed information from your .cls
-files.
-
-`docGenerator(sourceDirectory[,recursive][,scope][,outputDir])`
-
-- `sourceDirectory` \<string>
-- `recursive` \<boolean>
-- `scope` \<string[]>
-- `outpurDir` \<string>
-
-```javascript
-var { docGenerator } = require('@cparra/apexdocs');
-
-let documentedClasses = docGenerator('src', true, ['global'], 'docs');
-```
+If you are just interested in the Apex parsing capabilities, you can use the standalone [Apex Reflection Library](https://www.npmjs.com/package/@cparra/apex-reflection)
+which is what gets used by this library behind the scenes to generate the documentation files.
 
 ## Documentation Format
 
@@ -235,7 +220,7 @@ multiple lines, ending with `*/`.
 The following tags are supported on the class level:
 
 | Tag            | Description                                                                                                                                |
-| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+|----------------|--------------------------------------------------------------------------------------------------------------------------------------------|
 | `@description` | One or more lines describing the class.                                                                                                    |
 | `@see`         | The name of a related class.                                                                                                               |
 | `@group`       | The group to which the class belongs to.                                                                                                   |
@@ -257,7 +242,7 @@ public with sharing class TestClass {
 The following tags are supported on the enum level:
 
 | Tag            | Description                            |
-| -------------- | -------------------------------------- |
+|----------------|----------------------------------------|
 | `@description` | One or more lines describing the enum. |
 
 **Example**
@@ -276,7 +261,7 @@ public Enum ExampleEnum {
 The following tags are supported on the property level:
 
 | Tag            | Description                                |
-| -------------- | ------------------------------------------ |
+|----------------|--------------------------------------------|
 | `@description` | One or more lines describing the property. |
 
 **Example**
@@ -295,7 +280,7 @@ Methods and constructors support the same tags.
 The following tags are supported on the method level:
 
 | Tag                       | Description                                       |
-| ------------------------- | ------------------------------------------------- |
+|---------------------------|---------------------------------------------------|
 | `@description`            | One or more lines describing the method.          |
 | `@param` _paramName_      | Description of a single parameter.                |
 | `@return`                 | Description of the return value of the method.    |

package/docs/README.md

@@ -1,4 +1,9 @@
 # Classes
+## Utils
+
+### [GroupedClass](/Utils/GroupedClass.md)
+
+Uses a block style apex doc
 ## Sample Classes
 
 ### [SampleClass](/Sample-Classes/SampleClass.md)
@@ -14,3 +19,8 @@ This is a class description. This class relates to [SampleInterface](/Sample-Int
 ### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
 
 This is an interface description.
+## Stripe Integration
+
+### [SampleTestClass](/Stripe-Integration/SampleTestClass.md)
+
+

package/docs/Sample-Classes/SampleClass.md

@@ -114,10 +114,16 @@ System.debug(result);
 ```
 
 ### `static anotherSampleMethod(String arg1)`
+
+Something here
+
 #### Parameters
 |Param|Description|
 |---|---|
 
+
+**Arg1** The arg1 description
+
 ### `static call()`
 
 Calls the method. This methods allows you to call it.

package/docs/Some-group/GroupedClass.md

@@ -0,0 +1,7 @@
+# GroupedClass
+
+Some desc
+
+
+**Group** Some group
+

package/docs/Utils/GroupedClass.md

@@ -0,0 +1,10 @@
+# GroupedClass
+
+Uses a block style apex doc
+
+
+**Group** Utils
+
+
+**Test Class** [SampleClass](/Sample-Classes/SampleClass.md)
+

package/examples/force-app/main/default/classes/GroupedClass.cls

@@ -0,0 +1,8 @@
+/**********************************************************
+Uses a block style apex doc
+@group           Utils
+@test-class      {@link SampleClass}
+***********************************************************/
+public class GroupedClass {
+
+}

package/examples/force-app/main/default/classes/SampleClass.cls

@@ -74,7 +74,7 @@ public with sharing class SampleClass {
 
     /**
      * @description Something here
-     * @arg1
+     * @arg1 The arg1 description
      */
     public static String anotherSampleMethod(String arg1) {
         System.debug('something');

package/examples/force-app/main/default/classes/SampleClassTest.cls

@@ -0,0 +1,11 @@
+@IsTest
+/**
+* @Name StripeRESTService
+* @Date 3/2/2022
+* @group Stripe Integration
+* @See StripeRESTServiceTest
+* @Description Apex class that creates and exposes a REST endpoint by the name of 'Stripe'. [ORG_URL]/services/apexrest/Stripe (case sensitive!)
+*/
+private class SampleTestClass {
+
+}

package/lib/model/markdown-generation-util/doc-comment-annotation-util.js

@@ -9,15 +9,20 @@ function addCustomDocCommentAnnotations(markdownFile, docCommentAware) {
         markdownFile.addText(buildDocAnnotationText(currentAnnotation));
         markdownFile.addBlankLine();
     });
-    function capitalizeFirstLetter(text) {
-        return text.charAt(0).toUpperCase() + text.slice(1);
+    function splitAndCapitalize(text) {
+        const words = text.split(/[-_]+/);
+        const capitalizedWords = [];
+        for (const word of words) {
+            capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
+        }
+        return capitalizedWords.join(' ');
     }
     function buildDocAnnotationText(annotation) {
         let annotationBodyText = annotation.body;
         if (annotation.name.toLowerCase() === 'see') {
             annotationBodyText = class_file_generatorHelper_1.default.getFileLinkByTypeName(annotation.body);
         }
-        return `**${capitalizeFirstLetter(annotation.name)}** ${annotationBodyText}`;
+        return `**${splitAndCapitalize(annotation.name)}** ${annotationBodyText}`;
     }
 }
 exports.addCustomDocCommentAnnotations = addCustomDocCommentAnnotations;

package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map

@@ -1 +1 @@
-{"version":3,"file":"doc-comment-annotation-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/doc-comment-annotation-util.ts"],"names":[],"mappings":";;;AACA,qGAA4F;AAO5F,SAAgB,8BAA8B,CAAC,YAA0B,EAAE,eAAgC;;IACzG,MAAA,eAAe,CAAC,UAAU,0CAAE,WAAW,CACpC,MAAM,CAAC,CAAC,iBAAuC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,aAAa,EAC5F,OAAO,CAAC,CAAC,iBAAuC,EAAE,EAAE;QACnD,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAChE,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC,EAAE;IAEL,SAAS,qBAAqB,CAAC,IAAY;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;IAED,SAAS,sBAAsB,CAAC,UAAgC;QAC9D,IAAI,kBAAkB,GAAG,UAAU,CAAC,IAAI,CAAC;QACzC,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE;YAC3C,kBAAkB,GAAG,oCAAwB,CAAC,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACtF;QACD,OAAO,KAAK,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,kBAAkB,EAAE,CAAC;IAC/E,CAAC;AACH,CAAC;AApBD,wEAoBC"}
+{"version":3,"file":"doc-comment-annotation-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/doc-comment-annotation-util.ts"],"names":[],"mappings":";;;AACA,qGAA4F;AAO5F,SAAgB,8BAA8B,CAAC,YAA0B,EAAE,eAAgC;;IACzG,MAAA,eAAe,CAAC,UAAU,0CAAE,WAAW,CACpC,MAAM,CAAC,CAAC,iBAAuC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,aAAa,EAC5F,OAAO,CAAC,CAAC,iBAAuC,EAAE,EAAE;QACnD,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAChE,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC,EAAE;IAEL,SAAS,kBAAkB,CAAC,IAAY;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,gBAAgB,GAAG,EAAE,CAAC;QAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SACrE;QACD,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,SAAS,sBAAsB,CAAC,UAAgC;QAC9D,IAAI,kBAAkB,GAAG,UAAU,CAAC,IAAI,CAAC;QACzC,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE;YAC3C,kBAAkB,GAAG,oCAAwB,CAAC,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACtF;QACD,OAAO,KAAK,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,kBAAkB,EAAE,CAAC;IAC5E,CAAC;AACH,CAAC;AAzBD,wEAyBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.2.2",
+  "version": "2.2.5",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -64,7 +64,7 @@
     ]
   },
   "dependencies": {
-    "@cparra/apex-reflection": "^1.4.0",
+    "@cparra/apex-reflection": "^1.5.1",
     "fast-xml-parser": "^4.0.1",
     "chalk": "^4.1.2",
     "html-entities": "^2.3.2",

package/src/model/markdown-generation-util/doc-comment-annotation-util.ts

@@ -15,8 +15,13 @@ export function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCo
       markdownFile.addBlankLine();
     });
 
-  function capitalizeFirstLetter(text: string) {
-    return text.charAt(0).toUpperCase() + text.slice(1);
+  function splitAndCapitalize(text: string) {
+    const words = text.split(/[-_]+/);
+    const capitalizedWords = [];
+    for (const word of words) {
+      capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
+    }
+    return capitalizedWords.join(' ');
   }
 
   function buildDocAnnotationText(annotation: DocCommentAnnotation) {
@@ -24,6 +29,6 @@ export function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCo
     if (annotation.name.toLowerCase() === 'see') {
       annotationBodyText = ClassFileGeneratorHelper.getFileLinkByTypeName(annotation.body);
     }
-    return `**${capitalizeFirstLetter(annotation.name)}** ${annotationBodyText}`;
+    return `**${splitAndCapitalize(annotation.name)}** ${annotationBodyText}`;
   }
 }