@cparra/apexdocs 2.25.0-alpha.0 → 2.25.0-alpha.2

package/__mocks__/chalk.js

@@ -0,0 +1,12 @@
+// __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

@@ -0,0 +1,6 @@
+// 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

@@ -0,0 +1,10 @@
+// @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/plain-markdown/docs/Miscellaneous/ns.BaseClass.md

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

package/examples/plain-markdown/docs/Miscellaneous/ns.MultiInheritanceClass.md

@@ -0,0 +1,73 @@
+# MultiInheritanceClass Class
+
+## Namespace
+ns
+
+**Inheritance**
+[ns.SampleClass](../SampleGroup/ns.SampleClass.md) < [ns.BaseClass](./ns.BaseClass.md)
+
+## Fields
+### `sampleEnumFromBase`
+
+*Inherited*
+
+#### Signature
+```apex
+public sampleEnumFromBase
+```
+
+#### Type
+[ns.SampleEnum](../Sample-Enums/ns.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
+```apex
+SampleClass sample = new SampleClass();
+sample.doSomething();
+```

package/examples/plain-markdown/docs/Miscellaneous/ns.ParentInterface.md

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

package/examples/plain-markdown/docs/Miscellaneous/ns.ReferencedEnum.md

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

package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md

@@ -0,0 +1,7 @@
+# SampleException Class
+
+## Namespace
+ns
+
+**Inheritance**
+Exception

package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md

@@ -0,0 +1,115 @@
+# SampleInterface Interface
+
+`NAMESPACEACCESSIBLE`
+
+This is a sample interface
+
+**Author** John Doe
+
+**Date** 2020-01-01
+
+**See** [ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
+
+**See** [ns.ReferencedEnum](./ns.ReferencedEnum.md)
+
+## Namespace
+ns
+
+## Diagram
+```mermaid
+graph TD
+   A[SampleInterface] -->|extends| B[ParentInterface]
+   B -->|extends| C[GrandParentInterface]
+   C -->|extends| D[GreatGrandParentInterface]
+```
+
+## Example
+```apex
+SampleInterface sampleInterface = new SampleInterface();
+sampleInterface.sampleMethod();
+```
+
+**Extends**
+[ns.ParentInterface](./ns.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
+
+#### Signature
+```apex
+public String sampleMethod()
+```
+
+#### Return Type
+**String**
+
+Some return value
+
+#### Throws
+[ns.SampleException](./ns.SampleException.md): This is a sample exception
+
+AnotherSampleException: This is another sample exception
+
+#### Diagram
+```mermaid
+graph TD
+  A[SampleInterface] -->|extends| B[ParentInterface]
+  B -->|extends| C[GrandParentInterface]
+  C -->|extends| D[GreatGrandParentInterface]
+```
+
+#### Example
+```apex
+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 | [ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md) | This is an enum parameter |
+
+#### Return Type
+**[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)**
+
+Some return value
+
+---
+
+### `sampleParentMethod()`
+
+*Inherited*
+
+#### Signature
+```apex
+public void sampleParentMethod()
+```
+
+#### Return Type
+**void**

package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md

@@ -0,0 +1,36 @@
+# SampleEnum Enum
+
+`NAMESPACEACCESSIBLE`
+
+This is a sample enum. This references [ns.ReferencedEnum](../Miscellaneous/ns.ReferencedEnum.md) . 
+
+This description has several lines
+
+**Some Custom** Test. I can also have a [ns.ReferencedEnum](../Miscellaneous/ns.ReferencedEnum.md) here. 
+
+And it can be multiline.
+
+**Group** Sample Enums
+
+**Author** John Doe
+
+**Date** 2022-01-01
+
+**See** [ns.ReferencedEnum](../Miscellaneous/ns.ReferencedEnum.md)
+
+## Namespace
+ns
+
+## Diagram
+```mermaid
+graph TD
+ A[SampleEnum] -->|references| B[ReferencedEnum]
+ B -->|referenced by| A
+```
+
+## Values
+| Value | Description |
+|-------|-------------|
+| VALUE1 | This is value 1 |
+| VALUE2 | This is value 2 |
+| VALUE3 | This is value 3 |

package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md

@@ -0,0 +1,173 @@
+# SampleClass Class
+`virtual`
+
+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.
+
+**Group** SampleGroup
+
+## Namespace
+ns
+
+## Example
+```apex
+SampleClass sample = new SampleClass();
+sample.doSomething();
+```
+
+**Inheritance**
+[ns.BaseClass](../Miscellaneous/ns.BaseClass.md)
+
+**Implements**
+[ns.SampleInterface](../Miscellaneous/ns.SampleInterface.md), 
+[ns.ParentInterface](../Miscellaneous/ns.ParentInterface.md)
+
+## Fields
+### Group Name
+#### `name`
+
+This is a sample field.
+
+##### Signature
+```apex
+private name
+```
+
+##### Type
+String
+
+### Other
+#### `sampleEnumFromBase`
+
+*Inherited*
+
+##### Signature
+```apex
+public sampleEnumFromBase
+```
+
+##### Type
+[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
+
+## Properties
+### Group Name
+#### `someProperty`
+
+##### Signature
+```apex
+public someProperty
+```
+
+##### Type
+String
+
+## Constructors
+### Other
+#### `SampleClass()`
+
+This is a sample constructor.
+
+##### Signature
+```apex
+public SampleClass()
+```
+
+### Other Constructors
+#### `SampleClass(name)`
+
+##### Signature
+```apex
+public SampleClass(String name)
+```
+
+##### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| name | String |  |
+
+## Methods
+### Available Methods
+#### `doSomething()`
+
+##### Signature
+```apex
+public void doSomething()
+```
+
+##### Return Type
+**void**
+
+### Deprecated Methods
+#### `sayHello()`
+
+`DEPRECATED`
+
+This is a sample method.
+
+##### Signature
+```apex
+public virtual String sayHello()
+```
+
+##### Return Type
+**String**
+
+A string value.
+
+##### Example
+```apex
+SampleClass sample = new SampleClass();
+sample.doSomething();
+```
+
+## Classes
+### SomeInnerClass Class
+
+#### Fields
+##### `someInnerField`
+
+###### Signature
+```apex
+public someInnerField
+```
+
+###### Type
+String
+
+#### Methods
+##### `doSomething()`
+
+###### Signature
+```apex
+public void doSomething()
+```
+
+###### Return Type
+**void**
+
+## Enums
+### SomeEnum Enum
+
+This enum is used for foo and bar.
+
+#### Values
+| Value | Description |
+|-------|-------------|
+| TEST_1 | This is a test. |
+| TEST_2 |  |
+| TEST_3 |  |
+
+## Interfaces
+### SomeInterface Interface
+
+#### Methods
+##### `doSomething()`
+
+###### Signature
+```apex
+public void doSomething()
+```
+
+###### Return Type
+**void**

package/examples/plain-markdown/docs/index.md

@@ -0,0 +1,33 @@
+# Apex Reference Guide
+
+## Miscellaneous
+
+### [ns.BaseClass](./Miscellaneous/ns.BaseClass.md)
+
+### [ns.MultiInheritanceClass](./Miscellaneous/ns.MultiInheritanceClass.md)
+
+### [ns.ParentInterface](./Miscellaneous/ns.ParentInterface.md)
+
+### [ns.ReferencedEnum](./Miscellaneous/ns.ReferencedEnum.md)
+
+### [ns.SampleException](./Miscellaneous/ns.SampleException.md)
+
+### [ns.SampleInterface](./Miscellaneous/ns.SampleInterface.md)
+
+This is a sample interface
+
+## Sample Enums
+
+### [ns.SampleEnum](./Sample-Enums/ns.SampleEnum.md)
+
+This is a sample enum. This references [ns.ReferencedEnum](./Miscellaneous/ns.ReferencedEnum.md) . 
+
+This description has several lines
+
+## SampleGroup
+
+### [ns.SampleClass](./SampleGroup/ns.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/plain-markdown/force-app/classes/MultiInheritanceClass.cls

@@ -0,0 +1 @@
+public class MultiInheritanceClass extends SampleClass {}

package/examples/plain-markdown/force-app/classes/SampleClass.cls

@@ -7,19 +7,32 @@
  * sample.doSomething();
  */
 public with sharing virtual class SampleClass extends BaseClass implements SampleInterface, ParentInterface {
+    // @start-group Group Name
     /**
      * @description This is a sample field.
      */
     private final String name;
+    public String someProperty { get; private set; }
+    // @end-group
 
     /**
      * @description This is a sample constructor.
      */
     public SampleClass() {}
 
+    // @start-group Other Constructors
     public SampleClass(String name) {
         this.name = name;
     }
+    // @end-group
+
+    // @start-group Available Methods
+    public void doSomething() {
+        System.debug('Doing something');
+    }
+    // @end-group
+
+    // @start-group Deprecated Methods
 
     /**
      * @description This is a sample method.
@@ -32,4 +45,28 @@ public with sharing virtual class SampleClass extends BaseClass implements Sampl
     public virtual String sayHello() {
         return 'Hello';
     }
+
+    // @end-group
+
+    public class SomeInnerClass {
+        public String someInnerField;
+
+        public void doSomething() {
+            System.debug('Doing something');
+        }
+    }
+
+    /**
+     * @description This enum is used for foo and bar.
+     */
+    public enum SomeEnum {
+        /** @description This is a test. */
+        TEST_1,
+        TEST_2,
+        TEST_3
+    }
+
+    public interface SomeInterface {
+        void doSomething();
+    }
 }

package/examples/plain-markdown/package.json

@@ -1,7 +1,7 @@
 {
   "name": "plain-markdown",
   "scripts": {
-    "docs:clean": "rimraf ./README.md",
+    "docs:clean": "rimraf docs",
     "docs:build": "ts-node ../../src/cli/generate.ts",
     "docs:gen": "npm run docs:clean && npm run docs:build"
   },
@@ -15,10 +15,6 @@
     "sourceDir": "force-app",
     "targetGenerator": "plain-markdown",
     "scope": ["global", "public", "protected", "private", "namespaceaccessible"],
-    "namespace": "ns",
-    "singleFile": true,
-    "templateFilePath": "template.md",
-    "fileName": "README",
-    "targetDir": "."
+    "namespace": "ns"
   }
 }

package/jest.config.js

@@ -2,4 +2,8 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   modulePathIgnorePatterns: ['<rootDir>/lib/'],
+  moduleNameMapper: {
+    '^chalk$': '<rootDir>/__mocks__/chalk.js',
+    '^log-update$': '<rootDir>/__mocks__/log-update.js',
+  },
 };

package/jest.d.ts

@@ -0,0 +1,7 @@
+declare namespace jest {
+  interface Matchers<R> {
+    documentationBundleHasLength(length: number): R;
+    firstDocContains(content: string): R;
+    firstDocContainsNot(content: string): R;
+  }
+}

package/lib/__spec__/core/expect-extensions.d.ts

@@ -0,0 +1,3 @@
+import * as E from 'fp-ts/Either';
+export declare function extendExpect(): void;
+export declare function assertEither<T, U>(result: E.Either<T, U>, assertion: (data: U) => void): void;

package/lib/__spec__/core/expect-extensions.js

@@ -0,0 +1,54 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extendExpect = extendExpect;
+exports.assertEither = assertEither;
+const E = __importStar(require("fp-ts/Either"));
+function extendExpect() {
+    expect.extend({
+        documentationBundleHasLength(received, length) {
+            return {
+                pass: E.isRight(received) && received.right.docs.length === length,
+                message: () => `Expected documentation bundle to have length ${length}`,
+            };
+        },
+        firstDocContains(doc, content) {
+            return {
+                pass: doc.docs[0].docContents.includes(content),
+                message: () => `Expected documentation to contain ${content}. Got ${doc.docs[0].docContents}`,
+            };
+        },
+        firstDocContainsNot(doc, content) {
+            return {
+                pass: !doc.docs[0].docContents.includes(content),
+                message: () => `Expected documentation to not contain ${content}. Got ${doc.docs[0].docContents}`,
+            };
+        },
+    });
+}
+function assertEither(result, assertion) {
+    E.match((error) => fail(error), (data) => assertion(data))(result);
+}
+//# sourceMappingURL=expect-extensions.js.map

package/lib/__spec__/core/expect-extensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expect-extensions.js","sourceRoot":"","sources":["../../../src/__spec__/core/expect-extensions.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAGA,oCAqBC;AAED,oCAKC;AA/BD,gDAAkC;AAGlC,SAAgB,YAAY;IAC1B,MAAM,CAAC,MAAM,CAAC;QACZ,4BAA4B,CAAC,QAAiD,EAAE,MAAc;YAC5F,OAAO;gBACL,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM;gBAClE,OAAO,EAAE,GAAG,EAAE,CAAC,gDAAgD,MAAM,EAAE;aACxE,CAAC;QACJ,CAAC;QACD,gBAAgB,CAAC,GAAwB,EAAE,OAAe;YACxD,OAAO;gBACL,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAC/C,OAAO,EAAE,GAAG,EAAE,CAAC,qCAAqC,OAAO,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;aAC9F,CAAC;QACJ,CAAC;QACD,mBAAmB,CAAC,GAAwB,EAAE,OAAe;YAC3D,OAAO;gBACL,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAChD,OAAO,EAAE,GAAG,EAAE,CAAC,yCAAyC,OAAO,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;aAClG,CAAC;QACJ,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,YAAY,CAAO,MAAsB,EAAE,SAA4B;IACrF,CAAC,CAAC,KAAK,CACL,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EACtB,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAC1B,CAAC,MAAM,CAAC,CAAC;AACZ,CAAC"}

package/lib/__spec__/core/generating-class-docs.spec.d.ts

@@ -0,0 +1 @@
+export {};