@cparra/apexdocs 3.0.0-rc.0 → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.0.0-rc.0",
+  "version": "3.1.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -12,6 +12,9 @@
   ],
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "bin": {
     "apexdocs": "./dist/cli/generate.js"
   },
@@ -59,7 +62,7 @@
     ]
   },
   "dependencies": {
-    "@cparra/apex-reflection": "2.12.1",
+    "@cparra/apex-reflection": "2.13.1",
     "@types/js-yaml": "^4.0.9",
     "@types/yargs": "^17.0.32",
     "chalk": "^4.1.2",

package/.github/workflows/ci.yaml

@@ -1,22 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: ["master", "develop"]
-  pull_request:
-    branches: ["main", "develop"]
-  workflow_dispatch:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup node
-        uses: actions/setup-node@v3
-        with:
-          node-version: "20"
-          cache: "npm"
-      - run: npm ci
-      - run: npm run build --if-present
-      - run: npm test

package/.github/workflows/close_stale.yml

@@ -1,22 +0,0 @@
-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@v5
-        with:
-          days-before-issue-stale: 30
-          days-before-issue-close: 14
-          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/.prettierrc.js

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

package/__mocks__/chalk.js

@@ -1,12 +0,0 @@
-// __mocks__/chalk.js
-module.exports = new Proxy(
-  {},
-  {
-    get: function (target, property) {
-      return property === 'default' ? this : (text) => text;
-    },
-    green: function (text) {
-      return text;
-    },
-  },
-);

package/__mocks__/log-update.js

@@ -1,6 +0,0 @@
-// This is a basic mock that can be expanded based on your needs.
-// It mocks the main function of log-update to just log to console or do nothing.
-module.exports = {
-  // Mock the main function to just log the text or do nothing
-  default: function () {},
-};

package/eslint.config.mjs

@@ -1,10 +0,0 @@
-// @ts-check
-
-import eslint from '@eslint/js';
-import tseslint from 'typescript-eslint';
-import eslintConfigPrettier from "eslint-config-prettier";
-
-export default tseslint.config(
-  eslint.configs.recommended,
-  ...tseslint.configs.recommended,
-  eslintConfigPrettier);

package/examples/markdown/.forceignore

@@ -1,12 +0,0 @@
-# List files or directories below to ignore them when running force:source:push, force:source:pull, and force:source:status
-# More information: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_exclude_source.htm
-#
-
-package.xml
-
-# LWC configuration files
-**/jsconfig.json
-**/.eslintrc.json
-
-# LWC Jest
-**/__tests__/**

package/examples/markdown/config/project-scratch-def.json

@@ -1,5 +0,0 @@
-{
-  "orgName": "cesarparra company",
-  "edition": "Developer",
-  "features": []
-}

package/examples/markdown/docs/index.md

@@ -1,109 +0,0 @@
-# Apex Reference Guide
-
-## Miscellaneous
-
-### [BaseClass](miscellaneous/BaseClass.md)
-
-### [MultiInheritanceClass](miscellaneous/MultiInheritanceClass.md)
-
-### [ParentInterface](miscellaneous/ParentInterface.md)
-
-### [ReferencedEnum](miscellaneous/ReferencedEnum.md)
-
-### [SampleException](miscellaneous/SampleException.md)
-
-This is a sample exception.
-
-### [SampleInterface](miscellaneous/SampleInterface.md)
-
-This is a sample interface
-
-### [Url](miscellaneous/Url.md)
-
-Represents a uniform resource locator (URL) and provides access to parts of the URL. 
-Enables access to the base URL used to access your Salesforce org. 
- 
-## Usage 
-Use the methods of the `System.URL` class to create links to objects in your organization. Such objects can be files, images, 
-logos, or records that you want to include in external emails, in activities, or in Chatter posts. For example, you can create 
-a link to a file uploaded as an attachment to a Chatter post by concatenating the Salesforce base URL with the file ID: 
- 
-```apex
-// Get a file uploaded through Chatter.
-ContentDocument doc = [SELECT Id FROM ContentDocument
-        WHERE Title = 'myfile'];
-// Create a link to the file.
-String fullFileURL = URL.getOrgDomainURL().toExternalForm() +
-'/' + doc.id;
-system.debug(fullFileURL);
-```
-
- 
-The following example creates a link to a Salesforce record. The full URL is created by concatenating the Salesforce base 
-URL with the record ID. 
- 
-```ape
-Account acct = [SELECT Id FROM Account WHERE Name = 'Acme' LIMIT 1];
-String fullRecordURL = URL.getOrgDomainURL().toExternalForm() + '/' + acct.Id;
-```
-
- 
-## Example 
-In this example, the base URL and the full request URL of the current Salesforce server instance are retrieved. Next, a URL 
-pointing to a specific account object is created. Finally, components of the base and full URL are obtained. This example 
-prints out all the results to the debug log output. 
- 
-```apex
-// Create a new account called Acme that we will create a link for later.
-Account myAccount = new Account(Name='Acme');
-insert myAccount;
-
-// Get the base URL.
-String sfdcBaseURL = URL.getOrgDomainURL().toExternalForm();
-System.debug('Base URL: ' + sfdcBaseURL );
-
-// Get the URL for the current request.
-String currentRequestURL = URL.getCurrentRequestUrl().toExternalForm();
-System.debug('Current request URL: ' + currentRequestURL);
-
-// Create the account URL from the base URL.
-String accountURL = URL.getOrgDomainURL().toExternalForm() +
-                       '/' + myAccount.Id;
-System.debug('URL of a particular account: ' + accountURL);
-
-// Get some parts of the base URL.
-System.debug('Host: ' + URL.getOrgDomainURL().getHost());
-System.debug('Protocol: ' + URL.getOrgDomainURL().getProtocol());
-
-// Get the query string of the current request.
-System.debug('Query: ' + URL.getCurrentRequestUrl().getQuery());
-```
-
- 
-## Version Behavior Changes 
-In API version 41.0 and later, Apex URL objects are represented by the java.net.URI type, not the java.net.URL type. 
-The API version in which the URL object was instantiated determines the behavior of subsequent method calls to the 
-specific instance. Salesforce strongly encourages you to use API 41.0 and later versions for fully RFC-compliant URL 
-parsing that includes proper handling of edge cases of complex URL structures. API 41.0 and later versions also enforce 
-that inputs are valid, RFC-compliant URL or URI strings. 
- 
-* [URL Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_constructors) 
-* [URL Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_methods) 
- 
-**See Also** 
-* [URL Class](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_url.htm)
-
-## Sample Enums
-
-### [SampleEnum](sample-enums/SampleEnum.md)
-
-This is a sample enum. This references [ReferencedEnum](miscellaneous/ReferencedEnum.md) . 
- 
-This description has several lines
-
-## SampleGroup
-
-### [SampleClass](samplegroup/SampleClass.md)
-
-aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex 
-deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.

package/examples/markdown/docs/miscellaneous/BaseClass.md

@@ -1,16 +0,0 @@
-# BaseClass Class
-`abstract`
-
-## Namespace
-ns
-
-## Fields
-### `sampleEnumFromBase`
-
-#### Signature
-```apex
-public sampleEnumFromBase
-```
-
-#### Type
-[SampleEnum](../sample-enums/SampleEnum.md)

package/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md

@@ -1,72 +0,0 @@
-# MultiInheritanceClass Class
-
-## Namespace
-ns
-
-**Inheritance**
-
-[SampleClass](../samplegroup/SampleClass.md) < [BaseClass](BaseClass.md)
-
-## Fields
-### `sampleEnumFromBase`
-
-*Inherited*
-
-#### Signature
-```apex
-public sampleEnumFromBase
-```
-
-#### Type
-[SampleEnum](../sample-enums/SampleEnum.md)
-
-## Properties
-### Group Name
-#### `someProperty`
-
-*Inherited*
-
-##### Signature
-```apex
-public someProperty
-```
-
-##### Type
-String
-
-## Methods
-### Available Methods
-#### `doSomething()`
-
-*Inherited*
-
-##### Signature
-```apex
-public void doSomething()
-```
-
-##### Return Type
-**void**
-
-### Deprecated Methods
-#### `sayHello()`
-
-*Inherited*
-
-`DEPRECATED`
-
-This is a sample method.
-
-##### Signature
-```apex
-public virtual String sayHello()
-```
-
-##### Return Type
-**String**
-
-A string value.
-
-##### Example
-SampleClass sample &#x3D; new SampleClass(); 
-sample.doSomething();

package/examples/markdown/docs/miscellaneous/ParentInterface.md

@@ -1,15 +0,0 @@
-# ParentInterface Interface
-
-## Namespace
-ns
-
-## Methods
-### `sampleParentMethod()`
-
-#### Signature
-```apex
-public void sampleParentMethod()
-```
-
-#### Return Type
-**void**

package/examples/markdown/docs/miscellaneous/ReferencedEnum.md

@@ -1,8 +0,0 @@
-# ReferencedEnum Enum
-
-## Namespace
-ns
-
-## Values
-| Value | Description |
-|-------|-------------|

package/examples/markdown/docs/miscellaneous/SampleException.md

@@ -1,24 +0,0 @@
-# SampleException Class
-
-This is a sample exception.
-
-**Usage** 
-
-You can use the exception the following way. 
-You can also take a look at [SampleClass](../samplegroup/SampleClass.md) to see how it is used. 
-This is a dangerous HTML tag: <script>alert('Hello');</script> 
- 
-```apex
-try {
-   throw new SampleException();
-} catch (SampleException e) {
-  System.debug('Caught exception');
-}
-```
-
-## Namespace
-ns
-
-**Inheritance**
-
-Exception

package/examples/markdown/docs/miscellaneous/SampleInterface.md

@@ -1,116 +0,0 @@
-# SampleInterface Interface
-
-`NAMESPACEACCESSIBLE`
-
-This is a sample interface
-
-**Mermaid** 
-
-```mermaid
-graph TD
-   A[SampleInterface] -->|extends| B[ParentInterface]
-   B -->|extends| C[GrandParentInterface]
-   C -->|extends| D[GreatGrandParentInterface]
-```
-
-**Author** John Doe
-
-**Date** 2020-01-01
-
-**See** [SampleEnum](../sample-enums/SampleEnum.md)
-
-**See** [ReferencedEnum](ReferencedEnum.md)
-
-## Namespace
-ns
-
-## Example
-```apex
-SampleInterface sampleInterface = new SampleInterface();
-sampleInterface.sampleMethod();
-```
-
-**Extends**
-[ParentInterface](ParentInterface.md)
-
-## Methods
-### `sampleMethod()`
-
-`NAMESPACEACCESSIBLE`
-
-This is a sample method
-
-**Custom Tag** 
-
-This is a custom tag
-
-**Another Custom Tag** 
-
-This is another custom tag
-
-**Mermaid** 
-
-graph TD 
-A[SampleInterface] -->|extends| B[ParentInterface] 
-B -->|extends| C[GrandParentInterface] 
-C -->|extends| D[GreatGrandParentInterface]
-
-#### Signature
-```apex
-public String sampleMethod()
-```
-
-#### Return Type
-**String**
-
-Some return value
-
-#### Throws
-[SampleException](SampleException.md): This is a sample exception
-
-AnotherSampleException: This is another sample exception
-
-#### Example
-SampleInterface sampleInterface = new SampleInterface(); 
-sampleInterface.sampleMethod();
-
----
-
-### `sampleMethodWithParams(param1, param2, theEnum)`
-
-`NAMESPACEACCESSIBLE`
-`DEPRECATED`
-
-This is a sample method with parameters 
-Sometimes it won't be possible to find a NonExistent link.
-
-#### Signature
-```apex
-public SampleEnum sampleMethodWithParams(String param1, Integer param2, SampleEnum theEnum)
-```
-
-#### Parameters
-| Name | Type | Description |
-|------|------|-------------|
-| param1 | String | This is the first parameter |
-| param2 | Integer | This is the second parameter |
-| theEnum | [SampleEnum](../sample-enums/SampleEnum.md) | This is an enum parameter |
-
-#### Return Type
-**[SampleEnum](../sample-enums/SampleEnum.md)**
-
-Some return value
-
----
-
-### `sampleParentMethod()`
-
-*Inherited*
-
-#### Signature
-```apex
-public void sampleParentMethod()
-```
-
-#### Return Type
-**void**