@cparra/apexdocs 2.8.1 → 2.8.2

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Cesar Parra
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 Cesar Parra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/docs/API/SampleClassWithoutModifier.md

@@ -1,11 +1,11 @@
-# SampleClassWithoutModifier
-
-`ISTEST`
-## Methods
-### `static thisIsAClassWithoutAModifier()`
-
-`ISTEST`
-
-This is a test method
-
----
+# SampleClassWithoutModifier
+
+`ISTEST`
+## Methods
+### `static thisIsAClassWithoutAModifier()`
+
+`ISTEST`
+
+This is a test method
+
+---

package/docs/Main/GroupedClass.md

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

package/docs/Misc-Group/AnotherInterface.md

@@ -1 +1 @@
-# AnotherInterface
+# AnotherInterface

package/docs/Misc-Group/ChildClass.md

@@ -1,78 +1,78 @@
-# ChildClass
-
-**Inheritance**
-
-[GrandparentClass](/Misc-Group/GrandparentClass.md)
- > 
-[ParentClass](/Misc-Group/ParentClass.md)
- > 
-ChildClass
-
-
-**Implemented types**
-
-[SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-## Fields
-
-### `protectedGrandParentField` → `String`
-
-*Inherited*
-
-### `protectedString` → `String`
-
-*Inherited*
-
-This is a protected string, use carefully.
-
-### `publicString` → `String`
-
-*Inherited*
-
----
-## Properties
-
-### `AProp` → `String`
-
-*Inherited*
-
----
-## Methods
-### `doSomething()`
-### `override overridableMethodOverridden()`
-
-This method was overridden.
-
-#### Return
-
-**Type**
-
-String
-
-**Description**
-
-A String.
-
-### `execute()`
-
-Executes the command.
-
-### `getValue()`
-
-Returns a value based on the executed command.
-
-#### Return
-
-**Type**
-
-String
-
-**Description**
-
-The value
-
-### `overridableMethod()`
-
-*Inherited*
-
----
+# ChildClass
+
+**Inheritance**
+
+[GrandparentClass](/Misc-Group/GrandparentClass.md)
+ > 
+[ParentClass](/Misc-Group/ParentClass.md)
+ > 
+ChildClass
+
+
+**Implemented types**
+
+[SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+## Fields
+
+### `protectedGrandParentField` → `String`
+
+*Inherited*
+
+### `protectedString` → `String`
+
+*Inherited*
+
+This is a protected string, use carefully.
+
+### `publicString` → `String`
+
+*Inherited*
+
+---
+## Properties
+
+### `AProp` → `String`
+
+*Inherited*
+
+---
+## Methods
+### `doSomething()`
+### `override overridableMethodOverridden()`
+
+This method was overridden.
+
+#### Return
+
+**Type**
+
+String
+
+**Description**
+
+A String.
+
+### `execute()`
+
+Executes the command.
+
+### `getValue()`
+
+Returns a value based on the executed command.
+
+#### Return
+
+**Type**
+
+String
+
+**Description**
+
+The value
+
+### `overridableMethod()`
+
+*Inherited*
+
+---

package/docs/Misc-Group/GrandparentClass.md

@@ -1,13 +1,13 @@
-# GrandparentClass
-## Fields
-
-### `protectedGrandParentField` → `String`
-
-
----
-## Properties
-
-### `AProp` → `String`
-
-
----
+# GrandparentClass
+## Fields
+
+### `protectedGrandParentField` → `String`
+
+
+---
+## Properties
+
+### `AProp` → `String`
+
+
+---

package/docs/Misc-Group/InterfaceWithInheritance.md

@@ -1,33 +1,33 @@
-# InterfaceWithInheritance
-
-**Extended types**
-
-[SampleInterface](/Sample-Interfaces/SampleInterface.md)
-, 
-[AnotherInterface](/Misc-Group/AnotherInterface.md)
-## Methods
-### `execute()`
-
-*Inherited*
-
-
-Executes the command.
-
-### `getValue()`
-
-*Inherited*
-
-
-Returns a value based on the executed command.
-
-#### Return
-
-**Type**
-
-String
-
-**Description**
-
-The value
-
----
+# InterfaceWithInheritance
+
+**Extended types**
+
+[SampleInterface](/Sample-Interfaces/SampleInterface.md)
+, 
+[AnotherInterface](/Misc-Group/AnotherInterface.md)
+## Methods
+### `execute()`
+
+*Inherited*
+
+
+Executes the command.
+
+### `getValue()`
+
+*Inherited*
+
+
+Returns a value based on the executed command.
+
+#### Return
+
+**Type**
+
+String
+
+**Description**
+
+The value
+
+---

package/docs/Misc-Group/ParentClass.md

@@ -1,37 +1,37 @@
-# ParentClass
-
-**Inheritance**
-
-[GrandparentClass](/Misc-Group/GrandparentClass.md)
- > 
-ParentClass
-
-## Fields
-
-### `privateString` → `String`
-
-
-### `protectedGrandParentField` → `String`
-
-*Inherited*
-
-### `protectedString` → `String`
-
-
-This is a protected string, use carefully.
-
-### `publicString` → `String`
-
-
----
-## Properties
-
-### `AProp` → `String`
-
-*Inherited*
-
----
-## Methods
-### `overridableMethod()`
-### `overridableMethodOverridden()`
----
+# ParentClass
+
+**Inheritance**
+
+[GrandparentClass](/Misc-Group/GrandparentClass.md)
+ > 
+ParentClass
+
+## Fields
+
+### `privateString` → `String`
+
+
+### `protectedGrandParentField` → `String`
+
+*Inherited*
+
+### `protectedString` → `String`
+
+
+This is a protected string, use carefully.
+
+### `publicString` → `String`
+
+
+---
+## Properties
+
+### `AProp` → `String`
+
+*Inherited*
+
+---
+## Methods
+### `overridableMethod()`
+### `overridableMethodOverridden()`
+---

package/docs/Misc-Group/SampleClassWithoutModifier.md

@@ -1,11 +1,11 @@
-# SampleClassWithoutModifier
-
-`ISTEST`
-## Methods
-### `static thisIsAClassWithoutAModifier()`
-
-`ISTEST`
-
-This is a test method
-
----
+# SampleClassWithoutModifier
+
+`ISTEST`
+## Methods
+### `static thisIsAClassWithoutAModifier()`
+
+`ISTEST`
+
+This is a test method
+
+---

package/docs/README.md

@@ -1,42 +1,42 @@
-# Classes
-## Misc Group
-
-### [AnotherInterface](/Misc-Group/AnotherInterface.md)
-
-
-### [ChildClass](/Misc-Group/ChildClass.md)
-
-
-### [GrandparentClass](/Misc-Group/GrandparentClass.md)
-
-
-### [InterfaceWithInheritance](/Misc-Group/InterfaceWithInheritance.md)
-
-
-### [ParentClass](/Misc-Group/ParentClass.md)
-
-
-### [SampleClassWithoutModifier](/Misc-Group/SampleClassWithoutModifier.md)
-
-## Main
-
-### [GroupedClass](/Main/GroupedClass.md)
-
-Uses a block style apex doc
-
-
-
-### [SampleClass](/Main/SampleClass.md)
-
-This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-             But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
-             You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-
-## Sample Interfaces
-
-### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-This is an interface description.
-
-
+# Classes
+## Misc Group
+
+### [AnotherInterface](/Misc-Group/AnotherInterface.md)
+
+
+### [ChildClass](/Misc-Group/ChildClass.md)
+
+
+### [GrandparentClass](/Misc-Group/GrandparentClass.md)
+
+
+### [InterfaceWithInheritance](/Misc-Group/InterfaceWithInheritance.md)
+
+
+### [ParentClass](/Misc-Group/ParentClass.md)
+
+
+### [SampleClassWithoutModifier](/Misc-Group/SampleClassWithoutModifier.md)
+
+## Main
+
+### [GroupedClass](/Main/GroupedClass.md)
+
+Uses a block style apex doc
+
+
+
+### [SampleClass](/Main/SampleClass.md)
+
+This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+             But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
+             You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+
+## Sample Interfaces
+
+### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+This is an interface description.
+
+

package/docs/Sample-Interfaces/SampleInterface.md

@@ -1,27 +1,27 @@
-# SampleInterface
-
-This is an interface description.
-
-
-**Group** Sample Interfaces
-
-## Methods
-### `execute()`
-
-Executes the command.
-
-### `getValue()`
-
-Returns a value based on the executed command.
-
-#### Return
-
-**Type**
-
-String
-
-**Description**
-
-The value
-
----
+# SampleInterface
+
+This is an interface description.
+
+
+**Group** Sample Interfaces
+
+## Methods
+### `execute()`
+
+Executes the command.
+
+### `getValue()`
+
+Returns a value based on the executed command.
+
+#### Return
+
+**Type**
+
+String
+
+**Description**
+
+The value
+
+---

package/docs/index.html

@@ -1,22 +1,22 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <title>Document</title>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-  <meta name="description" content="Description">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
-  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
-</head>
-<body>
-  <div id="app"></div>
-  <script>
-    window.$docsify = {
-      name: '',
-      repo: ''
-    }
-  </script>
-  <!-- Docsify v4 -->
-  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
-</body>
-</html>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '',
+      repo: ''
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+</body>
+</html>

package/jest.config.js

@@ -1,5 +1,5 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  modulePathIgnorePatterns: ['<rootDir>/lib/'],
-};
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: ['<rootDir>/lib/'],
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.8.1",
+  "version": "2.8.2",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -64,7 +64,7 @@
     ]
   },
   "dependencies": {
-    "@cparra/apex-reflection": "1.10.2",
+    "@cparra/apex-reflection": "1.11.0",
     "chalk": "^4.1.2",
     "fast-xml-parser": "^4.0.1",
     "log-update": "4.0.0",

package/src/service/__tests__/apex-file-reader.spec.ts

@@ -6,12 +6,12 @@ describe('File Reader', () => {
     Settings.build({
       sourceDirectory: '',
       recursive: true,
-      configPath: '',
-      targetGenerator: 'jekyll',
-      group: true,
-      outputDir: '',
       scope: [],
+      outputDir: '',
+      targetGenerator: 'jekyll',
       indexOnly: false,
+      defaultGroupName: 'Misc',
+      sanitizeHtml: true,
     } as SettingsConfig);
   });
 

package/src/service/__tests__/manifest-factory.spec.ts

@@ -1,6 +1,7 @@
 import { createManifest } from '../manifest-factory';
 import { Type } from '@cparra/apex-reflection';
 import { TypeParser } from '../parser';
+import ApexBundle from '../../model/apex-bundle';
 
 class TestParser implements TypeParser {
   parse(): Type[] {
@@ -9,7 +10,7 @@ class TestParser implements TypeParser {
 }
 
 it('creates a manifest from the result of a type parser', () => {
-  const manifest = createManifest(new TestParser(), (typeBody: string) => {
+  const manifest = createManifest(new TestParser(), (bundle: ApexBundle) => {
     return {};
   });
   expect(manifest.types.length).toBe(0);