@cparra/apexdocs 2.25.0-alpha.1 → 2.25.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/examples/plain-markdown/docs/Miscellaneous/ns.MultiInheritanceClass.md +73 -0
- package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +1 -1
- package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +1 -1
- package/examples/plain-markdown/docs/index.md +11 -14
- package/examples/plain-markdown/force-app/classes/MultiInheritanceClass.cls +1 -0
- package/lib/adapters/apex-types.d.ts +2 -4
- package/lib/adapters/apex-types.js +16 -19
- package/lib/adapters/apex-types.js.map +1 -1
- package/lib/adapters/fields-and-properties.js +1 -2
- package/lib/adapters/fields-and-properties.js.map +1 -1
- package/lib/adapters/methods-and-constructors.js +9 -10
- package/lib/adapters/methods-and-constructors.js.map +1 -1
- package/lib/application/Apexdocs.js +21 -15
- package/lib/application/Apexdocs.js.map +1 -1
- package/lib/application/flows/generate-markdown-files.d.ts +3 -0
- package/lib/application/flows/generate-markdown-files.js +57 -0
- package/lib/application/flows/generate-markdown-files.js.map +1 -0
- package/lib/core/__test__/inheritance-chain.test.d.ts +1 -0
- package/lib/core/__test__/inheritance-chain.test.js +42 -0
- package/lib/core/__test__/inheritance-chain.test.js.map +1 -0
- package/lib/core/generate-docs.d.ts +1 -0
- package/lib/core/generate-docs.js +37 -11
- package/lib/core/generate-docs.js.map +1 -1
- package/lib/core/inheritance-chain.d.ts +2 -0
- package/lib/core/inheritance-chain.js +35 -0
- package/lib/core/inheritance-chain.js.map +1 -0
- package/lib/model/inheritance.d.ts +4 -1
- package/lib/model/markdown-file.d.ts +1 -1
- package/lib/model/markdown-file.js +1 -1
- package/lib/model/markdown-file.js.map +1 -1
- package/lib/test-helpers/ClassMirrorBuilder.d.ts +4 -0
- package/lib/test-helpers/ClassMirrorBuilder.js +11 -1
- package/lib/test-helpers/ClassMirrorBuilder.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/class-template.js +3 -3
- package/lib/util/logger.js +1 -1
- package/lib/util/logger.js.map +1 -1
- package/package.json +3 -3
- package/src/adapters/apex-types.ts +48 -41
- package/src/adapters/fields-and-properties.ts +2 -2
- package/src/adapters/methods-and-constructors.ts +16 -12
- package/src/application/Apexdocs.ts +21 -15
- package/src/application/flows/generate-markdown-files.ts +47 -0
- package/src/core/__test__/inheritance-chain.test.ts +54 -0
- package/src/core/generate-docs.ts +52 -13
- package/src/core/inheritance-chain.ts +23 -0
- package/src/core/renderable/types.d.ts +1 -1
- package/src/model/inheritance.ts +2 -1
- package/src/model/markdown-file.ts +1 -1
- package/src/test-helpers/ClassMirrorBuilder.ts +14 -1
- package/src/transpiler/markdown/plain-markdown/class-template.ts +3 -3
- package/src/util/logger.ts +1 -1
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# MultiInheritanceClass Class
|
|
2
|
+
|
|
3
|
+
## Namespace
|
|
4
|
+
ns
|
|
5
|
+
|
|
6
|
+
**Inheritance**
|
|
7
|
+
[ns.SampleClass](../SampleGroup/ns.SampleClass.md) < [ns.BaseClass](./ns.BaseClass.md)
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
### `sampleEnumFromBase`
|
|
11
|
+
|
|
12
|
+
*Inherited*
|
|
13
|
+
|
|
14
|
+
#### Signature
|
|
15
|
+
```apex
|
|
16
|
+
public sampleEnumFromBase
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
#### Type
|
|
20
|
+
[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
|
|
21
|
+
|
|
22
|
+
## Properties
|
|
23
|
+
### Group Name
|
|
24
|
+
#### `someProperty`
|
|
25
|
+
|
|
26
|
+
*Inherited*
|
|
27
|
+
|
|
28
|
+
##### Signature
|
|
29
|
+
```apex
|
|
30
|
+
public someProperty
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
##### Type
|
|
34
|
+
String
|
|
35
|
+
|
|
36
|
+
## Methods
|
|
37
|
+
### Available Methods
|
|
38
|
+
#### `doSomething()`
|
|
39
|
+
|
|
40
|
+
*Inherited*
|
|
41
|
+
|
|
42
|
+
##### Signature
|
|
43
|
+
```apex
|
|
44
|
+
public void doSomething()
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
##### Return Type
|
|
48
|
+
**void**
|
|
49
|
+
|
|
50
|
+
### Deprecated Methods
|
|
51
|
+
#### `sayHello()`
|
|
52
|
+
|
|
53
|
+
*Inherited*
|
|
54
|
+
|
|
55
|
+
`DEPRECATED`
|
|
56
|
+
|
|
57
|
+
This is a sample method.
|
|
58
|
+
|
|
59
|
+
##### Signature
|
|
60
|
+
```apex
|
|
61
|
+
public virtual String sayHello()
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
##### Return Type
|
|
65
|
+
**String**
|
|
66
|
+
|
|
67
|
+
A string value.
|
|
68
|
+
|
|
69
|
+
##### Example
|
|
70
|
+
```apex
|
|
71
|
+
SampleClass sample = new SampleClass();
|
|
72
|
+
sample.doSomething();
|
|
73
|
+
```
|
|
@@ -1,36 +1,33 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Apex Reference Guide
|
|
2
|
+
|
|
2
3
|
## Miscellaneous
|
|
3
4
|
|
|
4
5
|
### [ns.BaseClass](./Miscellaneous/ns.BaseClass.md)
|
|
5
6
|
|
|
7
|
+
### [ns.MultiInheritanceClass](./Miscellaneous/ns.MultiInheritanceClass.md)
|
|
6
8
|
|
|
7
9
|
### [ns.ParentInterface](./Miscellaneous/ns.ParentInterface.md)
|
|
8
10
|
|
|
9
|
-
|
|
10
11
|
### [ns.ReferencedEnum](./Miscellaneous/ns.ReferencedEnum.md)
|
|
11
12
|
|
|
12
|
-
|
|
13
13
|
### [ns.SampleException](./Miscellaneous/ns.SampleException.md)
|
|
14
14
|
|
|
15
|
-
|
|
16
15
|
### [ns.SampleInterface](./Miscellaneous/ns.SampleInterface.md)
|
|
17
16
|
|
|
18
17
|
This is a sample interface
|
|
19
18
|
|
|
20
|
-
|
|
21
|
-
## SampleGroup
|
|
22
|
-
|
|
23
|
-
### [ns.SampleClass](./SampleGroup/ns.SampleClass.md)
|
|
24
|
-
|
|
25
|
-
aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex
|
|
26
|
-
deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
|
|
27
|
-
|
|
28
|
-
|
|
29
19
|
## Sample Enums
|
|
30
20
|
|
|
31
21
|
### [ns.SampleEnum](./Sample-Enums/ns.SampleEnum.md)
|
|
32
22
|
|
|
33
|
-
This is a sample enum. This references
|
|
23
|
+
This is a sample enum. This references [ns.ReferencedEnum](./Miscellaneous/ns.ReferencedEnum.md) .
|
|
24
|
+
|
|
34
25
|
This description has several lines
|
|
35
26
|
|
|
27
|
+
## SampleGroup
|
|
28
|
+
|
|
29
|
+
### [ns.SampleClass](./SampleGroup/ns.SampleClass.md)
|
|
30
|
+
|
|
31
|
+
aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex
|
|
36
32
|
|
|
33
|
+
deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
public class MultiInheritanceClass extends SampleClass {}
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { InterfaceMirror, Type } from '@cparra/apex-reflection';
|
|
2
|
+
import { RenderableInterface, Renderable } from '../core/renderable/types';
|
|
3
3
|
import { GetRenderableContentByTypeName } from './references';
|
|
4
4
|
export declare function typeToRenderableType(type: Type, linkGenerator: GetRenderableContentByTypeName, namespace?: string): Renderable;
|
|
5
|
-
export declare function enumTypeToEnumSource(enumType: EnumMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel?: number): RenderableEnum;
|
|
6
5
|
export declare function interfaceTypeToInterfaceSource(interfaceType: InterfaceMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel?: number): RenderableInterface;
|
|
7
|
-
export declare function classTypeToClassSource(classType: ClassMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel?: number): RenderableClass;
|
|
@@ -1,13 +1,23 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.typeToRenderableType = typeToRenderableType;
|
|
4
|
-
exports.enumTypeToEnumSource = enumTypeToEnumSource;
|
|
5
4
|
exports.interfaceTypeToInterfaceSource = interfaceTypeToInterfaceSource;
|
|
6
|
-
exports.classTypeToClassSource = classTypeToClassSource;
|
|
7
5
|
const documentables_1 = require("./documentables");
|
|
8
|
-
const references_1 = require("./references");
|
|
9
6
|
const methods_and_constructors_1 = require("./methods-and-constructors");
|
|
10
7
|
const fields_and_properties_1 = require("./fields-and-properties");
|
|
8
|
+
function typeToRenderableType(type, linkGenerator, namespace) {
|
|
9
|
+
function getRenderable() {
|
|
10
|
+
switch (type.type_name) {
|
|
11
|
+
case 'enum':
|
|
12
|
+
return enumTypeToEnumSource(type, linkGenerator);
|
|
13
|
+
case 'interface':
|
|
14
|
+
return interfaceTypeToInterfaceSource(type, linkGenerator);
|
|
15
|
+
case 'class':
|
|
16
|
+
return classTypeToClassSource(type, linkGenerator);
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
return Object.assign(Object.assign({}, getRenderable()), { namespace });
|
|
20
|
+
}
|
|
11
21
|
function baseTypeAdapter(type, linkGenerator, baseHeadingLevel) {
|
|
12
22
|
function getHeading(type) {
|
|
13
23
|
const suffixMap = {
|
|
@@ -27,19 +37,6 @@ function baseTypeAdapter(type, linkGenerator, baseHeadingLevel) {
|
|
|
27
37
|
},
|
|
28
38
|
};
|
|
29
39
|
}
|
|
30
|
-
function typeToRenderableType(type, linkGenerator, namespace) {
|
|
31
|
-
function getRenderable() {
|
|
32
|
-
switch (type.type_name) {
|
|
33
|
-
case 'enum':
|
|
34
|
-
return enumTypeToEnumSource(type, linkGenerator);
|
|
35
|
-
case 'interface':
|
|
36
|
-
return interfaceTypeToInterfaceSource(type, linkGenerator);
|
|
37
|
-
case 'class':
|
|
38
|
-
return classTypeToClassSource(type, linkGenerator);
|
|
39
|
-
}
|
|
40
|
-
}
|
|
41
|
-
return Object.assign(Object.assign({}, getRenderable()), { namespace });
|
|
42
|
-
}
|
|
43
40
|
function enumTypeToEnumSource(enumType, linkGenerator, baseHeadingLevel = 1) {
|
|
44
41
|
return Object.assign(Object.assign({ type: 'enum' }, baseTypeAdapter(enumType, linkGenerator, baseHeadingLevel)), { values: {
|
|
45
42
|
headingLevel: baseHeadingLevel + 1,
|
|
@@ -51,17 +48,17 @@ function enumTypeToEnumSource(enumType, linkGenerator, baseHeadingLevel = 1) {
|
|
|
51
48
|
} });
|
|
52
49
|
}
|
|
53
50
|
function interfaceTypeToInterfaceSource(interfaceType, linkGenerator, baseHeadingLevel = 1) {
|
|
54
|
-
return Object.assign(Object.assign({ type: 'interface' }, baseTypeAdapter(interfaceType, linkGenerator, baseHeadingLevel)), { extends: interfaceType.extended_interfaces.map(
|
|
51
|
+
return Object.assign(Object.assign({ type: 'interface' }, baseTypeAdapter(interfaceType, linkGenerator, baseHeadingLevel)), { extends: interfaceType.extended_interfaces.map(linkGenerator), methods: {
|
|
55
52
|
headingLevel: baseHeadingLevel + 1,
|
|
56
53
|
heading: 'Methods',
|
|
57
54
|
value: interfaceType.methods.map((method) => (0, methods_and_constructors_1.adaptMethod)(method, linkGenerator, baseHeadingLevel + 2)),
|
|
58
55
|
} });
|
|
59
56
|
}
|
|
60
57
|
function classTypeToClassSource(classType, linkGenerator, baseHeadingLevel = 1) {
|
|
61
|
-
return Object.assign(Object.assign({ type: 'class' }, baseTypeAdapter(classType, linkGenerator, baseHeadingLevel)), { classModifier: classType.classModifier, sharingModifier: classType.sharingModifier, implements: classType.implemented_interfaces.map(
|
|
58
|
+
return Object.assign(Object.assign({ type: 'class' }, baseTypeAdapter(classType, linkGenerator, baseHeadingLevel)), { classModifier: classType.classModifier, sharingModifier: classType.sharingModifier, implements: classType.implemented_interfaces.map(linkGenerator), extends: classType.inheritanceChain.map(linkGenerator), methods: adaptMembers('Methods', classType.methods, methods_and_constructors_1.adaptMethod, linkGenerator, baseHeadingLevel + 1), constructors: adaptMembers('Constructors', classType.constructors, (constructor, linkGenerator, baseHeadingLevel) => (0, methods_and_constructors_1.adaptConstructor)(classType.name, constructor, linkGenerator, baseHeadingLevel), linkGenerator, baseHeadingLevel + 1), fields: adaptMembers('Fields', classType.fields, fields_and_properties_1.adaptFieldOrProperty, linkGenerator, baseHeadingLevel + 1), properties: adaptMembers('Properties', classType.properties, fields_and_properties_1.adaptFieldOrProperty, linkGenerator, baseHeadingLevel + 1), innerClasses: {
|
|
62
59
|
headingLevel: baseHeadingLevel + 1,
|
|
63
60
|
heading: 'Classes',
|
|
64
|
-
value: classType.classes.map((innerClass) => classTypeToClassSource(innerClass, linkGenerator, baseHeadingLevel + 2)),
|
|
61
|
+
value: classType.classes.map((innerClass) => classTypeToClassSource(Object.assign(Object.assign({}, innerClass), { inheritanceChain: [] }), linkGenerator, baseHeadingLevel + 2)),
|
|
65
62
|
}, innerEnums: {
|
|
66
63
|
headingLevel: baseHeadingLevel + 1,
|
|
67
64
|
heading: 'Enums',
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"apex-types.js","sourceRoot":"","sources":["../../src/adapters/apex-types.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"apex-types.js","sourceRoot":"","sources":["../../src/adapters/apex-types.ts"],"names":[],"mappings":";;AAoBA,oDAoBC;AA+CD,wEAeC;AA5FD,mDAAsE;AAOtE,yEAA2E;AAC3E,mEAA+D;AAE/D,SAAgB,oBAAoB,CAClC,IAAU,EACV,aAA6C,EAC7C,SAAkB;IAElB,SAAS,aAAa;QACpB,QAAQ,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,KAAK,MAAM;gBACT,OAAO,oBAAoB,CAAC,IAAkB,EAAE,aAAa,CAAC,CAAC;YACjE,KAAK,WAAW;gBACd,OAAO,8BAA8B,CAAC,IAAuB,EAAE,aAAa,CAAC,CAAC;YAChF,KAAK,OAAO;gBACV,OAAO,sBAAsB,CAAC,IAAuC,EAAE,aAAa,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAED,uCACK,aAAa,EAAE,KAClB,SAAS,IACT;AACJ,CAAC;AAED,SAAS,eAAe,CACtB,IAAgD,EAChD,aAA6C,EAC7C,gBAAwB;IAExB,SAAS,UAAU,CAAC,IAAU;QAC5B,MAAM,SAAS,GAAG;YAChB,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,WAAW;YACtB,IAAI,EAAE,MAAM;SACb,CAAC;QAEF,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC;QACzB,GAAG,EAAE,IAAA,iCAAiB,EAAC,IAAI,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACjE,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE;YACJ,cAAc,EAAE,IAAI,CAAC,eAAe;SACrC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAAoB,EACpB,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,MAAM,IACT,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAC7D,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;gBAAC,OAAA,iCACjC,IAAA,gCAAgB,EAAC,MAAA,KAAK,CAAC,UAAU,0CAAE,gBAAgB,EAAE,aAAa,CAAC,KACtE,KAAK,EAAE,KAAK,CAAC,IAAI,IACjB,CAAA;aAAA,CAAC;SACJ,IACD;AACJ,CAAC;AAED,SAAgB,8BAA8B,CAC5C,aAA8B,EAC9B,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,WAAW,IACd,eAAe,CAAC,aAAa,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAClE,OAAO,EAAE,aAAa,CAAC,mBAAmB,CAAC,GAAG,CAAC,aAAa,CAAC,EAC7D,OAAO,EAAE;YACP,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,sCAAW,EAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CAAC;SACvG,IACD;AACJ,CAAC;AAED,SAAS,sBAAsB,CAC7B,SAA0C,EAC1C,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,OAAO,IACV,eAAe,CAAC,SAAS,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAC9D,aAAa,EAAE,SAAS,CAAC,aAAa,EACtC,eAAe,EAAE,SAAS,CAAC,eAAe,EAC1C,UAAU,EAAE,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,EAC/D,OAAO,EAAE,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAC,EACtD,OAAO,EAAE,YAAY,CAAC,SAAS,EAAE,SAAS,CAAC,OAAO,EAAE,sCAAW,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,EACrG,YAAY,EAAE,YAAY,CACxB,cAAc,EACd,SAAS,CAAC,YAAY,EACtB,CAAC,WAAW,EAAE,aAAa,EAAE,gBAAgB,EAAE,EAAE,CAC/C,IAAA,2CAAgB,EAAC,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,gBAAgB,CAAC,EAChF,aAAa,EACb,gBAAgB,GAAG,CAAC,CACrB,EACD,MAAM,EAAE,YAAY,CAClB,QAAQ,EACR,SAAS,CAAC,MAAsC,EAChD,4CAAoB,EACpB,aAAa,EACb,gBAAgB,GAAG,CAAC,CACrB,EACD,UAAU,EAAE,YAAY,CACtB,YAAY,EACZ,SAAS,CAAC,UAA6C,EACvD,4CAAoB,EACpB,aAAa,EACb,gBAAgB,GAAG,CAAC,CACrB,EACD,YAAY,EAAE;YACZ,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAC1C,sBAAsB,iCAAM,UAAU,KAAE,gBAAgB,EAAE,EAAE,KAAI,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CACrG;SACF,EACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,oBAAoB,CAAC,SAAS,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CAAC;SAChH,EACD,eAAe,EAAE;YACf,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CACjD,8BAA8B,CAAC,cAAc,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CACpF;SACF,IACD;AACJ,CAAC;AAID,SAAS,YAAY,CACnB,OAAe,EACf,OAAY,EACZ,OAAkG,EAClG,yBAAyD,EACzD,YAAoB;IAEpB,OAAO;QACL,YAAY;QACZ,OAAO;QACP,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC;QAC5B,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;YACtB,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,YAAY,GAAG,CAAC,CAAC;YACjF,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,YAAY,GAAG,CAAC,CAAC;KAC1E,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,OAAoB;IACpC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,MAAM,CACb,OAAY,EACZ,OAAkG,EAClG,aAA6C,EAC7C,gBAAwB;IAExB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,gBAAgB,CACvB,OAAY,EACZ,OAAkG,EAClG,aAA6C,EAC7C,gBAAwB;IAExB,MAAM,cAAc,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,EAAE,CACjE,WAAW,CAAC,gBAAgB,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,CAAC,CAC1E,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAsB,OAAY;IACzD,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;;QACd,MAAM,SAAS,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,OAAO,CAAC;QAC1C,GAAG,CAAC,SAAS,CAAC,GAAG,MAAA,GAAG,CAAC,SAAS,CAAC,mCAAI,EAAE,CAAC;QACtC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAyB,CAC1B,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAClB,YAAoB,EACpB,SAAiB,EACjB,OAAkG,EAClG,OAAY,EACZ,aAA6C;IAE7C,OAAO;QACL,YAAY,EAAE,YAAY;QAC1B,OAAO,EAAE,SAAS;QAClB,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,gBAAgB,EAAE,oDAAoD;QACnG,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,YAAY,GAAG,CAAC,CAAC;KACjE,CAAC;AACJ,CAAC"}
|
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.adaptFieldOrProperty = adaptFieldOrProperty;
|
|
4
4
|
const documentables_1 = require("./documentables");
|
|
5
|
-
const references_1 = require("./references");
|
|
6
5
|
function adaptFieldOrProperty(field, linkGenerator, baseHeadingLevel) {
|
|
7
6
|
function buildSignature() {
|
|
8
7
|
const { access_modifier, name } = field;
|
|
@@ -18,7 +17,7 @@ function adaptFieldOrProperty(field, linkGenerator, baseHeadingLevel) {
|
|
|
18
17
|
type: {
|
|
19
18
|
headingLevel: baseHeadingLevel + 1,
|
|
20
19
|
heading: 'Type',
|
|
21
|
-
value: (
|
|
20
|
+
value: linkGenerator(field.typeReference.rawDeclaration),
|
|
22
21
|
},
|
|
23
22
|
inherited: field.inherited,
|
|
24
23
|
accessModifier: field.access_modifier,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fields-and-properties.js","sourceRoot":"","sources":["../../src/adapters/fields-and-properties.ts"],"names":[],"mappings":";;AAKA,oDAgCC;AAnCD,mDAAoD;
|
|
1
|
+
{"version":3,"file":"fields-and-properties.js","sourceRoot":"","sources":["../../src/adapters/fields-and-properties.ts"],"names":[],"mappings":";;AAKA,oDAgCC;AAnCD,mDAAoD;AAGpD,SAAgB,oBAAoB,CAClC,KAAiE,EACjE,aAA6C,EAC7C,gBAAwB;IAExB,SAAS,cAAc;QACrB,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QACxC,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxD,OAAO,CACL,GAAG,eAAe,IAAI,eAAe,IAAI,IAAI,EAAE;YAC7C,uBAAuB;aACtB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CACzB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,GAAG,EAAE,IAAA,iCAAiB,EAAC,KAAK,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QAClE,OAAO,EAAE,KAAK,CAAC,IAAI;QACnB,IAAI,EAAE;YACJ,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC;SACzD;QACD,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,cAAc,EAAE,KAAK,CAAC,eAAe;QACrC,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC,cAAc,EAAE,CAAC;SAC1B;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.adaptMethod = adaptMethod;
|
|
4
4
|
exports.adaptConstructor = adaptConstructor;
|
|
5
5
|
const documentables_1 = require("./documentables");
|
|
6
|
-
const references_1 = require("./references");
|
|
7
6
|
function adaptMethod(method, linkGenerator, baseHeadingLevel) {
|
|
8
7
|
var _a, _b, _c;
|
|
9
8
|
function buildTitle(method) {
|
|
@@ -31,17 +30,17 @@ function adaptMethod(method, linkGenerator, baseHeadingLevel) {
|
|
|
31
30
|
returnType: {
|
|
32
31
|
headingLevel: baseHeadingLevel + 1,
|
|
33
32
|
heading: 'Return Type',
|
|
34
|
-
value: Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)((_b = (_a = method.docComment) === null || _a === void 0 ? void 0 : _a.returnAnnotation) === null || _b === void 0 ? void 0 : _b.bodyLines, linkGenerator)), { type: (
|
|
33
|
+
value: Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)((_b = (_a = method.docComment) === null || _a === void 0 ? void 0 : _a.returnAnnotation) === null || _b === void 0 ? void 0 : _b.bodyLines, linkGenerator)), { type: linkGenerator(method.typeReference.rawDeclaration) }),
|
|
35
34
|
},
|
|
36
35
|
throws: {
|
|
37
36
|
headingLevel: baseHeadingLevel + 1,
|
|
38
37
|
heading: 'Throws',
|
|
39
|
-
value: (_c = method.docComment) === null || _c === void 0 ? void 0 : _c.throwsAnnotations.map((thrown) => mapThrows(thrown)),
|
|
38
|
+
value: (_c = method.docComment) === null || _c === void 0 ? void 0 : _c.throwsAnnotations.map((thrown) => mapThrows(thrown, linkGenerator)),
|
|
40
39
|
},
|
|
41
40
|
parameters: {
|
|
42
41
|
headingLevel: baseHeadingLevel + 1,
|
|
43
42
|
heading: 'Parameters',
|
|
44
|
-
value: method.parameters.map((param) => mapParameters(method, param)),
|
|
43
|
+
value: method.parameters.map((param) => mapParameters(method, param, linkGenerator)),
|
|
45
44
|
},
|
|
46
45
|
inherited: method.inherited,
|
|
47
46
|
};
|
|
@@ -72,21 +71,21 @@ function adaptConstructor(typeName, constructor, linkGenerator, baseHeadingLevel
|
|
|
72
71
|
parameters: {
|
|
73
72
|
headingLevel: baseHeadingLevel + 1,
|
|
74
73
|
heading: 'Parameters',
|
|
75
|
-
value: constructor.parameters.map((param) => mapParameters(constructor, param)),
|
|
74
|
+
value: constructor.parameters.map((param) => mapParameters(constructor, param, linkGenerator)),
|
|
76
75
|
},
|
|
77
76
|
throws: {
|
|
78
77
|
headingLevel: baseHeadingLevel + 1,
|
|
79
78
|
heading: 'Throws',
|
|
80
|
-
value: (_a = constructor.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.map((thrown) => mapThrows(thrown)),
|
|
79
|
+
value: (_a = constructor.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.map((thrown) => mapThrows(thrown, linkGenerator)),
|
|
81
80
|
},
|
|
82
81
|
};
|
|
83
82
|
}
|
|
84
|
-
function mapParameters(documentable, param) {
|
|
83
|
+
function mapParameters(documentable, param, linkGenerator) {
|
|
85
84
|
var _a;
|
|
86
85
|
const paramAnnotation = (_a = documentable.docComment) === null || _a === void 0 ? void 0 : _a.paramAnnotations.find((pa) => pa.paramName.toLowerCase() === param.name.toLowerCase());
|
|
87
|
-
return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(paramAnnotation === null || paramAnnotation === void 0 ? void 0 : paramAnnotation.bodyLines,
|
|
86
|
+
return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(paramAnnotation === null || paramAnnotation === void 0 ? void 0 : paramAnnotation.bodyLines, linkGenerator)), { name: param.name, type: linkGenerator(param.typeReference.rawDeclaration) });
|
|
88
87
|
}
|
|
89
|
-
function mapThrows(thrown) {
|
|
90
|
-
return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(thrown.bodyLines,
|
|
88
|
+
function mapThrows(thrown, linkGenerator) {
|
|
89
|
+
return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(thrown.bodyLines, linkGenerator)), { type: linkGenerator(thrown.exceptionName) });
|
|
91
90
|
}
|
|
92
91
|
//# sourceMappingURL=methods-and-constructors.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"methods-and-constructors.js","sourceRoot":"","sources":["../../src/adapters/methods-and-constructors.ts"],"names":[],"mappings":";;AAOA,kCAiDC;AAED,4CAwCC;AA/FD,mDAAsE;
|
|
1
|
+
{"version":3,"file":"methods-and-constructors.js","sourceRoot":"","sources":["../../src/adapters/methods-and-constructors.ts"],"names":[],"mappings":";;AAOA,kCAiDC;AAED,4CAwCC;AA/FD,mDAAsE;AAItE,SAAgB,WAAW,CACzB,MAAoB,EACpB,aAA6C,EAC7C,gBAAwB;;IAExB,SAAS,UAAU,CAAC,MAAmC;QACrD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACpC,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,IAAI,IAAI,gBAAgB,GAAG,CAAC;IACxC,CAAC;IAED,SAAS,cAAc,CAAC,MAAmC;QACzD,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACzE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU;aACjC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACrE,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAClF,OAAO,GAAG,eAAe,IAAI,OAAO,GAAG,aAAa,CAAC,cAAc,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;IAC/F,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,GAAG,EAAE,IAAA,iCAAiB,EAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACnE,OAAO,EAAE,UAAU,CAAC,MAAqC,CAAC;QAC1D,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC,cAAc,CAAC,MAAqC,CAAC,CAAC;SAC/D;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,aAAa;YACtB,KAAK,kCACA,IAAA,gCAAgB,EAAC,MAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,gBAAgB,0CAAE,SAAS,EAAE,aAAa,CAAC,KAClF,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,GACzD;SACF;QACD,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;SAC9F;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;SACrF;QACD,SAAS,EAAG,MAAsC,CAAC,SAAS;KAC7D,CAAC;AACJ,CAAC;AAED,SAAgB,gBAAgB,CAC9B,QAAgB,EAChB,WAA8B,EAC9B,aAA6C,EAC7C,gBAAwB;;IAExB,SAAS,UAAU,CAAC,IAAY,EAAE,WAA8B;QAC9D,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;QACnC,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,IAAI,IAAI,gBAAgB,GAAG,CAAC;IACxC,CAAC;IAED,SAAS,cAAc,CAAC,IAAY,EAAE,WAA8B;QAClE,MAAM,EAAE,eAAe,EAAE,GAAG,WAAW,CAAC;QACxC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU;aACtC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACrE,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,GAAG,eAAe,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;IACrD,CAAC;IAED,OAAO;QACL,GAAG,EAAE,IAAA,iCAAiB,EAAC,WAAW,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACxE,YAAY,EAAE,gBAAgB;QAC9B,OAAO,EAAE,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC;QAC1C,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;SAC/C;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;SAC/F;QACD,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,MAAA,WAAW,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;SACnG;KACF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CACpB,YAA0B,EAC1B,KAAsB,EACtB,aAA6C;;IAE7C,MAAM,eAAe,GAAG,MAAA,YAAY,CAAC,UAAU,0CAAE,gBAAgB,CAAC,IAAI,CACpE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAChE,CAAC;IACF,uCACK,IAAA,gCAAgB,EAAC,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,SAAS,EAAE,aAAa,CAAC,KAC9D,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,IACvD;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,MAAwB,EAAE,aAA6C;IACxF,uCACK,IAAA,gCAAgB,EAAC,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC,KACpD,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,IACzC;AACJ,CAAC"}
|
|
@@ -16,6 +16,7 @@ const file_writer_1 = require("../service/file-writer");
|
|
|
16
16
|
const error_logger_1 = __importDefault(require("../util/error-logger"));
|
|
17
17
|
const types_repository_1 = require("../model/types-repository");
|
|
18
18
|
const factory_1 = require("../transpiler/factory");
|
|
19
|
+
const generate_markdown_files_1 = require("./flows/generate-markdown-files");
|
|
19
20
|
/**
|
|
20
21
|
* Application entry-point to generate documentation out of Apex source files.
|
|
21
22
|
*/
|
|
@@ -26,21 +27,26 @@ class Apexdocs {
|
|
|
26
27
|
static generate() {
|
|
27
28
|
logger_1.Logger.log('Initializing...');
|
|
28
29
|
const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
30
|
+
if (settings_1.Settings.getInstance().targetGenerator === 'plain-markdown') {
|
|
31
|
+
(0, generate_markdown_files_1.generateMarkdownFiles)(fileBodies);
|
|
32
|
+
}
|
|
33
|
+
else {
|
|
34
|
+
const manifest = (0, manifest_factory_1.createManifest)(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
|
|
35
|
+
types_repository_1.TypesRepository.getInstance().populateAll(manifest.types);
|
|
36
|
+
const filteredTypes = this.filterByScopes(manifest);
|
|
37
|
+
types_repository_1.TypesRepository.getInstance().populateScoped(filteredTypes);
|
|
38
|
+
const processor = factory_1.TypeTranspilerFactory.get(settings_1.Settings.getInstance().targetGenerator);
|
|
39
|
+
transpiler_1.default.generate(filteredTypes, processor);
|
|
40
|
+
const generatedFiles = processor.fileBuilder().files();
|
|
41
|
+
const files = [];
|
|
42
|
+
file_writer_1.FileWriter.write(generatedFiles, (file) => {
|
|
43
|
+
logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
|
|
44
|
+
files.push(file);
|
|
45
|
+
});
|
|
46
|
+
settings_1.Settings.getInstance().onAfterProcess(files);
|
|
47
|
+
// Error logging
|
|
48
|
+
error_logger_1.default.logErrors(filteredTypes);
|
|
49
|
+
}
|
|
44
50
|
}
|
|
45
51
|
static filterByScopes(manifest) {
|
|
46
52
|
let filteredTypes;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;;;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,0EAAkD;AAClD,wDAAoD;AACpD,wEAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;
|
|
1
|
+
{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;;;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,0EAAkD;AAClD,wDAAoD;AACpD,wEAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAC9D,6EAAwE;AAExE;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QAExE,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,KAAK,gBAAgB,EAAE,CAAC;YAChE,IAAA,+CAAqB,EAAC,UAAU,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;YAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;YACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;YAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;YAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;gBACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;gBACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;YAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAE7C,gBAAgB;YAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAChE,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;QACL,CAAC;aAAM,CAAC;YACN,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;QAC/D,CAAC;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AA5DH,4BAqEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
25
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
+
exports.generateMarkdownFiles = void 0;
|
|
27
|
+
const settings_1 = require("../../settings");
|
|
28
|
+
const generate_docs_1 = require("../../core/generate-docs");
|
|
29
|
+
const markdown_file_1 = require("../../model/markdown-file");
|
|
30
|
+
const file_writer_1 = require("../../service/file-writer");
|
|
31
|
+
const logger_1 = require("../../util/logger");
|
|
32
|
+
const function_1 = require("fp-ts/function");
|
|
33
|
+
const E = __importStar(require("fp-ts/Either"));
|
|
34
|
+
exports.generateMarkdownFiles = (0, function_1.flow)(generateDocumentationBundle, E.map(convertToMarkdownFiles), E.map(writeFilesToSystem), E.mapLeft((errors) => {
|
|
35
|
+
logger_1.Logger.error(errors.join('\n'));
|
|
36
|
+
}));
|
|
37
|
+
function generateDocumentationBundle(bundles) {
|
|
38
|
+
return (0, generate_docs_1.generateDocs)(bundles.map((file) => file.rawTypeContent), {
|
|
39
|
+
scope: settings_1.Settings.getInstance().scope,
|
|
40
|
+
outputDir: settings_1.Settings.getInstance().outputDir,
|
|
41
|
+
namespace: settings_1.Settings.getInstance().getNamespace(),
|
|
42
|
+
sortMembersAlphabetically: settings_1.Settings.getInstance().sortMembersAlphabetically(),
|
|
43
|
+
defaultGroupName: settings_1.Settings.getInstance().getDefaultGroupName(),
|
|
44
|
+
});
|
|
45
|
+
}
|
|
46
|
+
function convertToMarkdownFiles(docBundle) {
|
|
47
|
+
return [
|
|
48
|
+
new markdown_file_1.MarkdownFile('index', '').addText(docBundle.referenceGuide),
|
|
49
|
+
...docBundle.docs.map((doc) => new markdown_file_1.MarkdownFile(`${settings_1.Settings.getInstance().getNamespacePrefix()}${doc.typeName}`, doc.directory).addText(doc.docContents)),
|
|
50
|
+
];
|
|
51
|
+
}
|
|
52
|
+
function writeFilesToSystem(files) {
|
|
53
|
+
file_writer_1.FileWriter.write(files, (file) => {
|
|
54
|
+
logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
//# sourceMappingURL=generate-markdown-files.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate-markdown-files.js","sourceRoot":"","sources":["../../../src/application/flows/generate-markdown-files.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAAsD;AACtD,4DAA6E;AAC7E,6DAAyD;AACzD,2DAAuD;AACvD,8CAA2C;AAC3C,6CAAsC;AACtC,gDAAkC;AAErB,QAAA,qBAAqB,GAAG,IAAA,eAAI,EACvC,2BAA2B,EAC3B,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,EAC7B,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,EACzB,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;IACnB,eAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAClC,CAAC,CAAC,CACH,CAAC;AAEF,SAAS,2BAA2B,CAAC,OAAqB;IACxD,OAAO,IAAA,4BAAY,EACjB,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,EAC1C;QACE,KAAK,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK;QACnC,SAAS,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS;QAC3C,SAAS,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,EAAE;QAChD,yBAAyB,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,yBAAyB,EAAE;QAC7E,gBAAgB,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE;KAC/D,CACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAAC,SAA8B;IAC5D,OAAO;QACL,IAAI,4BAAY,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC;QAC/D,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAC5B,IAAI,4BAAY,CAAC,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,GAAG,CAAC,QAAQ,EAAE,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,OAAO,CACtG,GAAG,CAAC,WAAW,CAChB,CACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAqB;IAC/C,wBAAU,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,IAAgB,EAAE,EAAE;QAC3C,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const ClassMirrorBuilder_1 = require("../../test-helpers/ClassMirrorBuilder");
|
|
4
|
+
const inheritance_chain_1 = require("../inheritance-chain");
|
|
5
|
+
describe('inheritance chain for classes', () => {
|
|
6
|
+
test('returns an empty list of the class does not extend any other class', () => {
|
|
7
|
+
const classMirror = new ClassMirrorBuilder_1.ClassMirrorBuilder().build();
|
|
8
|
+
const repository = [classMirror];
|
|
9
|
+
const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, classMirror);
|
|
10
|
+
expect(inheritanceChain).toEqual([]);
|
|
11
|
+
});
|
|
12
|
+
test('returns the name of the extended class if it is not found in the repository', () => {
|
|
13
|
+
const classMirror = new ClassMirrorBuilder_1.ClassMirrorBuilder().withExtendedClass('ExtendedClass').build();
|
|
14
|
+
const repository = [classMirror];
|
|
15
|
+
const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, classMirror);
|
|
16
|
+
expect(inheritanceChain).toEqual(['ExtendedClass']);
|
|
17
|
+
});
|
|
18
|
+
test('returns the extended class when it is present in the repository', () => {
|
|
19
|
+
const classMirror = new ClassMirrorBuilder_1.ClassMirrorBuilder().withExtendedClass('ExtendedClass').build();
|
|
20
|
+
const extendedClass = new ClassMirrorBuilder_1.ClassMirrorBuilder().withName('ExtendedClass').build();
|
|
21
|
+
const repository = [classMirror, extendedClass];
|
|
22
|
+
const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, classMirror);
|
|
23
|
+
expect(inheritanceChain).toEqual(['ExtendedClass']);
|
|
24
|
+
});
|
|
25
|
+
test('returns the full inheritance chain when the extended class is also extended', () => {
|
|
26
|
+
const classMirror = new ClassMirrorBuilder_1.ClassMirrorBuilder().withExtendedClass('ExtendedClass').build();
|
|
27
|
+
const extendedClass = new ClassMirrorBuilder_1.ClassMirrorBuilder().withName('ExtendedClass').withExtendedClass('SuperClass').build();
|
|
28
|
+
const superClass = new ClassMirrorBuilder_1.ClassMirrorBuilder().withName('SuperClass').build();
|
|
29
|
+
const repository = [classMirror, extendedClass, superClass];
|
|
30
|
+
const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, classMirror);
|
|
31
|
+
expect(inheritanceChain).toEqual(['ExtendedClass', 'SuperClass']);
|
|
32
|
+
});
|
|
33
|
+
test('returns the inheritance for a class that extends an inner class', () => {
|
|
34
|
+
const classMirror = new ClassMirrorBuilder_1.ClassMirrorBuilder().withExtendedClass('OuterClass.InnerClass').build();
|
|
35
|
+
const innerClass = new ClassMirrorBuilder_1.ClassMirrorBuilder().withName('InnerClass').build();
|
|
36
|
+
const outerClass = new ClassMirrorBuilder_1.ClassMirrorBuilder().withName('OuterClass').addInnerClass(innerClass).build();
|
|
37
|
+
const repository = [classMirror, outerClass];
|
|
38
|
+
const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, classMirror);
|
|
39
|
+
expect(inheritanceChain).toEqual(['OuterClass.InnerClass']);
|
|
40
|
+
});
|
|
41
|
+
});
|
|
42
|
+
//# sourceMappingURL=inheritance-chain.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"inheritance-chain.test.js","sourceRoot":"","sources":["../../../src/core/__test__/inheritance-chain.test.ts"],"names":[],"mappings":";;AAAA,8EAA2E;AAC3E,4DAA8D;AAE9D,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,IAAI,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC9E,MAAM,WAAW,GAAG,IAAI,uCAAkB,EAAE,CAAC,KAAK,EAAE,CAAC;QACrD,MAAM,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;QAEjC,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAEzE,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACvF,MAAM,WAAW,GAAG,IAAI,uCAAkB,EAAE,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC;QACxF,MAAM,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;QAEjC,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAEzE,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;QAC3E,MAAM,WAAW,GAAG,IAAI,uCAAkB,EAAE,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC;QACxF,MAAM,aAAa,GAAG,IAAI,uCAAkB,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC;QACjF,MAAM,UAAU,GAAG,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QAEhD,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAEzE,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACvF,MAAM,WAAW,GAAG,IAAI,uCAAkB,EAAE,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC;QACxF,MAAM,aAAa,GAAG,IAAI,uCAAkB,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;QACjH,MAAM,UAAU,GAAG,IAAI,uCAAkB,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;QAC3E,MAAM,UAAU,GAAG,CAAC,WAAW,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC;QAE5D,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAEzE,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;QAC3E,MAAM,WAAW,GAAG,IAAI,uCAAkB,EAAE,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,CAAC,KAAK,EAAE,CAAC;QAChG,MAAM,UAAU,GAAG,IAAI,uCAAkB,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;QAC3E,MAAM,UAAU,GAAG,IAAI,uCAAkB,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;QACrG,MAAM,UAAU,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAE7C,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAEzE,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|