@cparra/apexdocs 2.22.0 → 2.23.0
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/.eslintrc.js +12 -12
- package/.github/workflows/close_stale.yml +22 -22
- package/.prettierrc.js +7 -7
- package/LICENSE +21 -21
- package/README.md +718 -682
- package/apexdocs.config.ts +13 -11
- package/docs/README.md +1 -1
- package/docs/restapi.json +589 -589
- package/docs/types/Classes/nspc.ChildClass.md +21 -18
- package/docs/types/Main/nspc.SampleClass.md +13 -13
- package/examples/force-app/main/default/classes/AnotherInterface.cls +16 -16
- package/examples/force-app/main/default/classes/ChildClass.cls +42 -41
- package/examples/force-app/main/default/classes/EscapedAnnotations.cls +5 -5
- package/examples/force-app/main/default/classes/GrandparentClass.cls +4 -4
- package/examples/force-app/main/default/classes/GroupedClass.cls +8 -8
- package/examples/force-app/main/default/classes/MemberGrouping.cls +17 -17
- package/examples/force-app/main/default/classes/ParentClass.cls +16 -16
- package/examples/force-app/main/default/classes/SampleClass.cls +166 -166
- package/examples/force-app/main/default/classes/SampleClass.cls-meta.xml +5 -5
- package/examples/force-app/main/default/classes/SampleClassWithoutModifier.cls +9 -9
- package/examples/force-app/main/default/classes/SampleInterface.cls +16 -16
- package/examples/force-app/main/default/restapi/SampleRestResource.cls +195 -195
- package/examples/force-app/main/default/restapi/SampleRestResourceToSkip.cls +35 -35
- package/examples/force-app/main/default/restapi/SampleRestResourceWithInnerClass.cls +24 -24
- package/examples/force-app/main/default/restapi/SampleRestResourceWithoutApexDocs.cls +15 -15
- package/examples/force-app/main/default/restapi/references/Reference1.cls +9 -9
- package/examples/force-app/main/default/restapi/references/Reference2.cls +9 -9
- package/examples/force-app/main/default/restapi/references/Reference3.cls +3 -3
- package/examples/force-app/main/default/restapi/references/Reference4.cls +3 -3
- package/examples/force-app/main/default/restapi/references/Reference5.cls +3 -3
- package/examples/force-app/main/default/restapi/references/Reference6.cls +6 -6
- package/examples/force-app/main/default/restapi/references/Reference7.cls +3 -3
- package/examples/includes/header.md +3 -3
- package/jest.config.js +5 -5
- package/lib/application/Apexdocs.d.ts +13 -13
- package/lib/application/Apexdocs.js +76 -76
- package/lib/cli/generate.d.ts +2 -2
- package/lib/cli/generate.js +130 -122
- package/lib/cli/generate.js.map +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.js +17 -17
- package/lib/model/apex-bundle.d.ts +6 -6
- package/lib/model/apex-bundle.js +10 -10
- package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +7 -7
- package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +13 -13
- package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +7 -7
- package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +11 -11
- package/lib/model/inheritance.d.ts +8 -8
- package/lib/model/inheritance.js +2 -2
- package/lib/model/manifest-diff.d.ts +27 -27
- package/lib/model/manifest-diff.js +68 -68
- package/lib/model/manifest.d.ts +22 -22
- package/lib/model/manifest.js +46 -46
- package/lib/model/markdown-file.d.ts +16 -16
- package/lib/model/markdown-file.js +106 -106
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +8 -8
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +43 -43
- package/lib/model/markdown-generation-util/field-declaration-util.d.ts +3 -3
- package/lib/model/markdown-generation-util/field-declaration-util.js +54 -62
- package/lib/model/markdown-generation-util/field-declaration-util.js.map +1 -1
- package/lib/model/markdown-generation-util/index.d.ts +3 -3
- package/lib/model/markdown-generation-util/index.js +19 -19
- package/lib/model/markdown-generation-util/method-declaration-util.d.ts +4 -4
- package/lib/model/markdown-generation-util/method-declaration-util.js +114 -114
- package/lib/model/markdown-generation-util/type-declaration-util.d.ts +3 -3
- package/lib/model/markdown-generation-util/type-declaration-util.js +81 -81
- package/lib/model/markdown-home-file.d.ts +11 -11
- package/lib/model/markdown-home-file.js +53 -53
- package/lib/model/markdown-type-file.d.ts +26 -26
- package/lib/model/markdown-type-file.js +133 -141
- package/lib/model/markdown-type-file.js.map +1 -1
- package/lib/model/openapi/apex-doc-types.d.ts +19 -19
- package/lib/model/openapi/apex-doc-types.js +4 -4
- package/lib/model/openapi/open-api-types.d.ts +93 -93
- package/lib/model/openapi/open-api-types.js +2 -2
- package/lib/model/openapi/open-api.d.ts +16 -16
- package/lib/model/openapi/open-api.js +33 -33
- package/lib/model/openapi/openapi-type-file.d.ts +7 -7
- package/lib/model/openapi/openapi-type-file.js +16 -16
- package/lib/model/outputFile.d.ts +10 -10
- package/lib/model/outputFile.js +28 -28
- package/lib/model/types-repository.d.ts +16 -16
- package/lib/model/types-repository.js +53 -53
- package/lib/service/apex-file-reader.d.ts +14 -14
- package/lib/service/apex-file-reader.js +45 -45
- package/lib/service/file-system.d.ts +14 -14
- package/lib/service/file-system.js +24 -24
- package/lib/service/file-writer.d.ts +6 -6
- package/lib/service/file-writer.js +33 -33
- package/lib/service/manifest-factory.d.ts +10 -10
- package/lib/service/manifest-factory.js +13 -13
- package/lib/service/metadata-processor.d.ts +3 -3
- package/lib/service/metadata-processor.js +16 -16
- package/lib/service/parser.d.ts +21 -21
- package/lib/service/parser.js +134 -134
- package/lib/service/state.d.ts +9 -9
- package/lib/service/state.js +19 -19
- package/lib/service/walkers/class-walker.d.ts +4 -4
- package/lib/service/walkers/class-walker.js +32 -32
- package/lib/service/walkers/class-walker.js.map +1 -1
- package/lib/service/walkers/enum-walker.d.ts +4 -4
- package/lib/service/walkers/enum-walker.js +10 -10
- package/lib/service/walkers/enum-walker.js.map +1 -1
- package/lib/service/walkers/interface-walker.d.ts +4 -4
- package/lib/service/walkers/interface-walker.js +14 -14
- package/lib/service/walkers/interface-walker.js.map +1 -1
- package/lib/service/walkers/walker-factory.d.ts +5 -5
- package/lib/service/walkers/walker-factory.js +20 -20
- package/lib/service/walkers/walker.d.ts +19 -16
- package/lib/service/walkers/walker.js +16 -9
- package/lib/service/walkers/walker.js.map +1 -1
- package/lib/settings.d.ts +64 -53
- package/lib/settings.js +88 -78
- package/lib/settings.js.map +1 -1
- package/lib/test-helpers/AnnotationBuilder.d.ts +12 -12
- package/lib/test-helpers/AnnotationBuilder.js +30 -30
- package/lib/test-helpers/ClassMirrorBuilder.d.ts +18 -18
- package/lib/test-helpers/ClassMirrorBuilder.js +53 -53
- package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +8 -8
- package/lib/test-helpers/DocCommentAnnotationBuilder.js +25 -25
- package/lib/test-helpers/DocCommentBuilder.d.ts +12 -12
- package/lib/test-helpers/DocCommentBuilder.js +37 -37
- package/lib/test-helpers/FieldMirrorBuilder.d.ts +18 -18
- package/lib/test-helpers/FieldMirrorBuilder.js +53 -53
- package/lib/test-helpers/MethodMirrorBuilder.d.ts +10 -10
- package/lib/test-helpers/MethodMirrorBuilder.js +36 -36
- package/lib/test-helpers/SettingsBuilder.d.ts +8 -8
- package/lib/test-helpers/SettingsBuilder.js +26 -26
- package/lib/transpiler/factory.d.ts +6 -6
- package/lib/transpiler/factory.js +31 -31
- package/lib/transpiler/file-container.d.ts +6 -6
- package/lib/transpiler/file-container.js +15 -15
- package/lib/transpiler/generator-choices.d.ts +1 -1
- package/lib/transpiler/generator-choices.js +2 -2
- package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +8 -8
- package/lib/transpiler/markdown/class-file-generatorHelper.js +55 -55
- package/lib/transpiler/markdown/class-file-generatorHelper.js.map +1 -1
- package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +6 -6
- package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +12 -12
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +11 -10
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +50 -27
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +1 -1
- package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +11 -11
- package/lib/transpiler/markdown/markdown-transpiler-base.js +23 -23
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +6 -6
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +13 -13
- package/lib/transpiler/openapi/open-api-docs-processor.d.ts +13 -13
- package/lib/transpiler/openapi/open-api-docs-processor.js +74 -74
- package/lib/transpiler/openapi/parsers/Builder.d.ts +16 -16
- package/lib/transpiler/openapi/parsers/Builder.js +29 -29
- package/lib/transpiler/openapi/parsers/MethodParser.d.ts +20 -20
- package/lib/transpiler/openapi/parsers/MethodParser.js +166 -166
- package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +7 -7
- package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +10 -10
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +39 -39
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +225 -225
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +10 -10
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +19 -19
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +7 -7
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +21 -21
- package/lib/transpiler/processor-type-transpiler.d.ts +10 -10
- package/lib/transpiler/processor-type-transpiler.js +8 -8
- package/lib/transpiler/transpiler.d.ts +5 -5
- package/lib/transpiler/transpiler.js +26 -26
- package/lib/util/error-logger.d.ts +8 -8
- package/lib/util/error-logger.js +89 -89
- package/lib/util/logger.d.ts +21 -21
- package/lib/util/logger.js +57 -57
- package/lib/util/string-utils.d.ts +2 -2
- package/lib/util/string-utils.js +14 -14
- package/package.json +78 -78
- package/src/cli/generate.ts +8 -0
- package/src/model/markdown-generation-util/field-declaration-util.ts +3 -9
- package/src/model/markdown-type-file.ts +4 -10
- package/src/service/walkers/class-walker.ts +6 -7
- package/src/service/walkers/enum-walker.ts +0 -1
- package/src/service/walkers/interface-walker.ts +1 -1
- package/src/service/walkers/walker.ts +8 -1
- package/src/settings.ts +21 -0
- package/src/transpiler/markdown/class-file-generatorHelper.ts +2 -2
- package/src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts +26 -3
- package/tsconfig.json +20 -20
- package/tslint.json +5 -5
- package/ROADMAP.md +0 -16
|
@@ -1,82 +1,82 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.declareType = void 0;
|
|
4
|
-
const doc_comment_annotation_util_1 = require("./doc-comment-annotation-util");
|
|
5
|
-
const types_repository_1 = require("../types-repository");
|
|
6
|
-
function declareType(markdownFile, typeMirror) {
|
|
7
|
-
var _a;
|
|
8
|
-
typeMirror.annotations.forEach((currentAnnotation) => {
|
|
9
|
-
markdownFile.addBlankLine();
|
|
10
|
-
markdownFile.addText(`\`${currentAnnotation.type.toUpperCase()}\``);
|
|
11
|
-
});
|
|
12
|
-
if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
|
|
13
|
-
markdownFile.addBlankLine();
|
|
14
|
-
for (const currentLine of typeMirror.docComment.descriptionLines) {
|
|
15
|
-
markdownFile.addText(currentLine);
|
|
16
|
-
}
|
|
17
|
-
markdownFile.addBlankLine();
|
|
18
|
-
}
|
|
19
|
-
if (typeMirror.type_name === 'class') {
|
|
20
|
-
addInheritanceSectionForClass(typeMirror, markdownFile);
|
|
21
|
-
}
|
|
22
|
-
if (typeMirror.type_name === 'interface') {
|
|
23
|
-
addInheritanceSectionForInterface(typeMirror, markdownFile);
|
|
24
|
-
}
|
|
25
|
-
(0, doc_comment_annotation_util_1.addCustomDocCommentAnnotations)(markdownFile, typeMirror);
|
|
26
|
-
(0, doc_comment_annotation_util_1.addMermaid)(markdownFile, typeMirror);
|
|
27
|
-
}
|
|
28
|
-
exports.declareType = declareType;
|
|
29
|
-
function addInheritanceSectionForClass(typeMirror, markdownFile) {
|
|
30
|
-
const typeAsClass = typeMirror;
|
|
31
|
-
if (typeAsClass.extended_class) {
|
|
32
|
-
markdownFile.addBlankLine();
|
|
33
|
-
markdownFile.addText('**Inheritance**');
|
|
34
|
-
markdownFile.addBlankLine();
|
|
35
|
-
addParent(markdownFile, typeAsClass);
|
|
36
|
-
markdownFile.addText(typeMirror.name);
|
|
37
|
-
markdownFile.addBlankLine();
|
|
38
|
-
}
|
|
39
|
-
if (typeAsClass.implemented_interfaces.length) {
|
|
40
|
-
markdownFile.addBlankLine();
|
|
41
|
-
markdownFile.addText('**Implemented types**');
|
|
42
|
-
markdownFile.addBlankLine();
|
|
43
|
-
for (let i = 0; i < typeAsClass.implemented_interfaces.length; i++) {
|
|
44
|
-
const currentName = typeAsClass.implemented_interfaces[i];
|
|
45
|
-
markdownFile.addLink(currentName);
|
|
46
|
-
if (i < typeAsClass.implemented_interfaces.length - 1) {
|
|
47
|
-
markdownFile.addText(', ');
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
markdownFile.addBlankLine();
|
|
51
|
-
}
|
|
52
|
-
}
|
|
53
|
-
function addInheritanceSectionForInterface(typeMirror, markdownFile) {
|
|
54
|
-
const typeAsInterface = typeMirror;
|
|
55
|
-
if (typeAsInterface.extended_interfaces.length) {
|
|
56
|
-
markdownFile.addBlankLine();
|
|
57
|
-
markdownFile.addText('**Extended types**');
|
|
58
|
-
markdownFile.addBlankLine();
|
|
59
|
-
for (let i = 0; i < typeAsInterface.extended_interfaces.length; i++) {
|
|
60
|
-
const currentName = typeAsInterface.extended_interfaces[i];
|
|
61
|
-
markdownFile.addLink(currentName);
|
|
62
|
-
if (i < typeAsInterface.extended_interfaces.length - 1) {
|
|
63
|
-
markdownFile.addText(', ');
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
function addParent(markdownFile, classMirror) {
|
|
69
|
-
if (!classMirror.extended_class) {
|
|
70
|
-
return;
|
|
71
|
-
}
|
|
72
|
-
const parentType = types_repository_1.TypesRepository.getInstance().getFromScopedByName(classMirror.extended_class);
|
|
73
|
-
if (!parentType) {
|
|
74
|
-
return;
|
|
75
|
-
}
|
|
76
|
-
if (parentType.type_name === 'class') {
|
|
77
|
-
addParent(markdownFile, parentType);
|
|
78
|
-
}
|
|
79
|
-
markdownFile.addLink(parentType.name);
|
|
80
|
-
markdownFile.addText(' > ');
|
|
81
|
-
}
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.declareType = void 0;
|
|
4
|
+
const doc_comment_annotation_util_1 = require("./doc-comment-annotation-util");
|
|
5
|
+
const types_repository_1 = require("../types-repository");
|
|
6
|
+
function declareType(markdownFile, typeMirror) {
|
|
7
|
+
var _a;
|
|
8
|
+
typeMirror.annotations.forEach((currentAnnotation) => {
|
|
9
|
+
markdownFile.addBlankLine();
|
|
10
|
+
markdownFile.addText(`\`${currentAnnotation.type.toUpperCase()}\``);
|
|
11
|
+
});
|
|
12
|
+
if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
|
|
13
|
+
markdownFile.addBlankLine();
|
|
14
|
+
for (const currentLine of typeMirror.docComment.descriptionLines) {
|
|
15
|
+
markdownFile.addText(currentLine);
|
|
16
|
+
}
|
|
17
|
+
markdownFile.addBlankLine();
|
|
18
|
+
}
|
|
19
|
+
if (typeMirror.type_name === 'class') {
|
|
20
|
+
addInheritanceSectionForClass(typeMirror, markdownFile);
|
|
21
|
+
}
|
|
22
|
+
if (typeMirror.type_name === 'interface') {
|
|
23
|
+
addInheritanceSectionForInterface(typeMirror, markdownFile);
|
|
24
|
+
}
|
|
25
|
+
(0, doc_comment_annotation_util_1.addCustomDocCommentAnnotations)(markdownFile, typeMirror);
|
|
26
|
+
(0, doc_comment_annotation_util_1.addMermaid)(markdownFile, typeMirror);
|
|
27
|
+
}
|
|
28
|
+
exports.declareType = declareType;
|
|
29
|
+
function addInheritanceSectionForClass(typeMirror, markdownFile) {
|
|
30
|
+
const typeAsClass = typeMirror;
|
|
31
|
+
if (typeAsClass.extended_class) {
|
|
32
|
+
markdownFile.addBlankLine();
|
|
33
|
+
markdownFile.addText('**Inheritance**');
|
|
34
|
+
markdownFile.addBlankLine();
|
|
35
|
+
addParent(markdownFile, typeAsClass);
|
|
36
|
+
markdownFile.addText(typeMirror.name);
|
|
37
|
+
markdownFile.addBlankLine();
|
|
38
|
+
}
|
|
39
|
+
if (typeAsClass.implemented_interfaces.length) {
|
|
40
|
+
markdownFile.addBlankLine();
|
|
41
|
+
markdownFile.addText('**Implemented types**');
|
|
42
|
+
markdownFile.addBlankLine();
|
|
43
|
+
for (let i = 0; i < typeAsClass.implemented_interfaces.length; i++) {
|
|
44
|
+
const currentName = typeAsClass.implemented_interfaces[i];
|
|
45
|
+
markdownFile.addLink(currentName);
|
|
46
|
+
if (i < typeAsClass.implemented_interfaces.length - 1) {
|
|
47
|
+
markdownFile.addText(', ');
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
markdownFile.addBlankLine();
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
function addInheritanceSectionForInterface(typeMirror, markdownFile) {
|
|
54
|
+
const typeAsInterface = typeMirror;
|
|
55
|
+
if (typeAsInterface.extended_interfaces.length) {
|
|
56
|
+
markdownFile.addBlankLine();
|
|
57
|
+
markdownFile.addText('**Extended types**');
|
|
58
|
+
markdownFile.addBlankLine();
|
|
59
|
+
for (let i = 0; i < typeAsInterface.extended_interfaces.length; i++) {
|
|
60
|
+
const currentName = typeAsInterface.extended_interfaces[i];
|
|
61
|
+
markdownFile.addLink(currentName);
|
|
62
|
+
if (i < typeAsInterface.extended_interfaces.length - 1) {
|
|
63
|
+
markdownFile.addText(', ');
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
function addParent(markdownFile, classMirror) {
|
|
69
|
+
if (!classMirror.extended_class) {
|
|
70
|
+
return;
|
|
71
|
+
}
|
|
72
|
+
const parentType = types_repository_1.TypesRepository.getInstance().getFromScopedByName(classMirror.extended_class);
|
|
73
|
+
if (!parentType) {
|
|
74
|
+
return;
|
|
75
|
+
}
|
|
76
|
+
if (parentType.type_name === 'class') {
|
|
77
|
+
addParent(markdownFile, parentType);
|
|
78
|
+
}
|
|
79
|
+
markdownFile.addLink(parentType.name);
|
|
80
|
+
markdownFile.addText(' > ');
|
|
81
|
+
}
|
|
82
82
|
//# sourceMappingURL=type-declaration-util.js.map
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import { Type } from '@cparra/apex-reflection';
|
|
2
|
-
import { MarkdownFile } from './markdown-file';
|
|
3
|
-
export declare class MarkdownHomeFile extends MarkdownFile {
|
|
4
|
-
fileName: string;
|
|
5
|
-
types: Type[];
|
|
6
|
-
constructor(fileName: string, types: Type[], headerContent?: string);
|
|
7
|
-
private addTypeEntries;
|
|
8
|
-
private addTypeEntry;
|
|
9
|
-
private group;
|
|
10
|
-
private getClassGroup;
|
|
11
|
-
}
|
|
1
|
+
import { Type } from '@cparra/apex-reflection';
|
|
2
|
+
import { MarkdownFile } from './markdown-file';
|
|
3
|
+
export declare class MarkdownHomeFile extends MarkdownFile {
|
|
4
|
+
fileName: string;
|
|
5
|
+
types: Type[];
|
|
6
|
+
constructor(fileName: string, types: Type[], headerContent?: string);
|
|
7
|
+
private addTypeEntries;
|
|
8
|
+
private addTypeEntry;
|
|
9
|
+
private group;
|
|
10
|
+
private getClassGroup;
|
|
11
|
+
}
|
|
@@ -1,54 +1,54 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.MarkdownHomeFile = void 0;
|
|
4
|
-
const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
|
|
5
|
-
const markdown_file_1 = require("./markdown-file");
|
|
6
|
-
const string_utils_1 = require("../util/string-utils");
|
|
7
|
-
const settings_1 = require("../settings");
|
|
8
|
-
class MarkdownHomeFile extends markdown_file_1.MarkdownFile {
|
|
9
|
-
constructor(fileName, types, headerContent) {
|
|
10
|
-
super(fileName, '');
|
|
11
|
-
this.fileName = fileName;
|
|
12
|
-
this.types = types;
|
|
13
|
-
if (headerContent) {
|
|
14
|
-
this.addText(headerContent);
|
|
15
|
-
}
|
|
16
|
-
this.addTitle(settings_1.Settings.getInstance().getTitle());
|
|
17
|
-
this.addTypeEntries(types);
|
|
18
|
-
}
|
|
19
|
-
addTypeEntries(types) {
|
|
20
|
-
const groupedClasses = this.group(types);
|
|
21
|
-
groupedClasses.forEach((value, key) => {
|
|
22
|
-
this.addTitle(key, 2);
|
|
23
|
-
value.forEach((typeMirror) => {
|
|
24
|
-
this.addTypeEntry(typeMirror);
|
|
25
|
-
});
|
|
26
|
-
});
|
|
27
|
-
}
|
|
28
|
-
addTypeEntry(typeMirror) {
|
|
29
|
-
var _a;
|
|
30
|
-
this.addBlankLine();
|
|
31
|
-
this.addTitle(class_file_generatorHelper_1.default.getFileLink(typeMirror), 3);
|
|
32
|
-
this.addBlankLine();
|
|
33
|
-
if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
|
|
34
|
-
const description = typeMirror.docComment.descriptionLines.reduce((previous, current) => previous + current + '\n', '');
|
|
35
|
-
this.addText((0, string_utils_1.truncate)(description, 300));
|
|
36
|
-
this.addBlankLine();
|
|
37
|
-
}
|
|
38
|
-
}
|
|
39
|
-
group(classes) {
|
|
40
|
-
return classes.reduce((groups, currentClass) => {
|
|
41
|
-
const key = this.getClassGroup(currentClass);
|
|
42
|
-
const group = groups.get(key) || [];
|
|
43
|
-
group.push(currentClass);
|
|
44
|
-
groups.set(key, group);
|
|
45
|
-
return groups;
|
|
46
|
-
}, new Map());
|
|
47
|
-
}
|
|
48
|
-
getClassGroup(classModel) {
|
|
49
|
-
var _a, _b, _c;
|
|
50
|
-
return ((_c = (_b = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'group')) === null || _b === void 0 ? void 0 : _b.body) !== null && _c !== void 0 ? _c : settings_1.Settings.getInstance().getDefaultGroupName());
|
|
51
|
-
}
|
|
52
|
-
}
|
|
53
|
-
exports.MarkdownHomeFile = MarkdownHomeFile;
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.MarkdownHomeFile = void 0;
|
|
4
|
+
const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
|
|
5
|
+
const markdown_file_1 = require("./markdown-file");
|
|
6
|
+
const string_utils_1 = require("../util/string-utils");
|
|
7
|
+
const settings_1 = require("../settings");
|
|
8
|
+
class MarkdownHomeFile extends markdown_file_1.MarkdownFile {
|
|
9
|
+
constructor(fileName, types, headerContent) {
|
|
10
|
+
super(fileName, '');
|
|
11
|
+
this.fileName = fileName;
|
|
12
|
+
this.types = types;
|
|
13
|
+
if (headerContent) {
|
|
14
|
+
this.addText(headerContent);
|
|
15
|
+
}
|
|
16
|
+
this.addTitle(settings_1.Settings.getInstance().getTitle());
|
|
17
|
+
this.addTypeEntries(types);
|
|
18
|
+
}
|
|
19
|
+
addTypeEntries(types) {
|
|
20
|
+
const groupedClasses = this.group(types);
|
|
21
|
+
groupedClasses.forEach((value, key) => {
|
|
22
|
+
this.addTitle(key, 2);
|
|
23
|
+
value.forEach((typeMirror) => {
|
|
24
|
+
this.addTypeEntry(typeMirror);
|
|
25
|
+
});
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
addTypeEntry(typeMirror) {
|
|
29
|
+
var _a;
|
|
30
|
+
this.addBlankLine();
|
|
31
|
+
this.addTitle(class_file_generatorHelper_1.default.getFileLink(typeMirror), 3);
|
|
32
|
+
this.addBlankLine();
|
|
33
|
+
if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
|
|
34
|
+
const description = typeMirror.docComment.descriptionLines.reduce((previous, current) => previous + current + '\n', '');
|
|
35
|
+
this.addText((0, string_utils_1.truncate)(description, 300));
|
|
36
|
+
this.addBlankLine();
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
group(classes) {
|
|
40
|
+
return classes.reduce((groups, currentClass) => {
|
|
41
|
+
const key = this.getClassGroup(currentClass);
|
|
42
|
+
const group = groups.get(key) || [];
|
|
43
|
+
group.push(currentClass);
|
|
44
|
+
groups.set(key, group);
|
|
45
|
+
return groups;
|
|
46
|
+
}, new Map());
|
|
47
|
+
}
|
|
48
|
+
getClassGroup(classModel) {
|
|
49
|
+
var _a, _b, _c;
|
|
50
|
+
return ((_c = (_b = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'group')) === null || _b === void 0 ? void 0 : _b.body) !== null && _c !== void 0 ? _c : settings_1.Settings.getInstance().getDefaultGroupName());
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
exports.MarkdownHomeFile = MarkdownHomeFile;
|
|
54
54
|
//# sourceMappingURL=markdown-home-file.js.map
|
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
import { ClassMirror, ConstructorMirror, EnumMirror, InterfaceMirror, MethodMirror, Type } from '@cparra/apex-reflection';
|
|
2
|
-
import { WalkerListener } from '../service/walkers/walker';
|
|
3
|
-
import { MarkdownFile } from './markdown-file';
|
|
4
|
-
import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from './inheritance';
|
|
5
|
-
export declare class MarkdownTypeFile extends MarkdownFile implements WalkerListener {
|
|
6
|
-
private type;
|
|
7
|
-
private headingLevel;
|
|
8
|
-
private isInner;
|
|
9
|
-
constructor(type: Type, headingLevel?: number, headerContent?: string, isInner?: boolean);
|
|
10
|
-
onTypeDeclaration(typeMirror: Type): void;
|
|
11
|
-
private isClass;
|
|
12
|
-
onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
|
|
13
|
-
onFieldsDeclaration(fields: FieldMirrorWithInheritance[]): void;
|
|
14
|
-
onPropertiesDeclaration(properties: PropertyMirrorWithInheritance[]): void;
|
|
15
|
-
onMethodsDeclaration(methods: MethodMirror[]): void;
|
|
16
|
-
onInnerEnumsDeclaration(enums: EnumMirror[]): void;
|
|
17
|
-
onInnerClassesDeclaration(classes: ClassMirror[]): void;
|
|
18
|
-
onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
|
|
19
|
-
private addInnerTypes;
|
|
20
|
-
private hasGroupings;
|
|
21
|
-
private declareMethodWithGroupings;
|
|
22
|
-
private declareFieldOrProperty;
|
|
23
|
-
private startGroup;
|
|
24
|
-
private endGroup;
|
|
25
|
-
private group;
|
|
26
|
-
}
|
|
1
|
+
import { ClassMirror, ConstructorMirror, EnumMirror, InterfaceMirror, MethodMirror, Type } from '@cparra/apex-reflection';
|
|
2
|
+
import { WalkerListener } from '../service/walkers/walker';
|
|
3
|
+
import { MarkdownFile } from './markdown-file';
|
|
4
|
+
import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from './inheritance';
|
|
5
|
+
export declare class MarkdownTypeFile extends MarkdownFile implements WalkerListener {
|
|
6
|
+
private type;
|
|
7
|
+
private headingLevel;
|
|
8
|
+
private isInner;
|
|
9
|
+
constructor(type: Type, headingLevel?: number, headerContent?: string, isInner?: boolean);
|
|
10
|
+
onTypeDeclaration(typeMirror: Type): void;
|
|
11
|
+
private isClass;
|
|
12
|
+
onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
|
|
13
|
+
onFieldsDeclaration(fields: FieldMirrorWithInheritance[]): void;
|
|
14
|
+
onPropertiesDeclaration(properties: PropertyMirrorWithInheritance[]): void;
|
|
15
|
+
onMethodsDeclaration(methods: MethodMirror[]): void;
|
|
16
|
+
onInnerEnumsDeclaration(enums: EnumMirror[]): void;
|
|
17
|
+
onInnerClassesDeclaration(classes: ClassMirror[]): void;
|
|
18
|
+
onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
|
|
19
|
+
private addInnerTypes;
|
|
20
|
+
private hasGroupings;
|
|
21
|
+
private declareMethodWithGroupings;
|
|
22
|
+
private declareFieldOrProperty;
|
|
23
|
+
private startGroup;
|
|
24
|
+
private endGroup;
|
|
25
|
+
private group;
|
|
26
|
+
}
|
|
@@ -1,142 +1,134 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.MarkdownTypeFile = void 0;
|
|
4
|
-
const walker_factory_1 = require("../service/walkers/walker-factory");
|
|
5
|
-
const markdown_file_1 = require("./markdown-file");
|
|
6
|
-
const markdown_generation_util_1 = require("./markdown-generation-util");
|
|
7
|
-
const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
|
|
8
|
-
const settings_1 = require("../settings");
|
|
9
|
-
class MarkdownTypeFile extends markdown_file_1.MarkdownFile {
|
|
10
|
-
constructor(type, headingLevel = 1, headerContent, isInner = false) {
|
|
11
|
-
super(`${settings_1.Settings.getInstance().getNamespacePrefix()}${type.name}`, class_file_generatorHelper_1.default.getSanitizedGroup(type));
|
|
12
|
-
this.type = type;
|
|
13
|
-
this.headingLevel = headingLevel;
|
|
14
|
-
this.isInner = isInner;
|
|
15
|
-
if (headerContent) {
|
|
16
|
-
this.addText(headerContent);
|
|
17
|
-
}
|
|
18
|
-
const walker = walker_factory_1.WalkerFactory.get(type);
|
|
19
|
-
walker.walk(this);
|
|
20
|
-
}
|
|
21
|
-
onTypeDeclaration(typeMirror) {
|
|
22
|
-
let fullTypeName;
|
|
23
|
-
if (this.isInner) {
|
|
24
|
-
fullTypeName = typeMirror.name;
|
|
25
|
-
}
|
|
26
|
-
else {
|
|
27
|
-
// If we are dealing with a class, we want to check if it has a class
|
|
28
|
-
// modifier and add it to the name.
|
|
29
|
-
if (this.isClass(typeMirror) && typeMirror.classModifier) {
|
|
30
|
-
fullTypeName = `${typeMirror.classModifier} ${settings_1.Settings.getInstance().getNamespacePrefix()}${typeMirror.name}`;
|
|
31
|
-
}
|
|
32
|
-
else {
|
|
33
|
-
fullTypeName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${typeMirror.name}`;
|
|
34
|
-
}
|
|
35
|
-
}
|
|
36
|
-
this.addTitle(fullTypeName, this.headingLevel);
|
|
37
|
-
(0, markdown_generation_util_1.declareType)(this, typeMirror);
|
|
38
|
-
}
|
|
39
|
-
isClass(typeMirror) {
|
|
40
|
-
return typeMirror.type_name === 'class';
|
|
41
|
-
}
|
|
42
|
-
onConstructorDeclaration(className, constructors) {
|
|
43
|
-
this.addTitle('Constructors', this.headingLevel + 1);
|
|
44
|
-
this.declareMethodWithGroupings(constructors, className);
|
|
45
|
-
}
|
|
46
|
-
onFieldsDeclaration(fields) {
|
|
47
|
-
this.addTitle('Fields', this.headingLevel + 1);
|
|
48
|
-
this.declareFieldOrProperty(fields);
|
|
49
|
-
}
|
|
50
|
-
onPropertiesDeclaration(properties) {
|
|
51
|
-
this.addTitle('Properties', this.headingLevel + 1);
|
|
52
|
-
this.declareFieldOrProperty(properties);
|
|
53
|
-
}
|
|
54
|
-
onMethodsDeclaration(methods) {
|
|
55
|
-
this.addTitle('Methods', this.headingLevel + 1);
|
|
56
|
-
this.declareMethodWithGroupings(methods);
|
|
57
|
-
}
|
|
58
|
-
onInnerEnumsDeclaration(enums) {
|
|
59
|
-
this.addInnerTypes('Enums', enums);
|
|
60
|
-
}
|
|
61
|
-
onInnerClassesDeclaration(classes) {
|
|
62
|
-
this.addInnerTypes('Classes', classes);
|
|
63
|
-
}
|
|
64
|
-
onInnerInterfacesDeclaration(interfaces) {
|
|
65
|
-
this.addInnerTypes('Interfaces', interfaces, false);
|
|
66
|
-
}
|
|
67
|
-
addInnerTypes(title, types, addSeparator = true) {
|
|
68
|
-
this.addTitle(title, this.headingLevel + 1);
|
|
69
|
-
types
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
const group = groups[groupName] || [];
|
|
135
|
-
group.push(item);
|
|
136
|
-
groups[groupName] = group;
|
|
137
|
-
return groups;
|
|
138
|
-
}, {});
|
|
139
|
-
}
|
|
140
|
-
}
|
|
141
|
-
exports.MarkdownTypeFile = MarkdownTypeFile;
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.MarkdownTypeFile = void 0;
|
|
4
|
+
const walker_factory_1 = require("../service/walkers/walker-factory");
|
|
5
|
+
const markdown_file_1 = require("./markdown-file");
|
|
6
|
+
const markdown_generation_util_1 = require("./markdown-generation-util");
|
|
7
|
+
const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
|
|
8
|
+
const settings_1 = require("../settings");
|
|
9
|
+
class MarkdownTypeFile extends markdown_file_1.MarkdownFile {
|
|
10
|
+
constructor(type, headingLevel = 1, headerContent, isInner = false) {
|
|
11
|
+
super(`${settings_1.Settings.getInstance().getNamespacePrefix()}${type.name}`, class_file_generatorHelper_1.default.getSanitizedGroup(type));
|
|
12
|
+
this.type = type;
|
|
13
|
+
this.headingLevel = headingLevel;
|
|
14
|
+
this.isInner = isInner;
|
|
15
|
+
if (headerContent) {
|
|
16
|
+
this.addText(headerContent);
|
|
17
|
+
}
|
|
18
|
+
const walker = walker_factory_1.WalkerFactory.get(type);
|
|
19
|
+
walker.walk(this);
|
|
20
|
+
}
|
|
21
|
+
onTypeDeclaration(typeMirror) {
|
|
22
|
+
let fullTypeName;
|
|
23
|
+
if (this.isInner) {
|
|
24
|
+
fullTypeName = typeMirror.name;
|
|
25
|
+
}
|
|
26
|
+
else {
|
|
27
|
+
// If we are dealing with a class, we want to check if it has a class
|
|
28
|
+
// modifier and add it to the name.
|
|
29
|
+
if (this.isClass(typeMirror) && typeMirror.classModifier) {
|
|
30
|
+
fullTypeName = `${typeMirror.classModifier} ${settings_1.Settings.getInstance().getNamespacePrefix()}${typeMirror.name}`;
|
|
31
|
+
}
|
|
32
|
+
else {
|
|
33
|
+
fullTypeName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${typeMirror.name}`;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
this.addTitle(fullTypeName, this.headingLevel);
|
|
37
|
+
(0, markdown_generation_util_1.declareType)(this, typeMirror);
|
|
38
|
+
}
|
|
39
|
+
isClass(typeMirror) {
|
|
40
|
+
return typeMirror.type_name === 'class';
|
|
41
|
+
}
|
|
42
|
+
onConstructorDeclaration(className, constructors) {
|
|
43
|
+
this.addTitle('Constructors', this.headingLevel + 1);
|
|
44
|
+
this.declareMethodWithGroupings(constructors, className);
|
|
45
|
+
}
|
|
46
|
+
onFieldsDeclaration(fields) {
|
|
47
|
+
this.addTitle('Fields', this.headingLevel + 1);
|
|
48
|
+
this.declareFieldOrProperty(fields);
|
|
49
|
+
}
|
|
50
|
+
onPropertiesDeclaration(properties) {
|
|
51
|
+
this.addTitle('Properties', this.headingLevel + 1);
|
|
52
|
+
this.declareFieldOrProperty(properties);
|
|
53
|
+
}
|
|
54
|
+
onMethodsDeclaration(methods) {
|
|
55
|
+
this.addTitle('Methods', this.headingLevel + 1);
|
|
56
|
+
this.declareMethodWithGroupings(methods);
|
|
57
|
+
}
|
|
58
|
+
onInnerEnumsDeclaration(enums) {
|
|
59
|
+
this.addInnerTypes('Enums', enums);
|
|
60
|
+
}
|
|
61
|
+
onInnerClassesDeclaration(classes) {
|
|
62
|
+
this.addInnerTypes('Classes', classes);
|
|
63
|
+
}
|
|
64
|
+
onInnerInterfacesDeclaration(interfaces) {
|
|
65
|
+
this.addInnerTypes('Interfaces', interfaces, false);
|
|
66
|
+
}
|
|
67
|
+
addInnerTypes(title, types, addSeparator = true) {
|
|
68
|
+
this.addTitle(title, this.headingLevel + 1);
|
|
69
|
+
types.forEach((currentType) => {
|
|
70
|
+
const innerFile = new MarkdownTypeFile(currentType, this.headingLevel + 2, undefined, true);
|
|
71
|
+
this.addText(innerFile._contents);
|
|
72
|
+
});
|
|
73
|
+
if (addSeparator) {
|
|
74
|
+
this.addHorizontalRule();
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
hasGroupings(groupAware) {
|
|
78
|
+
return !!groupAware.find((current) => !!current.group);
|
|
79
|
+
}
|
|
80
|
+
declareMethodWithGroupings(methods, className = '') {
|
|
81
|
+
const hasGroupings = this.hasGroupings(methods);
|
|
82
|
+
if (!hasGroupings) {
|
|
83
|
+
(0, markdown_generation_util_1.declareMethod)(this, methods, this.headingLevel, className);
|
|
84
|
+
}
|
|
85
|
+
else {
|
|
86
|
+
const groupedConstructors = this.group(methods);
|
|
87
|
+
for (const key in groupedConstructors) {
|
|
88
|
+
// For the group description, we can take the first one, since they all have the same description.
|
|
89
|
+
this.startGroup(key, groupedConstructors[key][0].groupDescription);
|
|
90
|
+
const constructorsForGroup = groupedConstructors[key];
|
|
91
|
+
(0, markdown_generation_util_1.declareMethod)(this, constructorsForGroup, this.headingLevel, className);
|
|
92
|
+
this.endGroup();
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
declareFieldOrProperty(fieldsOrProperties) {
|
|
97
|
+
const hasGroupings = this.hasGroupings(fieldsOrProperties);
|
|
98
|
+
if (!hasGroupings) {
|
|
99
|
+
(0, markdown_generation_util_1.declareField)(this, fieldsOrProperties, this.headingLevel, false);
|
|
100
|
+
}
|
|
101
|
+
else {
|
|
102
|
+
const groupedFields = this.group(fieldsOrProperties);
|
|
103
|
+
for (const key in groupedFields) {
|
|
104
|
+
// For the group description, we can take the first one, since they all have the same description.
|
|
105
|
+
this.startGroup(key, groupedFields[key][0].groupDescription);
|
|
106
|
+
const fieldsForGroup = groupedFields[key];
|
|
107
|
+
(0, markdown_generation_util_1.declareField)(this, fieldsForGroup, this.headingLevel, true);
|
|
108
|
+
this.endGroup();
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
startGroup(groupName, groupDescription) {
|
|
113
|
+
this.headingLevel = this.headingLevel + 2;
|
|
114
|
+
this.addTitle(groupName, this.headingLevel);
|
|
115
|
+
if (groupDescription) {
|
|
116
|
+
this.addText(groupDescription);
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
endGroup() {
|
|
120
|
+
this.headingLevel = this.headingLevel - 2;
|
|
121
|
+
}
|
|
122
|
+
group(list) {
|
|
123
|
+
return list.reduce((groups, item) => {
|
|
124
|
+
var _a;
|
|
125
|
+
const groupName = (_a = item.group) !== null && _a !== void 0 ? _a : 'Other';
|
|
126
|
+
const group = groups[groupName] || [];
|
|
127
|
+
group.push(item);
|
|
128
|
+
groups[groupName] = group;
|
|
129
|
+
return groups;
|
|
130
|
+
}, {});
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
exports.MarkdownTypeFile = MarkdownTypeFile;
|
|
142
134
|
//# sourceMappingURL=markdown-type-file.js.map
|