@cparra/apexdocs 2.0.1 → 2.0.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/docs/README.md +5 -14
- package/lib/model/markdown-file.d.ts +1 -0
- package/lib/model/markdown-file.js +24 -0
- package/lib/model/markdown-file.js.map +1 -1
- package/lib/model/markdown-home-file.d.ts +1 -0
- package/lib/model/markdown-home-file.js +6 -5
- package/lib/model/markdown-home-file.js.map +1 -1
- package/lib/model/markdown-type-file.d.ts +0 -1
- package/lib/model/markdown-type-file.js +1 -24
- package/lib/model/markdown-type-file.js.map +1 -1
- package/package.json +1 -1
- package/src/model/markdown-file.ts +28 -0
- package/src/model/markdown-home-file.ts +9 -5
- package/src/model/markdown-type-file.ts +1 -28
package/docs/README.md
CHANGED
|
@@ -1,25 +1,16 @@
|
|
|
1
1
|
# Classes
|
|
2
2
|
## Sample Classes
|
|
3
3
|
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
This is a class description. This class relates to {@link SampleInterface} But this {@link ClassThatDoesNotExist} does not exist. You can also link using this syntax <<SampleInterface>>
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
##
|
|
11
|
-
|
|
12
|
-
## [SampleClassWithoutModifier](/Misc/SampleClassWithoutModifier.md)
|
|
13
|
-
|
|
4
|
+
### [SampleClass](/Sample-Classes/SampleClass.md)
|
|
14
5
|
|
|
6
|
+
This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md) But this ClassThatDoesNotExist does not exist. You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
7
|
+
## Miscellaneous
|
|
15
8
|
|
|
9
|
+
### [SampleClassWithoutModifier](/Misc/SampleClassWithoutModifier.md)
|
|
16
10
|
|
|
17
11
|
|
|
18
12
|
## Sample Interfaces
|
|
19
13
|
|
|
20
|
-
|
|
21
|
-
|
|
14
|
+
### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
22
15
|
|
|
23
16
|
This is an interface description.
|
|
24
|
-
|
|
25
|
-
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.MarkdownFile = void 0;
|
|
4
4
|
const file_1 = require("./file");
|
|
5
|
+
const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
|
|
5
6
|
class MarkdownFile extends file_1.File {
|
|
6
7
|
fileExtension() {
|
|
7
8
|
return '.md';
|
|
@@ -48,6 +49,29 @@ class MarkdownFile extends file_1.File {
|
|
|
48
49
|
this._contents += column + '|';
|
|
49
50
|
});
|
|
50
51
|
}
|
|
52
|
+
static replaceInlineLinks(text) {
|
|
53
|
+
// Parsing text to extract possible linking classes.
|
|
54
|
+
const possibleLinks = text.match(/<<.*?>>/g);
|
|
55
|
+
possibleLinks === null || possibleLinks === void 0 ? void 0 : possibleLinks.forEach((currentMatch) => {
|
|
56
|
+
const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
|
|
57
|
+
text = text.replace(currentMatch, class_file_generatorHelper_1.default.getFileLinkByTypeName(classNameForMatch));
|
|
58
|
+
});
|
|
59
|
+
// Parsing links using {@link ClassName} format
|
|
60
|
+
const linkFormatRegEx = '{@link (.*?)}';
|
|
61
|
+
const expression = new RegExp(linkFormatRegEx, 'gi');
|
|
62
|
+
let match;
|
|
63
|
+
const matches = [];
|
|
64
|
+
do {
|
|
65
|
+
match = expression.exec(text);
|
|
66
|
+
if (match) {
|
|
67
|
+
matches.push(match);
|
|
68
|
+
}
|
|
69
|
+
} while (match);
|
|
70
|
+
for (const currentMatch of matches) {
|
|
71
|
+
text = text.replace(currentMatch[0], class_file_generatorHelper_1.default.getFileLinkByTypeName(currentMatch[1]));
|
|
72
|
+
}
|
|
73
|
+
return text;
|
|
74
|
+
}
|
|
51
75
|
}
|
|
52
76
|
exports.MarkdownFile = MarkdownFile;
|
|
53
77
|
//# sourceMappingURL=markdown-file.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"markdown-file.js","sourceRoot":"","sources":["../../src/model/markdown-file.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;
|
|
1
|
+
{"version":3,"file":"markdown-file.js","sourceRoot":"","sources":["../../src/model/markdown-file.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAC9B,kGAAyF;AAEzF,MAAa,YAAa,SAAQ,WAAI;IACpC,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,CAAC,IAAY,EAAE,KAAK,GAAG,CAAC;QAC9B,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;YAC9B,KAAK,IAAI,GAAG,CAAC;SACd;QAED,KAAK,IAAI,GAAG,CAAC;QACb,KAAK,IAAI,IAAI,CAAC;QACd,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,MAAM,cAAc,GAAG,MAAM,CAAC;QAC9B,IAAI,CAAC,SAAS,IAAI,cAAc,CAAC;QACjC,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,iBAAiB;QACf,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,eAAe,CAAC,GAAG,OAAiB;QAClC,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,MAAM,GAAG,GAAG,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACpB,IAAI,CAAC,SAAS,IAAI,KAAK,GAAG,GAAG,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,GAAG,OAAiB;QAC9B,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,MAAM,GAAG,GAAG,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAES,MAAM,CAAC,kBAAkB,CAAC,IAAY;QAC9C,oDAAoD;QACpD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC7C,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YACtC,MAAM,iBAAiB,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3E,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACvG,CAAC,EAAE;QAEH,+CAA+C;QAC/C,MAAM,eAAe,GAAG,eAAe,CAAC;QACxC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG;YACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACvG;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAhFD,oCAgFC"}
|
|
@@ -4,6 +4,7 @@ export declare class MarkdownHomeFile extends MarkdownFile {
|
|
|
4
4
|
fileName: string;
|
|
5
5
|
types: Type[];
|
|
6
6
|
constructor(fileName: string, types: Type[], headerContent?: string);
|
|
7
|
+
addText(text: string, encodeHtml?: boolean): void;
|
|
7
8
|
private addTypeEntries;
|
|
8
9
|
private addTypeEntry;
|
|
9
10
|
private group;
|
|
@@ -14,6 +14,10 @@ class MarkdownHomeFile extends markdown_file_1.MarkdownFile {
|
|
|
14
14
|
this.addTitle('Classes');
|
|
15
15
|
this.addTypeEntries(types);
|
|
16
16
|
}
|
|
17
|
+
addText(text, encodeHtml = true) {
|
|
18
|
+
text = markdown_file_1.MarkdownFile.replaceInlineLinks(text);
|
|
19
|
+
super.addText(text, encodeHtml);
|
|
20
|
+
}
|
|
17
21
|
addTypeEntries(types) {
|
|
18
22
|
const groupedClasses = this.group(types);
|
|
19
23
|
groupedClasses.forEach((value, key) => {
|
|
@@ -26,12 +30,9 @@ class MarkdownHomeFile extends markdown_file_1.MarkdownFile {
|
|
|
26
30
|
addTypeEntry(typeMirror) {
|
|
27
31
|
var _a, _b;
|
|
28
32
|
this.addBlankLine();
|
|
29
|
-
this.addTitle(class_file_generatorHelper_1.default.getFileLink(typeMirror),
|
|
30
|
-
this.addBlankLine();
|
|
33
|
+
this.addTitle(class_file_generatorHelper_1.default.getFileLink(typeMirror), 3);
|
|
31
34
|
this.addBlankLine();
|
|
32
35
|
this.addText((_b = (_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.description) !== null && _b !== void 0 ? _b : '');
|
|
33
|
-
this.addBlankLine();
|
|
34
|
-
this.addBlankLine();
|
|
35
36
|
}
|
|
36
37
|
group(classes) {
|
|
37
38
|
return classes.reduce((groups, currentClass) => {
|
|
@@ -44,7 +45,7 @@ class MarkdownHomeFile extends markdown_file_1.MarkdownFile {
|
|
|
44
45
|
}
|
|
45
46
|
getClassGroup(classModel) {
|
|
46
47
|
var _a, _b, _c;
|
|
47
|
-
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 : '';
|
|
48
|
+
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 : 'Miscellaneous');
|
|
48
49
|
}
|
|
49
50
|
}
|
|
50
51
|
exports.MarkdownHomeFile = MarkdownHomeFile;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"markdown-home-file.js","sourceRoot":"","sources":["../../src/model/markdown-home-file.ts"],"names":[],"mappings":";;;AACA,kGAAyF;AACzF,mDAA+C;AAE/C,MAAa,gBAAiB,SAAQ,4BAAY;IAChD,YAAmB,QAAgB,EAAS,KAAa,EAAE,aAAsB;QAC/E,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QADH,aAAQ,GAAR,QAAQ,CAAQ;QAAS,UAAK,GAAL,KAAK,CAAQ;QAEvD,IAAI,aAAa,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SAC7B;QACD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAEO,cAAc,CAAC,KAAa;QAClC,MAAM,cAAc,GAAwB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9D,cAAc,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,GAAW,EAAE,EAAE;YACpD,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACtB,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBAC3B,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,UAAgB;;QACnC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,oCAAwB,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,
|
|
1
|
+
{"version":3,"file":"markdown-home-file.js","sourceRoot":"","sources":["../../src/model/markdown-home-file.ts"],"names":[],"mappings":";;;AACA,kGAAyF;AACzF,mDAA+C;AAE/C,MAAa,gBAAiB,SAAQ,4BAAY;IAChD,YAAmB,QAAgB,EAAS,KAAa,EAAE,aAAsB;QAC/E,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QADH,aAAQ,GAAR,QAAQ,CAAQ;QAAS,UAAK,GAAL,KAAK,CAAQ;QAEvD,IAAI,aAAa,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SAC7B;QACD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAEM,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QAC5C,IAAI,GAAG,4BAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAClC,CAAC;IAEO,cAAc,CAAC,KAAa;QAClC,MAAM,cAAc,GAAwB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9D,cAAc,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,GAAW,EAAE,EAAE;YACpD,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACtB,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBAC3B,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,UAAgB;;QACnC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,oCAAwB,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,OAAO,aAAC,UAAU,CAAC,UAAU,0CAAE,WAAW,mCAAI,EAAE,CAAC,CAAC;IACzD,CAAC;IAEO,KAAK,CAAC,OAAe;QAC3B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE;YAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7C,MAAM,KAAK,GAAW,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAChB,CAAC;IAEO,aAAa,CAAC,UAAgB;;QACpC,OAAO,mBACL,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,2CAAG,IAAI,mCAAI,eAAe,CAC9G,CAAC;IACJ,CAAC;CACF;AA/CD,4CA+CC"}
|
|
@@ -15,5 +15,4 @@ export declare class MarkdownTypeFile extends MarkdownFile implements WalkerList
|
|
|
15
15
|
onInnerClassesDeclaration(classes: ClassMirror[]): void;
|
|
16
16
|
onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
|
|
17
17
|
private addInnerTypes;
|
|
18
|
-
private static replaceInlineLinks;
|
|
19
18
|
}
|
|
@@ -17,7 +17,7 @@ class MarkdownTypeFile extends markdown_file_1.MarkdownFile {
|
|
|
17
17
|
walker.walk(this);
|
|
18
18
|
}
|
|
19
19
|
addText(text, encodeHtml = true) {
|
|
20
|
-
text =
|
|
20
|
+
text = markdown_file_1.MarkdownFile.replaceInlineLinks(text);
|
|
21
21
|
super.addText(text, encodeHtml);
|
|
22
22
|
}
|
|
23
23
|
onTypeDeclaration(typeMirror, headingLevel) {
|
|
@@ -62,29 +62,6 @@ class MarkdownTypeFile extends markdown_file_1.MarkdownFile {
|
|
|
62
62
|
this.addHorizontalRule();
|
|
63
63
|
}
|
|
64
64
|
}
|
|
65
|
-
static replaceInlineLinks(text) {
|
|
66
|
-
// Parsing text to extract possible linking classes.
|
|
67
|
-
const possibleLinks = text.match(/<<.*?>>/g);
|
|
68
|
-
possibleLinks === null || possibleLinks === void 0 ? void 0 : possibleLinks.forEach((currentMatch) => {
|
|
69
|
-
const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
|
|
70
|
-
text = text.replace(currentMatch, class_file_generatorHelper_1.default.getFileLinkByTypeName(classNameForMatch));
|
|
71
|
-
});
|
|
72
|
-
// Parsing links using {@link ClassName} format
|
|
73
|
-
const linkFormatRegEx = '{@link (.*?)}';
|
|
74
|
-
const expression = new RegExp(linkFormatRegEx, 'gi');
|
|
75
|
-
let match;
|
|
76
|
-
const matches = [];
|
|
77
|
-
do {
|
|
78
|
-
match = expression.exec(text);
|
|
79
|
-
if (match) {
|
|
80
|
-
matches.push(match);
|
|
81
|
-
}
|
|
82
|
-
} while (match);
|
|
83
|
-
for (const currentMatch of matches) {
|
|
84
|
-
text = text.replace(currentMatch[0], class_file_generatorHelper_1.default.getFileLinkByTypeName(currentMatch[1]));
|
|
85
|
-
}
|
|
86
|
-
return text;
|
|
87
|
-
}
|
|
88
65
|
}
|
|
89
66
|
exports.MarkdownTypeFile = MarkdownTypeFile;
|
|
90
67
|
//# sourceMappingURL=markdown-type-file.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"markdown-type-file.js","sourceRoot":"","sources":["../../src/model/markdown-type-file.ts"],"names":[],"mappings":";;;AAUA,sEAAkE;AAElE,mDAA+C;AAC/C,yEAAsF;AACtF,kGAAyF;AAEzF,MAAa,gBAAiB,SAAQ,4BAAY;IAChD,YAAmB,IAAU,EAAS,uBAA+B,CAAC,EAAE,aAAsB;QAC5F,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,EAAE,oCAAwB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;QADvD,SAAI,GAAJ,IAAI,CAAM;QAAS,yBAAoB,GAApB,oBAAoB,CAAY;QAEpE,IAAI,aAAa,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SAC7B;QACD,MAAM,MAAM,GAAG,8BAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAEM,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QAC5C,IAAI,GAAG,
|
|
1
|
+
{"version":3,"file":"markdown-type-file.js","sourceRoot":"","sources":["../../src/model/markdown-type-file.ts"],"names":[],"mappings":";;;AAUA,sEAAkE;AAElE,mDAA+C;AAC/C,yEAAsF;AACtF,kGAAyF;AAEzF,MAAa,gBAAiB,SAAQ,4BAAY;IAChD,YAAmB,IAAU,EAAS,uBAA+B,CAAC,EAAE,aAAsB;QAC5F,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,EAAE,oCAAwB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;QADvD,SAAI,GAAJ,IAAI,CAAM;QAAS,yBAAoB,GAApB,oBAAoB,CAAY;QAEpE,IAAI,aAAa,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SAC7B;QACD,MAAM,MAAM,GAAG,8BAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAEM,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QAC5C,IAAI,GAAG,4BAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAClC,CAAC;IAEM,iBAAiB,CAAC,UAAgB,EAAE,YAAgB;QACzD,sCAAW,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAC3D,CAAC;IAEM,wBAAwB,CAAC,SAAiB,EAAE,YAAiC;QAClF,wCAAa,CAAC,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;IAC1F,CAAC;IAEM,mBAAmB,CAAC,MAAqB;QAC9C,uCAAY,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAClE,CAAC;IAEM,uBAAuB,CAAC,UAA4B;QACzD,uCAAY,CAAC,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAC1E,CAAC;IAEM,oBAAoB,CAAC,OAAuB;QACjD,wCAAa,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACrE,CAAC;IAEM,uBAAuB,CAAC,KAAmB;QAChD,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAEM,yBAAyB,CAAC,OAAsB;QACrD,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAEM,4BAA4B,CAAC,UAA6B;QAC/D,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAEO,aAAa,CAAC,KAAa,EAAE,KAAa,EAAE,YAAY,GAAG,IAAI;QACrE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAC,CAAC;QACpD,KAAK;aACF,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC,CAAC;YACvC,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC;YACtC,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;aACD,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YACvB,MAAM,SAAS,GAAG,IAAI,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAC,CAAC;YACnF,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QACL,IAAI,YAAY,EAAE;YAChB,IAAI,CAAC,iBAAiB,EAAE,CAAC;SAC1B;IACH,CAAC;CACF;AA/DD,4CA+DC"}
|
package/package.json
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { File } from './file';
|
|
2
|
+
import ClassFileGeneratorHelper from '../transpiler/markdown/class-file-generatorHelper';
|
|
2
3
|
|
|
3
4
|
export class MarkdownFile extends File {
|
|
4
5
|
fileExtension(): string {
|
|
@@ -53,4 +54,31 @@ export class MarkdownFile extends File {
|
|
|
53
54
|
this._contents += column + '|';
|
|
54
55
|
});
|
|
55
56
|
}
|
|
57
|
+
|
|
58
|
+
protected static replaceInlineLinks(text: string) {
|
|
59
|
+
// Parsing text to extract possible linking classes.
|
|
60
|
+
const possibleLinks = text.match(/<<.*?>>/g);
|
|
61
|
+
possibleLinks?.forEach((currentMatch) => {
|
|
62
|
+
const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
|
|
63
|
+
text = text.replace(currentMatch, ClassFileGeneratorHelper.getFileLinkByTypeName(classNameForMatch));
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
// Parsing links using {@link ClassName} format
|
|
67
|
+
const linkFormatRegEx = '{@link (.*?)}';
|
|
68
|
+
const expression = new RegExp(linkFormatRegEx, 'gi');
|
|
69
|
+
let match;
|
|
70
|
+
const matches = [];
|
|
71
|
+
|
|
72
|
+
do {
|
|
73
|
+
match = expression.exec(text);
|
|
74
|
+
if (match) {
|
|
75
|
+
matches.push(match);
|
|
76
|
+
}
|
|
77
|
+
} while (match);
|
|
78
|
+
|
|
79
|
+
for (const currentMatch of matches) {
|
|
80
|
+
text = text.replace(currentMatch[0], ClassFileGeneratorHelper.getFileLinkByTypeName(currentMatch[1]));
|
|
81
|
+
}
|
|
82
|
+
return text;
|
|
83
|
+
}
|
|
56
84
|
}
|
|
@@ -12,6 +12,11 @@ export class MarkdownHomeFile extends MarkdownFile {
|
|
|
12
12
|
this.addTypeEntries(types);
|
|
13
13
|
}
|
|
14
14
|
|
|
15
|
+
public addText(text: string, encodeHtml = true) {
|
|
16
|
+
text = MarkdownFile.replaceInlineLinks(text);
|
|
17
|
+
super.addText(text, encodeHtml);
|
|
18
|
+
}
|
|
19
|
+
|
|
15
20
|
private addTypeEntries(types: Type[]) {
|
|
16
21
|
const groupedClasses: Map<string, Type[]> = this.group(types);
|
|
17
22
|
groupedClasses.forEach((value: Type[], key: string) => {
|
|
@@ -24,12 +29,9 @@ export class MarkdownHomeFile extends MarkdownFile {
|
|
|
24
29
|
|
|
25
30
|
private addTypeEntry(typeMirror: Type) {
|
|
26
31
|
this.addBlankLine();
|
|
27
|
-
this.addTitle(ClassFileGeneratorHelper.getFileLink(typeMirror),
|
|
28
|
-
this.addBlankLine();
|
|
32
|
+
this.addTitle(ClassFileGeneratorHelper.getFileLink(typeMirror), 3);
|
|
29
33
|
this.addBlankLine();
|
|
30
34
|
this.addText(typeMirror.docComment?.description ?? '');
|
|
31
|
-
this.addBlankLine();
|
|
32
|
-
this.addBlankLine();
|
|
33
35
|
}
|
|
34
36
|
|
|
35
37
|
private group(classes: Type[]): Map<string, Type[]> {
|
|
@@ -43,6 +45,8 @@ export class MarkdownHomeFile extends MarkdownFile {
|
|
|
43
45
|
}
|
|
44
46
|
|
|
45
47
|
private getClassGroup(classModel: Type): string {
|
|
46
|
-
return
|
|
48
|
+
return (
|
|
49
|
+
classModel.docComment?.annotations.find((annotation) => annotation.name === 'group')?.body ?? 'Miscellaneous'
|
|
50
|
+
);
|
|
47
51
|
}
|
|
48
52
|
}
|
|
@@ -25,7 +25,7 @@ export class MarkdownTypeFile extends MarkdownFile implements WalkerListener {
|
|
|
25
25
|
}
|
|
26
26
|
|
|
27
27
|
public addText(text: string, encodeHtml = true) {
|
|
28
|
-
text =
|
|
28
|
+
text = MarkdownFile.replaceInlineLinks(text);
|
|
29
29
|
super.addText(text, encodeHtml);
|
|
30
30
|
}
|
|
31
31
|
|
|
@@ -77,31 +77,4 @@ export class MarkdownTypeFile extends MarkdownFile implements WalkerListener {
|
|
|
77
77
|
this.addHorizontalRule();
|
|
78
78
|
}
|
|
79
79
|
}
|
|
80
|
-
|
|
81
|
-
private static replaceInlineLinks(text: string) {
|
|
82
|
-
// Parsing text to extract possible linking classes.
|
|
83
|
-
const possibleLinks = text.match(/<<.*?>>/g);
|
|
84
|
-
possibleLinks?.forEach((currentMatch) => {
|
|
85
|
-
const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
|
|
86
|
-
text = text.replace(currentMatch, ClassFileGeneratorHelper.getFileLinkByTypeName(classNameForMatch));
|
|
87
|
-
});
|
|
88
|
-
|
|
89
|
-
// Parsing links using {@link ClassName} format
|
|
90
|
-
const linkFormatRegEx = '{@link (.*?)}';
|
|
91
|
-
const expression = new RegExp(linkFormatRegEx, 'gi');
|
|
92
|
-
let match;
|
|
93
|
-
const matches = [];
|
|
94
|
-
|
|
95
|
-
do {
|
|
96
|
-
match = expression.exec(text);
|
|
97
|
-
if (match) {
|
|
98
|
-
matches.push(match);
|
|
99
|
-
}
|
|
100
|
-
} while (match);
|
|
101
|
-
|
|
102
|
-
for (const currentMatch of matches) {
|
|
103
|
-
text = text.replace(currentMatch[0], ClassFileGeneratorHelper.getFileLinkByTypeName(currentMatch[1]));
|
|
104
|
-
}
|
|
105
|
-
return text;
|
|
106
|
-
}
|
|
107
80
|
}
|