@cparra/apexdocs 2.25.0-alpha.0 → 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/__mocks__/chalk.js +12 -0
- package/__mocks__/log-update.js +6 -0
- package/eslint.config.mjs +10 -0
- package/examples/plain-markdown/docs/Miscellaneous/ns.BaseClass.md +16 -0
- package/examples/plain-markdown/docs/Miscellaneous/ns.MultiInheritanceClass.md +73 -0
- package/examples/plain-markdown/docs/Miscellaneous/ns.ParentInterface.md +15 -0
- package/examples/plain-markdown/docs/Miscellaneous/ns.ReferencedEnum.md +8 -0
- package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +7 -0
- package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +115 -0
- package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +36 -0
- package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +173 -0
- package/examples/plain-markdown/docs/index.md +33 -0
- package/examples/plain-markdown/force-app/classes/MultiInheritanceClass.cls +1 -0
- package/examples/plain-markdown/force-app/classes/SampleClass.cls +37 -0
- package/examples/plain-markdown/package.json +2 -6
- package/jest.config.js +4 -0
- package/jest.d.ts +7 -0
- package/lib/__spec__/core/expect-extensions.d.ts +3 -0
- package/lib/__spec__/core/expect-extensions.js +54 -0
- package/lib/__spec__/core/expect-extensions.js.map +1 -0
- package/lib/__spec__/core/generating-class-docs.spec.d.ts +1 -0
- package/lib/__spec__/core/generating-class-docs.spec.js +427 -0
- package/lib/__spec__/core/generating-class-docs.spec.js.map +1 -0
- package/lib/__spec__/core/generating-enum-docs.spec.d.ts +1 -0
- package/lib/__spec__/core/generating-enum-docs.spec.js +303 -0
- package/lib/__spec__/core/generating-enum-docs.spec.js.map +1 -0
- package/lib/__spec__/core/generating-interface-docs.spec.d.ts +1 -0
- package/lib/__spec__/core/generating-interface-docs.spec.js +361 -0
- package/lib/__spec__/core/generating-interface-docs.spec.js.map +1 -0
- package/lib/__spec__/core/generating-reference-guide.spec.d.ts +1 -0
- package/lib/__spec__/core/generating-reference-guide.spec.js +161 -0
- package/lib/__spec__/core/generating-reference-guide.spec.js.map +1 -0
- package/lib/adapters/apex-types.d.ts +5 -5
- package/lib/adapters/apex-types.js +97 -22
- package/lib/adapters/apex-types.js.map +1 -1
- package/lib/adapters/documentables.d.ts +4 -3
- package/lib/adapters/documentables.js +23 -8
- package/lib/adapters/documentables.js.map +1 -1
- package/lib/adapters/fields-and-properties.d.ts +4 -3
- package/lib/adapters/fields-and-properties.js +26 -5
- package/lib/adapters/fields-and-properties.js.map +1 -1
- package/lib/adapters/methods-and-constructors.d.ts +4 -3
- package/lib/adapters/methods-and-constructors.js +54 -12
- package/lib/adapters/methods-and-constructors.js.map +1 -1
- package/lib/adapters/references.d.ts +1 -1
- package/lib/adapters/references.js +3 -3
- package/lib/adapters/references.js.map +1 -1
- package/lib/adapters/type-utils.d.ts +1 -1
- package/lib/adapters/type-utils.js +1 -2
- package/lib/adapters/type-utils.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/cli/generate.js +7 -7
- package/lib/cli/generate.js.map +1 -1
- 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 +24 -0
- package/lib/core/generate-docs.js +267 -0
- package/lib/core/generate-docs.js.map +1 -0
- 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/core/template.d.ts +10 -0
- package/lib/core/template.js +92 -0
- package/lib/core/template.js.map +1 -0
- package/lib/core/templates/reference-guide.d.ts +1 -0
- package/lib/core/templates/reference-guide.js +18 -0
- package/lib/core/templates/reference-guide.js.map +1 -0
- package/lib/index.d.ts +2 -1
- package/lib/index.js +14 -3
- package/lib/index.js.map +1 -1
- package/lib/model/inheritance.d.ts +4 -1
- package/lib/model/manifest.js +8 -2
- package/lib/model/manifest.js.map +1 -1
- package/lib/model/markdown-file.d.ts +2 -2
- package/lib/model/markdown-file.js +5 -4
- package/lib/model/markdown-file.js.map +1 -1
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +3 -4
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -1
- package/lib/model/markdown-generation-util/field-declaration-util.js +1 -2
- package/lib/model/markdown-generation-util/field-declaration-util.js.map +1 -1
- package/lib/model/markdown-generation-util/method-declaration-util.js +2 -3
- package/lib/model/markdown-generation-util/method-declaration-util.js.map +1 -1
- package/lib/model/markdown-generation-util/type-declaration-util.js +1 -2
- package/lib/model/markdown-generation-util/type-declaration-util.js.map +1 -1
- package/lib/model/markdown-home-file.js.map +1 -1
- package/lib/model/markdown-type-file.js.map +1 -1
- package/lib/model/openapi/open-api.js.map +1 -1
- package/lib/model/outputFile.d.ts +1 -1
- package/lib/model/outputFile.js +2 -9
- package/lib/model/outputFile.js.map +1 -1
- package/lib/model/types-repository.js.map +1 -1
- package/lib/service/apex-file-reader.js.map +1 -1
- package/lib/service/file-writer.js.map +1 -1
- package/lib/service/manifest-factory.js +1 -2
- package/lib/service/manifest-factory.js.map +1 -1
- package/lib/service/metadata-processor.js.map +1 -1
- package/lib/service/parser.js +1 -1
- package/lib/service/parser.js.map +1 -1
- package/lib/service/state.js.map +1 -1
- package/lib/service/walkers/class-walker.js.map +1 -1
- package/lib/service/walkers/interface-walker.js.map +1 -1
- package/lib/service/walkers/walker-factory.js.map +1 -1
- package/lib/service/walkers/walker.js.map +1 -1
- package/lib/settings.d.ts +0 -6
- package/lib/settings.js +0 -11
- package/lib/settings.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/factory.js.map +1 -1
- package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +1 -1
- package/lib/transpiler/markdown/class-file-generatorHelper.js.map +1 -1
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/class-template.js +53 -12
- package/lib/transpiler/markdown/plain-markdown/class-template.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js +13 -16
- package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js +11 -8
- package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/enum-template.js +7 -6
- package/lib/transpiler/markdown/plain-markdown/enum-template.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +9 -6
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +10 -0
- package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/interface-template.js +4 -4
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js +18 -20
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +0 -4
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +6 -86
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js +31 -0
- package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js.map +1 -0
- package/lib/transpiler/openapi/open-api-docs-processor.js.map +1 -1
- package/lib/transpiler/openapi/parsers/Builder.js.map +1 -1
- package/lib/transpiler/openapi/parsers/MethodParser.js.map +1 -1
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +3 -2
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +1 -1
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +1 -1
- package/lib/transpiler/transpiler.js.map +1 -1
- package/lib/util/error-logger.js.map +1 -1
- package/lib/util/logger.js +1 -1
- package/lib/util/logger.js.map +1 -1
- package/lib/util/string-utils.js +2 -2
- package/lib/util/string-utils.js.map +1 -1
- package/package.json +17 -17
- package/src/__spec__/core/expect-extensions.ts +32 -0
- package/src/__spec__/core/generating-class-docs.spec.ts +511 -0
- package/src/__spec__/core/generating-enum-docs.spec.ts +355 -0
- package/src/__spec__/core/generating-interface-docs.spec.ts +431 -0
- package/src/__spec__/core/generating-reference-guide.spec.ts +163 -0
- package/src/adapters/__tests__/interface-adapter.spec.ts +15 -11
- package/src/adapters/__tests__/references.spec.ts +1 -1
- package/src/adapters/apex-types.ts +205 -41
- package/src/adapters/documentables.ts +44 -9
- package/src/adapters/fields-and-properties.ts +31 -7
- package/src/adapters/methods-and-constructors.ts +65 -22
- package/src/adapters/references.ts +1 -1
- package/src/adapters/type-utils.ts +1 -1
- package/src/application/Apexdocs.ts +21 -15
- package/src/application/flows/generate-markdown-files.ts +47 -0
- package/src/cli/generate.ts +96 -96
- package/src/core/__test__/inheritance-chain.test.ts +54 -0
- package/src/core/generate-docs.ts +396 -0
- package/src/core/inheritance-chain.ts +23 -0
- package/src/core/renderable/types.d.ts +131 -0
- package/src/core/template.ts +108 -0
- package/src/core/templates/reference-guide.ts +14 -0
- package/src/index.ts +3 -1
- package/src/model/inheritance.ts +2 -1
- package/src/model/manifest.ts +12 -2
- package/src/model/markdown-file.ts +5 -4
- package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +1 -1
- package/src/model/markdown-generation-util/method-declaration-util.ts +1 -1
- package/src/model/outputFile.ts +2 -11
- package/src/service/parser.ts +1 -1
- package/src/settings.ts +0 -15
- package/src/test-helpers/ClassMirrorBuilder.ts +14 -1
- package/src/transpiler/markdown/class-file-generatorHelper.ts +1 -1
- package/src/transpiler/markdown/plain-markdown/class-template.ts +53 -12
- package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +13 -16
- package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +11 -8
- package/src/transpiler/markdown/plain-markdown/enum-template.ts +7 -6
- package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +9 -6
- package/src/transpiler/markdown/plain-markdown/grouped-members-partial-template.ts +6 -0
- package/src/transpiler/markdown/plain-markdown/interface-template.ts +4 -4
- package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +18 -20
- package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +8 -100
- package/src/transpiler/markdown/plain-markdown/type-doc-partial.ts +27 -0
- package/src/transpiler/openapi/parsers/ReferenceBuilder.ts +3 -2
- package/src/util/logger.ts +1 -1
- package/tsconfig.json +1 -1
- package/.eslintrc.js +0 -12
- package/examples/plain-markdown/README.md +0 -301
- package/lib/templating/compile.d.ts +0 -7
- package/lib/templating/compile.js +0 -98
- package/lib/templating/compile.js.map +0 -1
- package/lib/templating/helpers.d.ts +0 -2
- package/lib/templating/helpers.js +0 -18
- package/lib/templating/helpers.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.d.ts +0 -1
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js +0 -31
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js.map +0 -1
- package/src/templating/__tests__/compile.spec.ts +0 -741
- package/src/templating/compile.ts +0 -187
- package/src/templating/helpers.ts +0 -14
- package/src/templating/types.d.ts +0 -104
- package/src/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.ts +0 -27
|
@@ -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"}
|
package/lib/cli/generate.js
CHANGED
|
@@ -30,9 +30,10 @@ const Apexdocs_1 = require("../application/Apexdocs");
|
|
|
30
30
|
const cosmiconfig_1 = require("cosmiconfig");
|
|
31
31
|
const result = (0, cosmiconfig_1.cosmiconfig)('apexdocs').search();
|
|
32
32
|
result.then((config) => {
|
|
33
|
-
var _a, _b, _c
|
|
33
|
+
var _a, _b, _c;
|
|
34
34
|
yargs.config(config === null || config === void 0 ? void 0 : config.config);
|
|
35
|
-
let argv = yargs
|
|
35
|
+
let argv = yargs
|
|
36
|
+
.options({
|
|
36
37
|
sourceDir: {
|
|
37
38
|
type: 'string',
|
|
38
39
|
alias: 's',
|
|
@@ -52,7 +53,8 @@ result.then((config) => {
|
|
|
52
53
|
describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
|
|
53
54
|
},
|
|
54
55
|
scope: {
|
|
55
|
-
type: '
|
|
56
|
+
type: 'string',
|
|
57
|
+
array: true,
|
|
56
58
|
alias: 'p',
|
|
57
59
|
default: ['global'],
|
|
58
60
|
describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
|
|
@@ -119,7 +121,8 @@ result.then((config) => {
|
|
|
119
121
|
type: 'string',
|
|
120
122
|
describe: 'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
|
|
121
123
|
},
|
|
122
|
-
})
|
|
124
|
+
})
|
|
125
|
+
.parseSync();
|
|
123
126
|
if (config) {
|
|
124
127
|
argv = Object.assign(Object.assign({}, config.config), argv);
|
|
125
128
|
}
|
|
@@ -142,9 +145,6 @@ result.then((config) => {
|
|
|
142
145
|
onAfterProcess: (_a = config === null || config === void 0 ? void 0 : config.config) === null || _a === void 0 ? void 0 : _a.onAfterProcess,
|
|
143
146
|
onBeforeFileWrite: (_b = config === null || config === void 0 ? void 0 : config.config) === null || _b === void 0 ? void 0 : _b.onBeforeFileWrite,
|
|
144
147
|
frontMatterHeader: (_c = config === null || config === void 0 ? void 0 : config.config) === null || _c === void 0 ? void 0 : _c.frontMatterHeader,
|
|
145
|
-
singleFile: (_d = config === null || config === void 0 ? void 0 : config.config) === null || _d === void 0 ? void 0 : _d.singleFile,
|
|
146
|
-
fileName: (_e = config === null || config === void 0 ? void 0 : config.config) === null || _e === void 0 ? void 0 : _e.fileName,
|
|
147
|
-
templateFilePath: (_f = config === null || config === void 0 ? void 0 : config.config) === null || _f === void 0 ? void 0 : _f.templateFilePath,
|
|
148
148
|
});
|
|
149
149
|
try {
|
|
150
150
|
Apexdocs_1.Apexdocs.generate();
|
package/lib/cli/generate.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAA+B;AAE/B,0CAAuC;AACvC,sDAAmD;AAEnD,6CAA0C;AAE1C,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;AAChD,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;;IACrB,KAAK,CAAC,MAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,CAAC;IAC7B,IAAI,IAAI,GAAG,KAAK,
|
|
1
|
+
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAA+B;AAE/B,0CAAuC;AACvC,sDAAmD;AAEnD,6CAA0C;AAE1C,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;AAChD,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;;IACrB,KAAK,CAAC,MAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,CAAC;IAC7B,IAAI,IAAI,GAAG,KAAK;SACb,OAAO,CAAC;QACP,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,+DAA+D;SAC1E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,kEAAkE;SAC7E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,kFAAkF;SAC7F;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,QAAQ,CAAC;YACnB,QAAQ,EACN,sHAAsH;gBACtH,4HAA4H;gBAC5H,0IAA0I;SAC7I;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,CAAC;YAC3D,QAAQ,EACN,4EAA4E;gBAC5E,yEAAyE;SAC5E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,0DAA0D;SACrE;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,qEAAqE;SAChF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,QAAQ,EACN,sGAAsG;gBACtG,kHAAkH;gBAClH,0GAA0G;gBAC1G,iDAAiD;SACpD;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,iGAAiG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qFAAqF;YAC/F,OAAO,EAAE,SAAS;SACnB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,+HAA+H;gBAC/H,iFAAiF;SACpF;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qGAAqG;YAC/G,OAAO,EAAE,SAAS;SACnB;QACD,yBAAyB,EAAE;YACzB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,KAAK;SACf;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,kGAAkG;YAC5G,OAAO,EAAE,KAAK;SACf;QACD,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,oNAAoN;SACvN;KACF,CAAC;SACD,SAAS,EAAE,CAAC;IAEf,IAAI,MAAM,EAAE,CAAC;QACX,IAAI,mCAAQ,MAAM,CAAC,MAAM,GAAK,IAAI,CAAE,CAAC;IACvC,CAAC;IAED,mBAAQ,CAAC,KAAK,CAAC;QACb,eAAe,EAAE,IAAI,CAAC,SAAS;QAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;QACzD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;QACzD,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,OAAO,EAAE,IAAI,CAAC,oBAAoB;QAClC,cAAc,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,cAAc;QAC9C,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;QACpD,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;KACrD,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,mBAAQ,CAAC,QAAQ,EAAE,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,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"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { Type } from '@cparra/apex-reflection';
|
|
2
|
+
import * as E from 'fp-ts/Either';
|
|
3
|
+
export declare const documentType: (type: Type, linkGenerator: import("../adapters/references").GetRenderableContentByTypeName, namespace?: string | undefined) => string;
|
|
4
|
+
export type DocumentationBundle = {
|
|
5
|
+
format: 'markdown';
|
|
6
|
+
referenceGuide: string;
|
|
7
|
+
docs: DocOutput[];
|
|
8
|
+
};
|
|
9
|
+
type DocumentationConfig = {
|
|
10
|
+
scope: string[];
|
|
11
|
+
outputDir: string;
|
|
12
|
+
namespace?: string;
|
|
13
|
+
sortMembersAlphabetically?: boolean;
|
|
14
|
+
defaultGroupName: string;
|
|
15
|
+
referenceGuideTemplate: string;
|
|
16
|
+
};
|
|
17
|
+
type DocOutput = {
|
|
18
|
+
directory: string;
|
|
19
|
+
docContents: string;
|
|
20
|
+
typeName: string;
|
|
21
|
+
type: 'class' | 'interface' | 'enum';
|
|
22
|
+
};
|
|
23
|
+
export declare function generateDocs(input: string[], config?: Partial<DocumentationConfig>): E.Either<string[], DocumentationBundle>;
|
|
24
|
+
export {};
|
|
@@ -0,0 +1,267 @@
|
|
|
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
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
26
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
27
|
+
};
|
|
28
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
+
exports.documentType = void 0;
|
|
30
|
+
exports.generateDocs = generateDocs;
|
|
31
|
+
const apex_reflection_1 = require("@cparra/apex-reflection");
|
|
32
|
+
const apex_types_1 = require("../adapters/apex-types");
|
|
33
|
+
const class_template_1 = require("../transpiler/markdown/plain-markdown/class-template");
|
|
34
|
+
const enum_template_1 = require("../transpiler/markdown/plain-markdown/enum-template");
|
|
35
|
+
const interface_template_1 = require("../transpiler/markdown/plain-markdown/interface-template");
|
|
36
|
+
const E = __importStar(require("fp-ts/Either"));
|
|
37
|
+
const function_1 = require("fp-ts/function");
|
|
38
|
+
const template_1 = require("./template");
|
|
39
|
+
const manifest_1 = __importDefault(require("../model/manifest"));
|
|
40
|
+
const reference_guide_1 = require("./templates/reference-guide");
|
|
41
|
+
const documentables_1 = require("../adapters/documentables");
|
|
42
|
+
const inheritance_chain_1 = require("./inheritance-chain");
|
|
43
|
+
exports.documentType = (0, function_1.flow)(apex_types_1.typeToRenderableType, resolveApexTypeTemplate, compile);
|
|
44
|
+
const configDefaults = {
|
|
45
|
+
scope: ['public'],
|
|
46
|
+
outputDir: 'docs',
|
|
47
|
+
defaultGroupName: 'Miscellaneous',
|
|
48
|
+
referenceGuideTemplate: reference_guide_1.referenceGuideTemplate,
|
|
49
|
+
};
|
|
50
|
+
function generateDocs(input, config) {
|
|
51
|
+
const configWithDefaults = Object.assign(Object.assign({}, configDefaults), config);
|
|
52
|
+
return (0, function_1.pipe)(input, (input) => input.map(reflectSourceBody), checkForReflectionErrors, E.map((types) => filterTypesOutOfScope(types, configWithDefaults.scope)), E.map((types) => types.map((type) => addInheritedMembers(type, types))), E.map((types) => types.map((type) => addInheritanceChain(type, types))), E.map((types) => typesToRenderableBundle(types, configWithDefaults)), E.map(({ references, renderables }) => ({
|
|
53
|
+
referenceGuide: (0, function_1.pipe)(referencesToReferenceGuide(references, configWithDefaults.referenceGuideTemplate)),
|
|
54
|
+
docs: renderables.map((renderable) => renderableToOutputDoc(Object.values(references).flat(), renderable)),
|
|
55
|
+
})), E.map(({ referenceGuide, docs }) => ({ format: 'markdown', referenceGuide: referenceGuide, docs })));
|
|
56
|
+
}
|
|
57
|
+
function typesToRenderableBundle(types, config) {
|
|
58
|
+
return types.reduce((acc, type) => {
|
|
59
|
+
var _a;
|
|
60
|
+
const renderable = (0, apex_types_1.typeToRenderableType)(type, (referenceName) => {
|
|
61
|
+
return linkFromTypeNameGenerator(type, types, referenceName, config);
|
|
62
|
+
}, config.namespace);
|
|
63
|
+
acc.renderables.push(renderable);
|
|
64
|
+
const descriptionLines = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines;
|
|
65
|
+
const reference = {
|
|
66
|
+
typeName: type.name,
|
|
67
|
+
directory: getDirectoryFromRoot(config, type),
|
|
68
|
+
title: getLinkFromRoot(config, type),
|
|
69
|
+
description: (0, documentables_1.adaptDescribable)(descriptionLines, (referenceName) => getPossibleLinkFromRoot(config, referenceName, findType(types, referenceName))).description,
|
|
70
|
+
};
|
|
71
|
+
const group = getTypeGroup(type, config);
|
|
72
|
+
if (!acc.references[group]) {
|
|
73
|
+
acc.references[group] = [];
|
|
74
|
+
}
|
|
75
|
+
acc.references[group].push(reference);
|
|
76
|
+
return acc;
|
|
77
|
+
}, {
|
|
78
|
+
references: {},
|
|
79
|
+
renderables: [],
|
|
80
|
+
});
|
|
81
|
+
}
|
|
82
|
+
function renderableToOutputDoc(referenceGuideReference, renderable) {
|
|
83
|
+
function buildDocOutput(renderable, docContents) {
|
|
84
|
+
const reference = referenceGuideReference.find((ref) => ref.typeName.toLowerCase() === renderable.name.toLowerCase());
|
|
85
|
+
return {
|
|
86
|
+
directory: reference.directory,
|
|
87
|
+
docContents,
|
|
88
|
+
typeName: renderable.name,
|
|
89
|
+
type: renderable.type,
|
|
90
|
+
};
|
|
91
|
+
}
|
|
92
|
+
return (0, function_1.pipe)(renderable, resolveApexTypeTemplate, compile, (docContents) => buildDocOutput(renderable, docContents));
|
|
93
|
+
}
|
|
94
|
+
function referencesToReferenceGuide(references, template) {
|
|
95
|
+
function alphabetizeReferences(references) {
|
|
96
|
+
return Object.keys(references)
|
|
97
|
+
.sort((a, b) => a.localeCompare(b))
|
|
98
|
+
.reduce((acc, key) => {
|
|
99
|
+
acc[key] = references[key].sort((a, b) => a.title.toString().localeCompare(b.title.toString()));
|
|
100
|
+
return acc;
|
|
101
|
+
}, {});
|
|
102
|
+
}
|
|
103
|
+
return (0, function_1.pipe)(references, alphabetizeReferences, (references) => compile({
|
|
104
|
+
template: template,
|
|
105
|
+
source: references,
|
|
106
|
+
}));
|
|
107
|
+
}
|
|
108
|
+
function filterTypesOutOfScope(types, scope) {
|
|
109
|
+
return new manifest_1.default(types).filteredByAccessModifierAndAnnotations(scope);
|
|
110
|
+
}
|
|
111
|
+
function checkForReflectionErrors(reflectionResult) {
|
|
112
|
+
function reduceReflectionResultIntoSingleEither(results) {
|
|
113
|
+
return results.reduce((acc, result) => {
|
|
114
|
+
E.isLeft(result) ? acc.errors.push(result.left) : acc.types.push(result.right);
|
|
115
|
+
return acc;
|
|
116
|
+
}, {
|
|
117
|
+
errors: [],
|
|
118
|
+
types: [],
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
return (0, function_1.pipe)(reflectionResult, reduceReflectionResultIntoSingleEither, ({ errors, types }) => errors.length ? E.left(errors) : E.right(types));
|
|
122
|
+
}
|
|
123
|
+
function reflectSourceBody(input) {
|
|
124
|
+
const result = (0, apex_reflection_1.reflect)(input);
|
|
125
|
+
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
126
|
+
return result.error ? E.left(result.error.message) : E.right(result.typeMirror);
|
|
127
|
+
}
|
|
128
|
+
function resolveApexTypeTemplate(renderable) {
|
|
129
|
+
function getTemplate(renderable) {
|
|
130
|
+
switch (renderable.type) {
|
|
131
|
+
case 'enum':
|
|
132
|
+
return enum_template_1.enumMarkdownTemplate;
|
|
133
|
+
case 'interface':
|
|
134
|
+
return interface_template_1.interfaceMarkdownTemplate;
|
|
135
|
+
case 'class':
|
|
136
|
+
return class_template_1.classMarkdownTemplate;
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
return {
|
|
140
|
+
template: getTemplate(renderable),
|
|
141
|
+
source: renderable,
|
|
142
|
+
};
|
|
143
|
+
}
|
|
144
|
+
function compile(request) {
|
|
145
|
+
return template_1.Template.getInstance().compile(request);
|
|
146
|
+
}
|
|
147
|
+
function findType(repository, referenceName) {
|
|
148
|
+
return repository.find((currentType) => currentType.name.toLowerCase() === referenceName.toLowerCase());
|
|
149
|
+
}
|
|
150
|
+
function addInheritedMembers(current, repository) {
|
|
151
|
+
if (current.type_name === 'enum') {
|
|
152
|
+
return current;
|
|
153
|
+
}
|
|
154
|
+
else if (current.type_name === 'interface') {
|
|
155
|
+
return addInheritedInterfaceMethods(current, repository);
|
|
156
|
+
}
|
|
157
|
+
else {
|
|
158
|
+
return addInheritedClassMembers(current, repository);
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
function addInheritanceChain(current, repository) {
|
|
162
|
+
if (current.type_name === 'enum' || current.type_name === 'interface') {
|
|
163
|
+
return current;
|
|
164
|
+
}
|
|
165
|
+
else {
|
|
166
|
+
const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, current);
|
|
167
|
+
return Object.assign(Object.assign({}, current), { inheritanceChain });
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
function getParents(extendedNamesExtractor, current, repository) {
|
|
171
|
+
return (0, function_1.pipe)(extendedNamesExtractor(current), (interfaces) => interfaces.map((interfaceName) => repository.find((type) => type.name === interfaceName)), (interfaces = []) => interfaces.filter((type) => type !== undefined), (interfaces) => interfaces.reduce((acc, current) => [...acc, ...getParents(extendedNamesExtractor, current, repository)], interfaces));
|
|
172
|
+
}
|
|
173
|
+
function addInheritedInterfaceMethods(interfaceMirror, repository) {
|
|
174
|
+
function methodAlreadyExists(memberName, members) {
|
|
175
|
+
return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
|
|
176
|
+
}
|
|
177
|
+
function parentExtractor(interfaceMirror) {
|
|
178
|
+
return interfaceMirror.extended_interfaces;
|
|
179
|
+
}
|
|
180
|
+
const parents = getParents(parentExtractor, interfaceMirror, repository);
|
|
181
|
+
return Object.assign(Object.assign({}, interfaceMirror), { methods: parents.reduce((acc, currentValue) => [
|
|
182
|
+
...acc,
|
|
183
|
+
...currentValue.methods
|
|
184
|
+
.filter((method) => !methodAlreadyExists(method.name, acc))
|
|
185
|
+
.map((method) => (Object.assign(Object.assign({}, method), { inherited: true }))),
|
|
186
|
+
], interfaceMirror.methods) });
|
|
187
|
+
}
|
|
188
|
+
function addInheritedClassMembers(classMirror, repository) {
|
|
189
|
+
function memberAlreadyExists(memberName, members) {
|
|
190
|
+
return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
|
|
191
|
+
}
|
|
192
|
+
function parentExtractor(classMirror) {
|
|
193
|
+
return classMirror.extended_class ? [classMirror.extended_class] : [];
|
|
194
|
+
}
|
|
195
|
+
function filterMember(members, existing) {
|
|
196
|
+
return members
|
|
197
|
+
.filter((member) => member.access_modifier.toLowerCase() !== 'private')
|
|
198
|
+
.filter((member) => !memberAlreadyExists(member.name, existing))
|
|
199
|
+
.map((member) => (Object.assign(Object.assign({}, member), { inherited: true })));
|
|
200
|
+
}
|
|
201
|
+
const parents = getParents(parentExtractor, classMirror, repository);
|
|
202
|
+
return Object.assign(Object.assign({}, classMirror), { fields: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.fields, acc)], classMirror.fields), properties: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.properties, acc)], classMirror.properties), methods: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.methods, acc)], classMirror.methods) });
|
|
203
|
+
}
|
|
204
|
+
function linkFromTypeNameGenerator(typeBeingDocumented, repository, referenceName, config) {
|
|
205
|
+
const type = findType(repository, referenceName);
|
|
206
|
+
if (!type) {
|
|
207
|
+
// If the type is not found, we return the type name as a string.
|
|
208
|
+
return referenceName;
|
|
209
|
+
}
|
|
210
|
+
const [fullClassName, fileLink] = getFileLinkTuple(typeBeingDocumented, type, config);
|
|
211
|
+
return {
|
|
212
|
+
title: fullClassName,
|
|
213
|
+
url: fileLink,
|
|
214
|
+
};
|
|
215
|
+
}
|
|
216
|
+
function getFileLinkTuple(typeBeingDocumented, referencedType, config) {
|
|
217
|
+
const namespacePrefix = config.namespace ? `${config.namespace}.` : '';
|
|
218
|
+
const directoryRoot = `${getDirectoryRoot(typeBeingDocumented, referencedType, config)}`;
|
|
219
|
+
// TODO: Instead of adding a "." to the name when there is a namespace, maybe we want to create a folder for everything
|
|
220
|
+
// within that namespace and put the files in there.
|
|
221
|
+
const fullClassName = `${namespacePrefix}${referencedType.name}`;
|
|
222
|
+
return [fullClassName, `${directoryRoot}${fullClassName}.md`];
|
|
223
|
+
}
|
|
224
|
+
function getDirectoryFromRoot(config, type) {
|
|
225
|
+
if (!type) {
|
|
226
|
+
return '';
|
|
227
|
+
}
|
|
228
|
+
return `./${getSanitizedGroup(type, config)}`;
|
|
229
|
+
}
|
|
230
|
+
function getPossibleLinkFromRoot(config, fallback, type) {
|
|
231
|
+
if (!type) {
|
|
232
|
+
return fallback;
|
|
233
|
+
}
|
|
234
|
+
const namespacePrefix = config.namespace ? `${config.namespace}.` : '';
|
|
235
|
+
const title = `${namespacePrefix}${type.name}`;
|
|
236
|
+
return {
|
|
237
|
+
title: title,
|
|
238
|
+
url: `${getDirectoryFromRoot(config, type)}/${title}.md`,
|
|
239
|
+
};
|
|
240
|
+
}
|
|
241
|
+
function getLinkFromRoot(config, type) {
|
|
242
|
+
const namespacePrefix = config.namespace ? `${config.namespace}.` : '';
|
|
243
|
+
const title = `${namespacePrefix}${type.name}`;
|
|
244
|
+
return {
|
|
245
|
+
title: title,
|
|
246
|
+
url: `${getDirectoryFromRoot(config, type)}/${title}.md`,
|
|
247
|
+
};
|
|
248
|
+
}
|
|
249
|
+
function getDirectoryRoot(typeBeingDocumented, referencedType, config) {
|
|
250
|
+
if (getTypeGroup(typeBeingDocumented, config) === getTypeGroup(referencedType, config)) {
|
|
251
|
+
// If the types the same groups then we simply link directly to that file
|
|
252
|
+
return './';
|
|
253
|
+
}
|
|
254
|
+
else {
|
|
255
|
+
// If the types have different groups, then we have to go up a directory
|
|
256
|
+
return `../${getSanitizedGroup(referencedType, config)}/`;
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
function getTypeGroup(type, config) {
|
|
260
|
+
var _a, _b;
|
|
261
|
+
const groupAnnotation = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === 'group');
|
|
262
|
+
return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : config.defaultGroupName;
|
|
263
|
+
}
|
|
264
|
+
function getSanitizedGroup(classModel, config) {
|
|
265
|
+
return getTypeGroup(classModel, config).replace(/ /g, '-').replace('.', '');
|
|
266
|
+
}
|
|
267
|
+
//# sourceMappingURL=generate-docs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate-docs.js","sourceRoot":"","sources":["../../src/core/generate-docs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CA,oCAmBC;AAhED,6DAA0G;AAC1G,uDAA8D;AAE9D,yFAA6F;AAC7F,uFAA2F;AAC3F,iGAAqG;AACrG,gDAAkC;AAClC,6CAA4C;AAC5C,yCAA0D;AAC1D,iEAAyC;AACzC,iEAAqE;AACrE,6DAA6D;AAC7D,2DAA6D;AAEhD,QAAA,YAAY,GAAG,IAAA,eAAI,EAAC,iCAAoB,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC;AAwBzF,MAAM,cAAc,GAAwB;IAC1C,KAAK,EAAE,CAAC,QAAQ,CAAC;IACjB,SAAS,EAAE,MAAM;IACjB,gBAAgB,EAAE,eAAe;IACjC,sBAAsB,EAAE,wCAAsB;CAC/C,CAAC;AAEF,SAAgB,YAAY,CAC1B,KAAe,EACf,MAAqC;IAErC,MAAM,kBAAkB,mCAAQ,cAAc,GAAK,MAAM,CAAE,CAAC;IAC5D,OAAO,IAAA,eAAI,EACT,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC,EACvC,wBAAwB,EACxB,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC,EACxE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACvE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACvE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAuB,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,EACpE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,cAAc,EAAE,IAAA,eAAI,EAAC,0BAA0B,CAAC,UAAU,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;QACvG,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE,UAAU,CAAC,CAAC;KAC3G,CAAC,CAAC,EACH,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CACpG,CAAC;AACJ,CAAC;AAiBD,SAAS,uBAAuB,CAAC,KAAa,EAAE,MAA2B;IACzE,OAAO,KAAK,CAAC,MAAM,CACjB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;;QACZ,MAAM,UAAU,GAAG,IAAA,iCAAoB,EACrC,IAAI,EACJ,CAAC,aAAa,EAAE,EAAE;YAChB,OAAO,yBAAyB,CAAC,IAAI,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;QACvE,CAAC,EACD,MAAM,CAAC,SAAS,CACjB,CAAC;QACF,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjC,MAAM,gBAAgB,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,gBAAgB,CAAC;QAC3D,MAAM,SAAS,GAAG;YAChB,QAAQ,EAAE,IAAI,CAAC,IAAI;YACnB,SAAS,EAAE,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC;YAC7C,KAAK,EAAE,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;YACpC,WAAW,EAAE,IAAA,gCAAgB,EAAC,gBAAgB,EAAE,CAAC,aAAa,EAAE,EAAE,CAChE,uBAAuB,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAC/E,CAAC,WAAW;SACd,CAAC;QAEF,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC7B,CAAC;QACD,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtC,OAAO,GAAG,CAAC;IACb,CAAC,EACD;QACE,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,EAAE;KAChB,CACF,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,uBAAkD,EAAE,UAAsB;IACvG,SAAS,cAAc,CAAC,UAAsB,EAAE,WAAmB;QACjE,MAAM,SAAS,GAAG,uBAAuB,CAAC,IAAI,CAC5C,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CACtE,CAAC;QACF,OAAO;YACL,SAAS,EAAE,SAAU,CAAC,SAAS;YAC/B,WAAW;YACX,QAAQ,EAAE,UAAU,CAAC,IAAI;YACzB,IAAI,EAAE,UAAU,CAAC,IAAI;SACtB,CAAC;IACJ,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,UAAU,EAAE,uBAAuB,EAAE,OAAO,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;AACtH,CAAC;AAED,SAAS,0BAA0B,CACjC,UAAwD,EACxD,QAAgB;IAEhB,SAAS,qBAAqB,CAAC,UAAwD;QAGrF,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;aAC3B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;aAClC,MAAM,CAA+C,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACjE,GAAG,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAChG,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,UAAU,EAAE,qBAAqB,EAAE,CAAC,UAAU,EAAE,EAAE,CAC5D,OAAO,CAAC;QACN,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,UAAU;KACnB,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAa,EAAE,KAAe;IAC3D,OAAO,IAAI,kBAAQ,CAAC,KAAK,CAAC,CAAC,sCAAsC,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,wBAAwB,CAAC,gBAA0C;IAC1E,SAAS,sCAAsC,CAAC,OAAiC;QAI/E,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACd,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC/E,OAAO,GAAG,CAAC;QACb,CAAC,EACD;YACE,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,EAAE;SACV,CACF,CAAC;IACJ,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,gBAAgB,EAAE,sCAAsC,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAC1F,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAa;IACtC,MAAM,MAAM,GAAG,IAAA,yBAAgB,EAAC,KAAK,CAAC,CAAC;IACvC,oEAAoE;IACpE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,UAAW,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,uBAAuB,CAAC,UAAsB;IACrD,SAAS,WAAW,CAAC,UAAsB;QACzC,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;YACxB,KAAK,MAAM;gBACT,OAAO,oCAAoB,CAAC;YAC9B,KAAK,WAAW;gBACd,OAAO,8CAAyB,CAAC;YACnC,KAAK,OAAO;gBACV,OAAO,sCAAqB,CAAC;QACjC,CAAC;IACH,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC;QACjC,MAAM,EAAE,UAA4B;KACrC,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,OAA2B;IAC1C,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,QAAQ,CAAC,UAAkB,EAAE,aAAqB;IACzD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;AAChH,CAAC;AAED,SAAS,mBAAmB,CAAiB,OAAU,EAAE,UAAkB;IACzE,IAAI,OAAO,CAAC,SAAS,KAAK,MAAM,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC;IACjB,CAAC;SAAM,IAAI,OAAO,CAAC,SAAS,KAAK,WAAW,EAAE,CAAC;QAC7C,OAAO,4BAA4B,CAAC,OAA0B,EAAE,UAAU,CAAM,CAAC;IACnF,CAAC;SAAM,CAAC;QACN,OAAO,wBAAwB,CAAC,OAAsB,EAAE,UAAU,CAAM,CAAC;IAC3E,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAAiB,OAAU,EAAE,UAAkB;IACzE,IAAI,OAAO,CAAC,SAAS,KAAK,MAAM,IAAI,OAAO,CAAC,SAAS,KAAK,WAAW,EAAE,CAAC;QACtE,OAAO,OAAO,CAAC;IACjB,CAAC;SAAM,CAAC;QACN,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,OAAsB,CAAC,CAAC;QACpF,uCACK,OAAO,KACV,gBAAgB,IAChB;IACJ,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CACjB,sBAAgD,EAChD,OAAU,EACV,UAAkB;IAElB,OAAO,IAAA,eAAI,EACT,sBAAsB,CAAC,OAAO,CAAC,EAC/B,CAAC,UAAoB,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC,EACnH,CAAC,UAAU,GAAG,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAQ,EAC3E,CAAC,UAAU,EAAE,EAAE,CACb,UAAU,CAAC,MAAM,CACf,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,UAAU,CAAC,sBAAsB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,EACtF,UAAU,CACX,CACJ,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CAAC,eAAgC,EAAE,UAAkB;IACxF,SAAS,mBAAmB,CAAC,UAAkB,EAAE,OAA2B;QAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,SAAS,eAAe,CAAC,eAAgC;QACvD,OAAO,eAAe,CAAC,mBAAmB,CAAC;IAC7C,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;IACzE,uCACK,eAAe,KAClB,OAAO,EAAE,OAAO,CAAC,MAAM,CACrB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC;YACrB,GAAG,GAAG;YACN,GAAG,YAAY,CAAC,OAAO;iBACpB,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;iBAC1D,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACZ,MAAM,KACT,SAAS,EAAE,IAAI,IACf,CAAC;SACN,EACD,eAAe,CAAC,OAAO,CACxB,IACD;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,WAAwB,EAAE,UAAkB;IAC5E,SAAS,mBAAmB,CAAC,UAAkB,EAAE,OAA2B;QAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,SAAS,eAAe,CAAC,WAAwB;QAC/C,OAAO,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,CAAC;IAED,SAAS,YAAY,CAAsD,OAAY,EAAE,QAAa;QACpG,OAAO,OAAO;aACX,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC;aACtE,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;aAC/D,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACZ,MAAM,KACT,SAAS,EAAE,IAAI,IACf,CAAC,CAAC;IACR,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;IACrE,uCACK,WAAW,KACd,MAAM,EAAE,OAAO,CAAC,MAAM,CACpB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAC1E,WAAW,CAAC,MAAM,CACnB,EACD,UAAU,EAAE,OAAO,CAAC,MAAM,CACxB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,EAC9E,WAAW,CAAC,UAAU,CACvB,EACD,OAAO,EAAE,OAAO,CAAC,MAAM,CACrB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,EAC3E,WAAW,CAAC,OAAO,CACpB,IACD;AACJ,CAAC;AAED,SAAS,yBAAyB,CAChC,mBAAyB,EACzB,UAAkB,EAClB,aAAqB,EACrB,MAA2B;IAE3B,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;IACjD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,iEAAiE;QACjE,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,gBAAgB,CAAC,mBAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACtF,OAAO;QACL,KAAK,EAAE,aAAa;QACpB,GAAG,EAAE,QAAQ;KACd,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CACvB,mBAAyB,EACzB,cAAoB,EACpB,MAA2B;IAE3B,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,MAAM,aAAa,GAAG,GAAG,gBAAgB,CAAC,mBAAmB,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,CAAC;IACzF,uHAAuH;IACvH,oDAAoD;IACpD,MAAM,aAAa,GAAG,GAAG,eAAe,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC;IACjE,OAAO,CAAC,aAAa,EAAE,GAAG,aAAa,GAAG,aAAa,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,oBAAoB,CAAC,MAA2B,EAAE,IAAW;IACpE,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,KAAK,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;AAChD,CAAC;AAED,SAAS,uBAAuB,CAAC,MAA2B,EAAE,QAAgB,EAAE,IAAW;IACzF,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,MAAM,KAAK,GAAG,GAAG,eAAe,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC/C,OAAO;QACL,KAAK,EAAE,KAAK;QACZ,GAAG,EAAE,GAAG,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,KAAK,KAAK;KACzD,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,MAA2B,EAAE,IAAU;IAC9D,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,MAAM,KAAK,GAAG,GAAG,eAAe,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC/C,OAAO;QACL,KAAK,EAAE,KAAK;QACZ,GAAG,EAAE,GAAG,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,KAAK,KAAK;KACzD,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,mBAAyB,EAAE,cAAoB,EAAE,MAA2B;IACpG,IAAI,YAAY,CAAC,mBAAmB,EAAE,MAAM,CAAC,KAAK,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,CAAC;QACvF,yEAAyE;QACzE,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,CAAC;QACN,wEAAwE;QACxE,OAAO,MAAM,iBAAiB,CAAC,cAAc,EAAE,MAAM,CAAC,GAAG,CAAC;IAC5D,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAU,EAAE,MAA2B;;IAC3D,MAAM,eAAe,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,CAAC;IACrH,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,MAAM,CAAC,gBAAgB,CAAC;AAC1D,CAAC;AAED,SAAS,iBAAiB,CAAC,UAAgB,EAAE,MAA2B;IACtE,OAAO,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AAC9E,CAAC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
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.createInheritanceChain = createInheritanceChain;
|
|
27
|
+
const function_1 = require("fp-ts/function");
|
|
28
|
+
const O = __importStar(require("fp-ts/Option"));
|
|
29
|
+
function createInheritanceChain(repository, classMirror) {
|
|
30
|
+
return (0, function_1.pipe)(O.fromNullable(classMirror.extended_class), O.match(() => [], (extendedClassName) => inheritanceChainFromParentClassName(repository, extendedClassName)));
|
|
31
|
+
}
|
|
32
|
+
function inheritanceChainFromParentClassName(repository, className) {
|
|
33
|
+
return (0, function_1.pipe)(O.fromNullable(repository.find((type) => type.name.toLowerCase() === className.toLowerCase())), O.match(() => [className], (extendedClass) => [className, ...createInheritanceChain(repository, extendedClass)]));
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=inheritance-chain.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"inheritance-chain.js","sourceRoot":"","sources":["../../src/core/inheritance-chain.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAIA,wDAQC;AAXD,6CAAsC;AACtC,gDAAkC;AAElC,SAAgB,sBAAsB,CAAC,UAAkB,EAAE,WAAwB;IACjF,OAAO,IAAA,eAAI,EACT,CAAC,CAAC,YAAY,CAAC,WAAW,CAAC,cAAc,CAAC,EAC1C,CAAC,CAAC,KAAK,CACL,GAAG,EAAE,CAAC,EAAE,EACR,CAAC,iBAAiB,EAAE,EAAE,CAAC,mCAAmC,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAC1F,CACF,CAAC;AACJ,CAAC;AAED,SAAS,mCAAmC,CAAC,UAAkB,EAAE,SAAiB;IAChF,OAAO,IAAA,eAAI,EACT,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,EAC9F,CAAC,CAAC,KAAK,CACL,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC,EACjB,CAAC,aAAmB,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,GAAG,sBAAsB,CAAC,UAAU,EAAE,aAA4B,CAAC,CAAC,CAC1G,CACF,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.Template = void 0;
|
|
7
|
+
const handlebars_1 = __importDefault(require("handlebars"));
|
|
8
|
+
const type_doc_partial_1 = require("../transpiler/markdown/plain-markdown/type-doc-partial");
|
|
9
|
+
const documentable_partial_template_1 = require("../transpiler/markdown/plain-markdown/documentable-partial-template");
|
|
10
|
+
const methods_partial_template_1 = require("../transpiler/markdown/plain-markdown/methods-partial-template");
|
|
11
|
+
const constructors_partial_template_1 = require("../transpiler/markdown/plain-markdown/constructors-partial-template");
|
|
12
|
+
const fieldsPartialTemplate_1 = require("../transpiler/markdown/plain-markdown/fieldsPartialTemplate");
|
|
13
|
+
const class_template_1 = require("../transpiler/markdown/plain-markdown/class-template");
|
|
14
|
+
const enum_template_1 = require("../transpiler/markdown/plain-markdown/enum-template");
|
|
15
|
+
const interface_template_1 = require("../transpiler/markdown/plain-markdown/interface-template");
|
|
16
|
+
const type_utils_1 = require("../adapters/type-utils");
|
|
17
|
+
const grouped_members_partial_template_1 = require("../transpiler/markdown/plain-markdown/grouped-members-partial-template");
|
|
18
|
+
class Template {
|
|
19
|
+
constructor() {
|
|
20
|
+
handlebars_1.default.registerPartial('typeDocumentation', type_doc_partial_1.typeDocPartial);
|
|
21
|
+
handlebars_1.default.registerPartial('documentablePartialTemplate', documentable_partial_template_1.documentablePartialTemplate);
|
|
22
|
+
handlebars_1.default.registerPartial('methodsPartialTemplate', methods_partial_template_1.methodsPartialTemplate);
|
|
23
|
+
handlebars_1.default.registerPartial('constructorsPartialTemplate', constructors_partial_template_1.constructorsPartialTemplate);
|
|
24
|
+
handlebars_1.default.registerPartial('groupedMembersPartialTemplate', grouped_members_partial_template_1.groupedMembersPartialTemplate);
|
|
25
|
+
handlebars_1.default.registerPartial('fieldsPartialTemplate', fieldsPartialTemplate_1.fieldsPartialTemplate);
|
|
26
|
+
handlebars_1.default.registerPartial('classTemplate', class_template_1.classMarkdownTemplate);
|
|
27
|
+
handlebars_1.default.registerPartial('enumTemplate', enum_template_1.enumMarkdownTemplate);
|
|
28
|
+
handlebars_1.default.registerPartial('interfaceTemplate', interface_template_1.interfaceMarkdownTemplate);
|
|
29
|
+
handlebars_1.default.registerHelper('link', link);
|
|
30
|
+
handlebars_1.default.registerHelper('code', convertCodeBlock);
|
|
31
|
+
handlebars_1.default.registerHelper('withLinks', resolveLinksInContent);
|
|
32
|
+
handlebars_1.default.registerHelper('heading', heading);
|
|
33
|
+
handlebars_1.default.registerHelper('inlineCode', inlineCode);
|
|
34
|
+
handlebars_1.default.registerHelper('splitAndCapitalize', splitAndCapitalize);
|
|
35
|
+
}
|
|
36
|
+
static getInstance() {
|
|
37
|
+
if (!Template.instance) {
|
|
38
|
+
Template.instance = new Template();
|
|
39
|
+
}
|
|
40
|
+
return Template.instance;
|
|
41
|
+
}
|
|
42
|
+
compile(request) {
|
|
43
|
+
const compiled = handlebars_1.default.compile(request.template);
|
|
44
|
+
return (compiled(request.source)
|
|
45
|
+
.trim()
|
|
46
|
+
// clean up extra newlines
|
|
47
|
+
.replace(/\n{3,}/g, '\n\n'));
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
exports.Template = Template;
|
|
51
|
+
const splitAndCapitalize = (text) => {
|
|
52
|
+
const words = text.split(/[-_]+/);
|
|
53
|
+
const capitalizedWords = [];
|
|
54
|
+
for (const word of words) {
|
|
55
|
+
capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
|
|
56
|
+
}
|
|
57
|
+
return capitalizedWords.join(' ');
|
|
58
|
+
};
|
|
59
|
+
const heading = (level, text) => {
|
|
60
|
+
return `${'#'.repeat(level)} ${text}`;
|
|
61
|
+
};
|
|
62
|
+
const inlineCode = (text) => {
|
|
63
|
+
return new handlebars_1.default.SafeString(`\`${text}\``);
|
|
64
|
+
};
|
|
65
|
+
const convertCodeBlock = (language, lines) => {
|
|
66
|
+
return new handlebars_1.default.SafeString(`
|
|
67
|
+
\`\`\`${language}
|
|
68
|
+
${lines.join('\n')}
|
|
69
|
+
\`\`\`
|
|
70
|
+
`.trim());
|
|
71
|
+
};
|
|
72
|
+
const resolveLinksInContent = (description) => {
|
|
73
|
+
if (!description) {
|
|
74
|
+
return '';
|
|
75
|
+
}
|
|
76
|
+
function reduceDescription(acc, curr) {
|
|
77
|
+
if ((0, type_utils_1.isEmptyLine)(curr)) {
|
|
78
|
+
return acc + '\n\n';
|
|
79
|
+
}
|
|
80
|
+
return acc + link(curr).trim() + ' ';
|
|
81
|
+
}
|
|
82
|
+
return description.reduce(reduceDescription, '').trim();
|
|
83
|
+
};
|
|
84
|
+
const link = (source) => {
|
|
85
|
+
if (typeof source === 'string') {
|
|
86
|
+
return source;
|
|
87
|
+
}
|
|
88
|
+
else {
|
|
89
|
+
return `[${source.title}](${source.url})`;
|
|
90
|
+
}
|
|
91
|
+
};
|
|
92
|
+
//# sourceMappingURL=template.js.map
|