@cparra/apexdocs 1.13.8 → 2.0.0-alpha.15

package/.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+  },
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  rules: {},
+};

package/.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  semi: true,
+  trailingComma: 'all',
+  singleQuote: true,
+  printWidth: 120,
+  tabWidth: 2,
+};

package/README.md

@@ -1,21 +1,76 @@
 # ApexDocs
 
 <p align="center">
-  <b>ApexDocs is a Node.js library with CLI capabilities to generate documentation for Salesforce Apex classes.</b>
+  <b>ApexDocs is a Node.js library with CLI capabilities to docGenerator documentation for Salesforce Apex classes.</b>
 </p>
 
 [![License](https://img.shields.io/github/license/cesarParra/apexdocs)](https://github.com/cesarParra/apexdocs/blob/master/LICENSE)
 
 ## Description
 
-ApexDocs was built as an alternative to the [Java based ApexDoc tool](https://github.com/SalesforceFoundation/ApexDoc) originally created by Aslam Bari and later maintained by Salesforce.org, as that tool is no longer being maintained.
+ApexDocs was originally built as an alternative to
+the [Java based ApexDoc tool](https://github.com/SalesforceFoundation/ApexDoc) originally created by Aslam Bari and
+later maintained by Salesforce.org, as that tool is no longer being maintained.
 
-ApexDocs is a Node.js library built on Typescript and hosted on [npm](https://www.npmjs.com/package/@cparra/apexdocs). It offers CLI capabilities to automatically generate a set of files that fully document each one of you classes. Additionally it can be imported and consumed directly by your JavaScript code.
+ApexDocs is a Node.js library built on Typescript and hosted on [npm](https://www.npmjs.com/package/@cparra/apexdocs).
+It offers CLI capabilities to automatically docGenerator a set of files that fully document each one of you classes.
+Additionally, it can be imported and consumed directly by your JavaScript code.
 
 There are some key differences between ApexDocs and the Java based ApexDoc tool:
 
-- **Recursive file search through your module directory structure**. In an `sfdx` based project, all of your classes will be documented by specifying the top-most directory where file search should begin.
-- **Unopinionated documentation site generation**. Instead of creating HTML files, ApexDocs generates a Markdown (.md) file per Apex class being documented. This means you can host your files in static web hosting services that parse Markdown like Github Pages or Netlify, and use site generators like Jekyll or Gatsby. This gives you the freedom to decide how to style your site to match your needs.
+- **Recursive file search through your module directory structure**. In an `sfdx` based project, all of your classes
+  will be documented by specifying the top-most directory where file search should begin.
+- **Unopinionated documentation site generation**. Instead of creating HTML files, ApexDocs generates a Markdown (.md)
+  file per Apex class being documented. This means you can host your files in static web hosting services that parse
+  Markdown like Github Pages or Netlify, and use site generators like Jekyll or Gatsby. This gives you the freedom to
+  decide how to style your site to match your needs.
+
+## Version 2.X
+
+Version shares almost* all the same functionality (and more) of 1.X , but is a rewrite from the ground up of the tool,
+so please be aware if migrating from a 1.X version.
+
+The Apex code parsing logic for the 1.X codebase was almost a one-to-one translation of the Java based ApexDoc tool to
+Javascript. With 2.X the parsing logic has been improved and extracted out of this codebase, and into its own standalone
+NPM module which is solely focused on Apex code reflection: https://www.npmjs.com/package/@cparra/apex-reflection
+
+This allows for an improved code quality of both code bases and an increased ease of introducing future improvements and
+fixing issues.
+
+But please be aware: migration to 2.X is not recommended at this time for production until a GA release.
+
+### Differences between the versions
+
+When migrating from 1.X please be aware of these changes between the major versions:
+
+#### Deprecated features
+
+* The `--group` CLI parameter has been deprecated. All files are grouped by default.
+
+#### Features not yet migrated to 2.X
+
+* The `--configPath` CLI parameter has been temporarily deprecated. We are planning on reintroducing it but the config
+  file will use a different format.
+* Internal linking between files using the `@see` annotation and {@link FileName} and <<FileName>> syntax has not been
+  implemented.
+
+#### New features
+
+* All Apex annotations are now supported through the `--scope` CLI parameter, not just `namespaceaccessible`. This means
+  that scopes like `auraenabled`, `invocablemethod`, `invocablevariable`, `remoteaction`, and all other valid Apex
+  annotations are supported.
+* Just like Javadoc, both `@throws` and `@exception` are supported when referencing an exception thrown by a method or
+  constructor.
+* Any custom annotation defined in the Apexdoc is at the class level are supported, for example the following will be
+  output to the resulting markdown file:
+
+```apex
+/**
+ * @MyCustomAnnotation This is a custom annotation
+ */
+public class MyClass {
+}
+```
 
 ### Demo
 
@@ -23,7 +78,7 @@ ApexDocs currently supports generating markdown files for Jekyll and Docsify sit
 
 ### In the wild
 
-- [Nimble AMS Docs](https://nimbleuser.github.io/nams-api-docs/#/public-apis/)
+- [Nimble AMS Docs](https://nimbleuser.github.io/nams-api-docs/#/api-reference/)
 - [Yet Another Salesforce Logger](https://cesarparra.github.io/yet-another-salesforce-logger/#/)
 
 ### [Docsify](https://docsify.js.org/)
@@ -41,7 +96,7 @@ Demo
 ## Installation
 
 ```bash
-npm i @cparra/apexdocs
+npm i -g @cparra/apexdocs
 ```
 
 ## Usage
@@ -65,12 +120,13 @@ The CLI supports the following parameters:
 | --recursive       | -r    | Whether .cls classes will be searched for recursively in the directory provided.                                 | `true`                              | No       |
 | --scope           | -p    | A list of scopes to document. Values should be separated by a space, e.g --scope public private                  | `global namespaceaccessible public` | No       |
 | --targetGenerator | -g    | Define the static file generator for which the documents will be created. Currently supports jekyll and docsify. | `jekyll`                            | No       |
-| --configPath      | -c    | The path to the JSON configuration file that defines the structure of the documents to generate.                 | N/A                                 | No       |
+| --configPath      | -c    | The path to the JSON configuration file that defines the structure of the documents to docGenerator.                 | N/A                                 | No       |
 | --group           | -o    | Define whether the generated files should be grouped by the @group tag on the top level classes.                 | `true`                              | No       |
 
 #### Configuration File
 
-You can optionally specify the path to a configuration JSON file through the `--configPath` parameter. This let's you have some additional control over the content outputs.
+You can optionally specify the path to a configuration JSON file through the `--configPath` parameter. This let's you
+have some additional control over the content outputs.
 
 The configuration file allows you to specify the following:
 
@@ -80,7 +136,8 @@ _Note_: Everything in the configuration file is optional. When something is not
 
 Default: None
 
-Allows you to specify the root directory for where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.
+Allows you to specify the root directory for where the files are being generated. This can be helpful when embedding the
+generated docs into an existing site so that the links are generated correctly.
 
 `defaultGroupName`
 
@@ -92,9 +149,11 @@ Defines the `@group` name to be used when a file does not specify it.
 
 Default: None
 
-Defines the name of the language that will be used when generating `@example` blocks. Use this when you are interested in using syntax highlighting for your project.
+Defines the name of the language that will be used when generating `@example` blocks. Use this when you are interested
+in using syntax highlighting for your project.
 
-Even though the source code material for which documentation is generated is always `Apex`, generally you will be able to use a syntax highlighter that recognizes `java` source code, so set this value to `java` in those cases.
+Even though the source code material for which documentation is generated is always `Apex`, generally you will be able
+to use a syntax highlighter that recognizes `java` source code, so set this value to `java` in those cases.
 
 `home` (Object)
 
@@ -104,7 +163,8 @@ Gives you control over the home page.
 
 Default: None
 
-Allows you to embedd custom content into your home page by using the `header` property to point to the a file which contents will be added to the top of the generated home page.
+Allows you to embed custom content into your home page by using the `header` property to point to the file which
+contents will be added to the top of the generated home page.
 
 Specify the path with the content that you want to embed.
 
@@ -128,7 +188,9 @@ Whether the `@date` tag should be used to add the file's date to the page.
 
 Default: 1
 
-The starting H tag level for the document. Each title will use this as the starting point to generate the approaprite `<h#>` tag. For example, if set to 1, the class' file name at the top of the file will use an `<h1>` tag, the `Properties` title will be `<h2>`, each property name will be an `<h3>`, etc.
+The starting H tag level for the document. Each title will use this as the starting point to docGenerator the
+appropriate `<h#>` tag. For example, if set to 1, the class' file name at the top of the file will use an `<h1>` tag,
+the `Properties` title will be `<h2>`, each property name will be an `<h3>`, etc.
 
 ```
 {
@@ -150,9 +212,10 @@ The starting H tag level for the document. Each title will use this as the start
 
 If you are just interested in the documentation parsing capabilities, you can import ApexDocs into your own project.
 
-Use the `generate` function to create a list of `ClassModel` that includes all of the parsed information from your .cls files.
+Use the `docGenerator` function to create a list of `ClassModel` that includes all the parsed information from your .cls
+files.
 
-`generate(sourceDirectory[,recursive][,scope][,outputDir])`
+`docGenerator(sourceDirectory[,recursive][,scope][,outputDir])`
 
 - `sourceDirectory` \<string>
 - `recursive` \<boolean>
@@ -160,14 +223,15 @@ Use the `generate` function to create a list of `ClassModel` that includes all o
 - `outpurDir` \<string>
 
 ```javascript
-var { generate } = require('@cparra/apexdocs');
+var { docGenerator } = require('@cparra/apexdocs');
 
-let documentedClasses = generate('src', true, ['global'], 'docs');
+let documentedClasses = docGenerator('src', true, ['global'], 'docs');
 ```
 
 ## Documentation Format
 
-ApexDocs picks up blocks of comments throughout your `.cls` files. The block must begin with `/**` and span through multiple lines, ending with `*/`.
+ApexDocs picks up blocks of comments throughout your `.cls` files. The block must begin with `/**` and span through
+multiple lines, ending with `*/`.
 
 ### Documenting Classes
 
@@ -183,11 +247,12 @@ The following tags are supported on the class level:
 
 **Example**
 
-```java
+```apex
 /**
  * @description This is my class description.
  */
- public with sharing class TestClass { }
+public with sharing class TestClass {
+}
 ```
 
 ### Documenting Enums
@@ -200,11 +265,13 @@ The following tags are supported on the enum level:
 
 **Example**
 
-```java
+```apex
 /**
  * @description This is my enum description.
  */
- public Enum ExampleEnum { VALUE_1, VALUE_2 }
+public Enum ExampleEnum {
+    VALUE_1, VALUE_2
+}
 ```
 
 ### Documenting Properties
@@ -217,11 +284,11 @@ The following tags are supported on the property level:
 
 **Example**
 
-```java
+```apex
 /**
  * @description This is my property description.
  */
- public String ExampleProperty { get; set; }
+public String ExampleProperty { get; set; }
 ```
 
 ### Documenting Methods and Constructors
@@ -240,7 +307,7 @@ The following tags are supported on the method level:
 
 **Example**
 
-```java
+```apex
 /**
  * @description This is my method description.
  * @param action The action to execute.
@@ -248,13 +315,13 @@ The following tags are supported on the method level:
  * @example
  * Object result = SampleClass.call('exampleAction');
  */
- public static Object call(String action) {
+public static Object call(String action) {
 ```
 
 ### Inline linking
 
-Apexdocs allows you to reference other classes from anywhere in your docs, and automatically creates a link to that class
-file for easy navigation.
+Apexdocs allows you to reference other classes from anywhere in your docs, and automatically creates a link to that
+class file for easy navigation.
 
 Apexdocs recognizes 2 different syntax when linking files:
 
@@ -263,13 +330,13 @@ Apexdocs recognizes 2 different syntax when linking files:
 
 **Example**
 
-```java
+```apex
 /**
  * @description This is my method description. This method receives an <<ExampleClass>>.
  * @param param1 An <<ExampleClass>> instance. Can also do {@link ExampleClass}
  * @return The result of the operation.
  */
- public static Object class(ExampleClass param1) {
+public static Object class(ExampleClass param1) {
 ```
 
 ## Typescript

package/ROADMAP.md

@@ -0,0 +1,18 @@
+[] Automatic Resolution of links (@see and {@link FileName})
+
+[] Respect access modifiers where the properties/methods are different from the class declaration. For example,
+AuraEnabled properties do not live in an AuraEnabled class, so there's no way to just generate docs to showcase the
+AuraEnabled properties of a class without some sort of combination of also exposing other public/globals
+
+[] Versioning capabilities. When creating the doc you specify a version number, and a new directory is created for the
+files, instead of just overriding
+
+[] New generatortype: To JsDocs from AuraEnabled
+
+[] More unit tests
+
+[] config.js support to allow for injections, home header, etc.
+
+[] Add configuration setting that allows someone to set the "namespace"
+
+[] Homepage support similar to what docsify does

package/docs/Gemfile.lock

@@ -13,21 +13,38 @@ GEM
     colorator (1.1.0)
     commonmarker (0.17.13)
       ruby-enum (~> 0.5)
-    concurrent-ruby (1.1.6)
-    dnsruby (1.61.3)
-      addressable (~> 2.5)
-    em-websocket (0.5.1)
+    concurrent-ruby (1.1.9)
+    dnsruby (1.61.7)
+      simpleidn (~> 0.1)
+    em-websocket (0.5.2)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
     eventmachine (1.2.7)
     eventmachine (1.2.7-x64-mingw32)
-    execjs (2.7.0)
-    faraday (1.0.0)
+    execjs (2.8.1)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    ffi (1.12.2)
-    ffi (1.12.2-x64-mingw32)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    ffi (1.15.4)
+    ffi (1.15.4-x64-mingw32)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
     github-pages (204)
@@ -79,7 +96,7 @@ GEM
       octokit (~> 4.0)
       public_suffix (~> 3.0)
       typhoeus (~> 1.3)
-    html-pipeline (2.12.3)
+    html-pipeline (2.14.0)
       activesupport (>= 2)
       nokogiri (>= 1.4)
     http_parser.rb (0.6.0)
@@ -192,7 +209,7 @@ GEM
       jekyll (>= 3.0, < 5.0)
     kramdown (1.17.0)
     liquid (4.0.3)
-    listen (3.2.1)
+    listen (3.7.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
@@ -200,26 +217,27 @@ GEM
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    multi_json (1.14.1)
+    multi_json (1.15.0)
     multipart-post (2.1.1)
-    nokogiri (1.11.5-x64-mingw32)
+    nokogiri (1.12.5-x64-mingw32)
       racc (~> 1.4)
-    nokogiri (1.11.5-x86_64-linux)
+    nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
-    octokit (4.16.0)
+    octokit (4.21.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (3.1.1)
-    racc (1.5.2)
-    rb-fsevent (0.10.3)
+    racc (1.6.0)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rouge (3.13.0)
-    ruby-enum (0.7.2)
+    ruby-enum (0.9.0)
       i18n
-    rubyzip (2.2.0)
+    ruby2_keywords (0.0.5)
+    rubyzip (2.3.2)
     safe_yaml (1.0.5)
     sass (3.7.4)
       sass-listen (~> 4.0.0)
@@ -229,15 +247,22 @@ GEM
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
+    simpleidn (0.2.1)
+      unf (~> 0.1.4)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
-    typhoeus (1.3.1)
+    typhoeus (1.4.0)
       ethon (>= 0.9.0)
     tzinfo (2.0.1)
       concurrent-ruby (~> 1.0)
     tzinfo-data (1.2019.3)
       tzinfo (>= 1.0.0)
-    unicode-display_width (1.6.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+    unf_ext (0.0.8-x64-mingw32)
+    unicode-display_width (1.8.0)
+    wdm (0.1.1)
 
 PLATFORMS
   x64-mingw32
@@ -248,6 +273,7 @@ DEPENDENCIES
   jekyll-feed (~> 0.6)
   minima (~> 2.0)
   tzinfo-data
+  wdm (~> 0.1.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.29