@cparra/apexdocs 2.24.0 → 2.25.0-alpha.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/ci.yaml +22 -0
- package/.github/workflows/close_stale.yml +22 -22
- package/.prettierrc.js +7 -7
- package/LICENSE +21 -21
- package/README.md +742 -718
- package/apexdocs.config.ts +13 -13
- package/docs/{README.md → __old/README.md} +1 -1
- package/docs/{restapi.json → __old/restapi.json} +589 -589
- package/docs/{types → __old/types}/Classes/nspc.ChildClass.md +97 -97
- package/docs/{types → __old/types}/Main/nspc.SampleClass.md +189 -189
- package/examples/force-app/main/default/classes/AnotherInterface.cls +16 -16
- package/examples/force-app/main/default/classes/ChildClass.cls +42 -42
- 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/examples/plain-markdown/.forceignore +12 -0
- package/examples/plain-markdown/README.md +301 -0
- package/examples/plain-markdown/config/project-scratch-def.json +5 -0
- package/examples/plain-markdown/force-app/classes/BaseClass.cls +3 -0
- package/examples/plain-markdown/force-app/classes/ParentInterface.cls +3 -0
- package/examples/plain-markdown/force-app/classes/ReferencedEnum.cls +3 -0
- package/examples/plain-markdown/force-app/classes/SampleClass.cls +35 -0
- package/examples/plain-markdown/force-app/classes/SampleEnum.cls +30 -0
- package/examples/plain-markdown/force-app/classes/SampleException.cls +1 -0
- package/examples/plain-markdown/force-app/classes/SampleInterface.cls +46 -0
- package/examples/plain-markdown/package-lock.json +665 -0
- package/examples/plain-markdown/package.json +24 -0
- package/examples/plain-markdown/sfdx-project.json +12 -0
- package/examples/plain-markdown/template.md +3 -0
- package/jest.config.js +5 -5
- package/lib/adapters/apex-types.d.ts +5 -0
- package/lib/adapters/apex-types.js +34 -0
- package/lib/adapters/apex-types.js.map +1 -0
- package/lib/adapters/documentables.d.ts +6 -0
- package/lib/adapters/documentables.js +41 -0
- package/lib/adapters/documentables.js.map +1 -0
- package/lib/adapters/fields-and-properties.d.ts +3 -0
- package/lib/adapters/fields-and-properties.js +10 -0
- package/lib/adapters/fields-and-properties.js.map +1 -0
- package/lib/adapters/methods-and-constructors.d.ts +4 -0
- package/lib/adapters/methods-and-constructors.js +49 -0
- package/lib/adapters/methods-and-constructors.js.map +1 -0
- package/lib/adapters/references.d.ts +5 -0
- package/lib/adapters/references.js +82 -0
- package/lib/adapters/references.js.map +1 -0
- package/lib/adapters/type-utils.d.ts +2 -0
- package/lib/adapters/type-utils.js +8 -0
- package/lib/adapters/type-utils.js.map +1 -0
- package/lib/application/Apexdocs.d.ts +13 -13
- package/lib/application/Apexdocs.js +79 -76
- package/lib/application/Apexdocs.js.map +1 -1
- package/lib/cli/generate.d.ts +2 -2
- package/lib/cli/generate.js +156 -130
- 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.d.ts +22 -22
- package/lib/model/manifest.js +46 -46
- package/lib/model/manifest.js.map +1 -1
- package/lib/model/markdown-file.d.ts +16 -16
- package/lib/model/markdown-file.js +109 -106
- package/lib/model/markdown-file.js.map +1 -1
- 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 +46 -43
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -1
- package/lib/model/markdown-generation-util/field-declaration-util.d.ts +3 -3
- package/lib/model/markdown-generation-util/field-declaration-util.js +54 -54
- 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 +56 -53
- package/lib/model/markdown-home-file.js.map +1 -1
- package/lib/model/markdown-type-file.d.ts +26 -26
- package/lib/model/markdown-type-file.js +136 -133
- 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 +48 -45
- package/lib/service/apex-file-reader.js.map +1 -1
- package/lib/service/file-system.d.ts +14 -14
- package/lib/service/file-system.js +47 -24
- package/lib/service/file-system.js.map +1 -1
- package/lib/service/file-writer.d.ts +6 -6
- package/lib/service/file-writer.js +56 -33
- package/lib/service/file-writer.js.map +1 -1
- package/lib/service/manifest-factory.d.ts +10 -10
- package/lib/service/manifest-factory.js +16 -13
- package/lib/service/manifest-factory.js.map +1 -1
- 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 +137 -134
- package/lib/service/parser.js.map +1 -1
- 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/enum-walker.d.ts +4 -4
- package/lib/service/walkers/enum-walker.js +10 -10
- package/lib/service/walkers/interface-walker.d.ts +4 -4
- package/lib/service/walkers/interface-walker.js +14 -14
- 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 -19
- package/lib/service/walkers/walker.js +16 -16
- package/lib/settings.d.ts +70 -64
- package/lib/settings.js +99 -88
- package/lib/settings.js.map +1 -1
- package/lib/templating/compile.d.ts +7 -0
- package/lib/templating/compile.js +98 -0
- package/lib/templating/compile.js.map +1 -0
- package/lib/templating/helpers.d.ts +2 -0
- package/lib/templating/helpers.js +18 -0
- package/lib/templating/helpers.js.map +1 -0
- 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/InterfaceMirrorBuilder.d.ts +16 -0
- package/lib/test-helpers/InterfaceMirrorBuilder.js +43 -0
- package/lib/test-helpers/InterfaceMirrorBuilder.js.map +1 -0
- package/lib/test-helpers/MethodMirrorBuilder.d.ts +29 -10
- package/lib/test-helpers/MethodMirrorBuilder.js +71 -36
- package/lib/test-helpers/MethodMirrorBuilder.js.map +1 -1
- 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 +34 -31
- package/lib/transpiler/factory.js.map +1 -1
- 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 +11 -8
- package/lib/transpiler/markdown/class-file-generatorHelper.js +74 -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 -11
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +50 -50
- package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +11 -11
- package/lib/transpiler/markdown/markdown-transpiler-base.js +26 -23
- package/lib/transpiler/markdown/markdown-transpiler-base.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/class-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/class-template.js +36 -0
- package/lib/transpiler/markdown/plain-markdown/class-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js +39 -0
- package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js +25 -0
- package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/enum-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/enum-template.js +15 -0
- package/lib/transpiler/markdown/plain-markdown/enum-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +24 -0
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/interface-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/interface-template.js +20 -0
- package/lib/transpiler/markdown/plain-markdown/interface-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js +49 -0
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +13 -6
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +121 -13
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js +31 -0
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js.map +1 -0
- package/lib/transpiler/openapi/open-api-docs-processor.d.ts +13 -13
- package/lib/transpiler/openapi/open-api-docs-processor.js +77 -74
- package/lib/transpiler/openapi/open-api-docs-processor.js.map +1 -1
- package/lib/transpiler/openapi/parsers/Builder.d.ts +16 -16
- package/lib/transpiler/openapi/parsers/Builder.js +29 -29
- package/lib/transpiler/openapi/parsers/Builder.js.map +1 -1
- package/lib/transpiler/openapi/parsers/MethodParser.d.ts +20 -20
- package/lib/transpiler/openapi/parsers/MethodParser.js +189 -166
- package/lib/transpiler/openapi/parsers/MethodParser.js.map +1 -1
- 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 +248 -225
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +1 -1
- 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 +29 -26
- package/lib/transpiler/transpiler.js.map +1 -1
- package/lib/util/error-logger.d.ts +8 -8
- package/lib/util/error-logger.js +89 -89
- package/lib/util/error-logger.js.map +1 -1
- package/lib/util/logger.d.ts +21 -21
- package/lib/util/logger.js +60 -57
- package/lib/util/logger.js.map +1 -1
- package/lib/util/string-utils.d.ts +2 -2
- package/lib/util/string-utils.js +14 -14
- package/package.json +79 -78
- package/src/adapters/__tests__/interface-adapter.spec.ts +76 -0
- package/src/adapters/__tests__/references.spec.ts +115 -0
- package/src/adapters/apex-types.ts +67 -0
- package/src/adapters/documentables.ts +58 -0
- package/src/adapters/fields-and-properties.ts +14 -0
- package/src/adapters/methods-and-constructors.ts +78 -0
- package/src/adapters/references.ts +113 -0
- package/src/adapters/type-utils.ts +5 -0
- package/src/adapters/types.d.ts +8 -0
- package/src/cli/generate.ts +3 -0
- package/src/model/__tests__/manifest.spec.ts +1 -0
- package/src/model/manifest.ts +3 -3
- package/src/model/markdown-file.ts +1 -1
- package/src/model/openapi/open-api-types.ts +2 -2
- package/src/service/__tests__/apex-file-reader.spec.ts +4 -4
- package/src/service/__tests__/manifest-factory.spec.ts +1 -2
- package/src/settings.ts +15 -0
- package/src/templating/__tests__/compile.spec.ts +741 -0
- package/src/templating/compile.ts +187 -0
- package/src/templating/helpers.ts +14 -0
- package/src/templating/types.d.ts +104 -0
- package/src/test-helpers/FieldMirrorBuilder.ts +1 -1
- package/src/test-helpers/InterfaceMirrorBuilder.ts +44 -0
- package/src/test-helpers/MethodMirrorBuilder.ts +46 -6
- package/src/transpiler/markdown/class-file-generatorHelper.ts +22 -2
- package/src/transpiler/markdown/plain-markdown/class-template.ts +32 -0
- package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +35 -0
- package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +21 -0
- package/src/transpiler/markdown/plain-markdown/enum-template.ts +11 -0
- package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +20 -0
- package/src/transpiler/markdown/plain-markdown/interface-template.ts +16 -0
- package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +45 -0
- package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +122 -0
- package/src/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.ts +27 -0
- package/src/transpiler/openapi/parsers/Builder.ts +1 -1
- package/src/transpiler/openapi/parsers/MethodParser.ts +1 -1
- package/src/transpiler/openapi/parsers/ReferenceBuilder.ts +1 -1
- package/src/util/error-logger.ts +4 -4
- package/src/util/logger.ts +3 -3
- package/tsconfig.json +21 -20
- package/tslint.json +5 -5
- package/lib/model/manifest-diff.d.ts +0 -27
- package/lib/model/manifest-diff.js +0 -69
- package/lib/model/manifest-diff.js.map +0 -1
- package/src/model/__tests__/manifest-diff.spec.ts +0 -139
- package/src/model/manifest-diff.ts +0 -94
- /package/docs/{index.html → __old/index.html} +0 -0
- /package/docs/{types → __old/types}/Classes/nspc.AnotherInterface.md +0 -0
- /package/docs/{types → __old/types}/Main/nspc.GroupedClass.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.EscapedAnnotations.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.GrandparentClass.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.InterfaceWithInheritance.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.MemberGrouping.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.ParentClass.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference1.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference2.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference3.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference4.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference5.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference6.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference7.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResource.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -0
- /package/docs/{types → __old/types}/README.md +0 -0
- /package/docs/{types → __old/types}/Sample-Interfaces/nspc.SampleInterface.md +0 -0
|
@@ -1,33 +1,33 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ClassWalker = void 0;
|
|
4
|
-
const walker_1 = require("./walker");
|
|
5
|
-
class ClassWalker extends walker_1.Walker {
|
|
6
|
-
walk(listener) {
|
|
7
|
-
listener.onTypeDeclaration(this.type);
|
|
8
|
-
const classMirror = this.type;
|
|
9
|
-
if (classMirror.constructors.length) {
|
|
10
|
-
listener.onConstructorDeclaration(this.type.name, classMirror.constructors);
|
|
11
|
-
}
|
|
12
|
-
if (classMirror.fields.length) {
|
|
13
|
-
listener.onFieldsDeclaration(this.sortType(classMirror.fields));
|
|
14
|
-
}
|
|
15
|
-
if (classMirror.properties.length) {
|
|
16
|
-
listener.onPropertiesDeclaration(this.sortType(classMirror.properties));
|
|
17
|
-
}
|
|
18
|
-
if (classMirror.methods.length) {
|
|
19
|
-
listener.onMethodsDeclaration(this.sortType(classMirror.methods));
|
|
20
|
-
}
|
|
21
|
-
if (classMirror.enums.length) {
|
|
22
|
-
listener.onInnerEnumsDeclaration(this.sortType(classMirror.enums));
|
|
23
|
-
}
|
|
24
|
-
if (classMirror.classes.length) {
|
|
25
|
-
listener.onInnerClassesDeclaration(this.sortType(classMirror.classes));
|
|
26
|
-
}
|
|
27
|
-
if (classMirror.interfaces.length) {
|
|
28
|
-
listener.onInnerInterfacesDeclaration(this.sortType(classMirror.interfaces));
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
exports.ClassWalker = ClassWalker;
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ClassWalker = void 0;
|
|
4
|
+
const walker_1 = require("./walker");
|
|
5
|
+
class ClassWalker extends walker_1.Walker {
|
|
6
|
+
walk(listener) {
|
|
7
|
+
listener.onTypeDeclaration(this.type);
|
|
8
|
+
const classMirror = this.type;
|
|
9
|
+
if (classMirror.constructors.length) {
|
|
10
|
+
listener.onConstructorDeclaration(this.type.name, classMirror.constructors);
|
|
11
|
+
}
|
|
12
|
+
if (classMirror.fields.length) {
|
|
13
|
+
listener.onFieldsDeclaration(this.sortType(classMirror.fields));
|
|
14
|
+
}
|
|
15
|
+
if (classMirror.properties.length) {
|
|
16
|
+
listener.onPropertiesDeclaration(this.sortType(classMirror.properties));
|
|
17
|
+
}
|
|
18
|
+
if (classMirror.methods.length) {
|
|
19
|
+
listener.onMethodsDeclaration(this.sortType(classMirror.methods));
|
|
20
|
+
}
|
|
21
|
+
if (classMirror.enums.length) {
|
|
22
|
+
listener.onInnerEnumsDeclaration(this.sortType(classMirror.enums));
|
|
23
|
+
}
|
|
24
|
+
if (classMirror.classes.length) {
|
|
25
|
+
listener.onInnerClassesDeclaration(this.sortType(classMirror.classes));
|
|
26
|
+
}
|
|
27
|
+
if (classMirror.interfaces.length) {
|
|
28
|
+
listener.onInnerInterfacesDeclaration(this.sortType(classMirror.interfaces));
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
exports.ClassWalker = ClassWalker;
|
|
33
33
|
//# sourceMappingURL=class-walker.js.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Walker, WalkerListener } from './walker';
|
|
2
|
-
export declare class EnumWalker extends Walker {
|
|
3
|
-
walk(listener: WalkerListener): void;
|
|
4
|
-
}
|
|
1
|
+
import { Walker, WalkerListener } from './walker';
|
|
2
|
+
export declare class EnumWalker extends Walker {
|
|
3
|
+
walk(listener: WalkerListener): void;
|
|
4
|
+
}
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.EnumWalker = void 0;
|
|
4
|
-
const walker_1 = require("./walker");
|
|
5
|
-
class EnumWalker extends walker_1.Walker {
|
|
6
|
-
walk(listener) {
|
|
7
|
-
listener.onTypeDeclaration(this.type);
|
|
8
|
-
}
|
|
9
|
-
}
|
|
10
|
-
exports.EnumWalker = EnumWalker;
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.EnumWalker = void 0;
|
|
4
|
+
const walker_1 = require("./walker");
|
|
5
|
+
class EnumWalker extends walker_1.Walker {
|
|
6
|
+
walk(listener) {
|
|
7
|
+
listener.onTypeDeclaration(this.type);
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
exports.EnumWalker = EnumWalker;
|
|
11
11
|
//# sourceMappingURL=enum-walker.js.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Walker, WalkerListener } from './walker';
|
|
2
|
-
export declare class InterfaceWalker extends Walker {
|
|
3
|
-
walk(listener: WalkerListener): void;
|
|
4
|
-
}
|
|
1
|
+
import { Walker, WalkerListener } from './walker';
|
|
2
|
+
export declare class InterfaceWalker extends Walker {
|
|
3
|
+
walk(listener: WalkerListener): void;
|
|
4
|
+
}
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.InterfaceWalker = void 0;
|
|
4
|
-
const walker_1 = require("./walker");
|
|
5
|
-
class InterfaceWalker extends walker_1.Walker {
|
|
6
|
-
walk(listener) {
|
|
7
|
-
listener.onTypeDeclaration(this.type);
|
|
8
|
-
const interfaceMirror = this.type;
|
|
9
|
-
if (interfaceMirror.methods.length) {
|
|
10
|
-
listener.onMethodsDeclaration(this.sortType(interfaceMirror.methods));
|
|
11
|
-
}
|
|
12
|
-
}
|
|
13
|
-
}
|
|
14
|
-
exports.InterfaceWalker = InterfaceWalker;
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InterfaceWalker = void 0;
|
|
4
|
+
const walker_1 = require("./walker");
|
|
5
|
+
class InterfaceWalker extends walker_1.Walker {
|
|
6
|
+
walk(listener) {
|
|
7
|
+
listener.onTypeDeclaration(this.type);
|
|
8
|
+
const interfaceMirror = this.type;
|
|
9
|
+
if (interfaceMirror.methods.length) {
|
|
10
|
+
listener.onMethodsDeclaration(this.sortType(interfaceMirror.methods));
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
exports.InterfaceWalker = InterfaceWalker;
|
|
15
15
|
//# sourceMappingURL=interface-walker.js.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { Type } from '@cparra/apex-reflection';
|
|
2
|
-
import { Walker } from './walker';
|
|
3
|
-
export declare class WalkerFactory {
|
|
4
|
-
static get(type: Type): Walker;
|
|
5
|
-
}
|
|
1
|
+
import { Type } from '@cparra/apex-reflection';
|
|
2
|
+
import { Walker } from './walker';
|
|
3
|
+
export declare class WalkerFactory {
|
|
4
|
+
static get(type: Type): Walker;
|
|
5
|
+
}
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.WalkerFactory = void 0;
|
|
4
|
-
const class_walker_1 = require("./class-walker");
|
|
5
|
-
const enum_walker_1 = require("./enum-walker");
|
|
6
|
-
const interface_walker_1 = require("./interface-walker");
|
|
7
|
-
class WalkerFactory {
|
|
8
|
-
static get(type) {
|
|
9
|
-
switch (type.type_name) {
|
|
10
|
-
case 'class':
|
|
11
|
-
return new class_walker_1.ClassWalker(type);
|
|
12
|
-
case 'enum':
|
|
13
|
-
return new enum_walker_1.EnumWalker(type);
|
|
14
|
-
case 'interface':
|
|
15
|
-
return new interface_walker_1.InterfaceWalker(type);
|
|
16
|
-
}
|
|
17
|
-
throw Error('Walker not found for type.');
|
|
18
|
-
}
|
|
19
|
-
}
|
|
20
|
-
exports.WalkerFactory = WalkerFactory;
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.WalkerFactory = void 0;
|
|
4
|
+
const class_walker_1 = require("./class-walker");
|
|
5
|
+
const enum_walker_1 = require("./enum-walker");
|
|
6
|
+
const interface_walker_1 = require("./interface-walker");
|
|
7
|
+
class WalkerFactory {
|
|
8
|
+
static get(type) {
|
|
9
|
+
switch (type.type_name) {
|
|
10
|
+
case 'class':
|
|
11
|
+
return new class_walker_1.ClassWalker(type);
|
|
12
|
+
case 'enum':
|
|
13
|
+
return new enum_walker_1.EnumWalker(type);
|
|
14
|
+
case 'interface':
|
|
15
|
+
return new interface_walker_1.InterfaceWalker(type);
|
|
16
|
+
}
|
|
17
|
+
throw Error('Walker not found for type.');
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
exports.WalkerFactory = WalkerFactory;
|
|
21
21
|
//# sourceMappingURL=walker-factory.js.map
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
import { ClassMirror, ConstructorMirror, EnumMirror, FieldMirror, InterfaceMirror, MethodMirror, PropertyMirror, Type } from '@cparra/apex-reflection';
|
|
2
|
-
export interface WalkerListener {
|
|
3
|
-
onTypeDeclaration(typeMirror: Type): void;
|
|
4
|
-
onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
|
|
5
|
-
onFieldsDeclaration(fields: FieldMirror[]): void;
|
|
6
|
-
onPropertiesDeclaration(properties: PropertyMirror[]): void;
|
|
7
|
-
onMethodsDeclaration(methods: MethodMirror[]): void;
|
|
8
|
-
onInnerEnumsDeclaration(enums: EnumMirror[]): void;
|
|
9
|
-
onInnerClassesDeclaration(classes: ClassMirror[]): void;
|
|
10
|
-
onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
|
|
11
|
-
}
|
|
12
|
-
export declare abstract class Walker {
|
|
13
|
-
type: Type;
|
|
14
|
-
constructor(type: Type);
|
|
15
|
-
abstract walk(listener: WalkerListener): void;
|
|
16
|
-
protected sortType<T extends {
|
|
17
|
-
name: string;
|
|
18
|
-
}>(types: T[]): T[];
|
|
19
|
-
}
|
|
1
|
+
import { ClassMirror, ConstructorMirror, EnumMirror, FieldMirror, InterfaceMirror, MethodMirror, PropertyMirror, Type } from '@cparra/apex-reflection';
|
|
2
|
+
export interface WalkerListener {
|
|
3
|
+
onTypeDeclaration(typeMirror: Type): void;
|
|
4
|
+
onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
|
|
5
|
+
onFieldsDeclaration(fields: FieldMirror[]): void;
|
|
6
|
+
onPropertiesDeclaration(properties: PropertyMirror[]): void;
|
|
7
|
+
onMethodsDeclaration(methods: MethodMirror[]): void;
|
|
8
|
+
onInnerEnumsDeclaration(enums: EnumMirror[]): void;
|
|
9
|
+
onInnerClassesDeclaration(classes: ClassMirror[]): void;
|
|
10
|
+
onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
|
|
11
|
+
}
|
|
12
|
+
export declare abstract class Walker {
|
|
13
|
+
type: Type;
|
|
14
|
+
constructor(type: Type);
|
|
15
|
+
abstract walk(listener: WalkerListener): void;
|
|
16
|
+
protected sortType<T extends {
|
|
17
|
+
name: string;
|
|
18
|
+
}>(types: T[]): T[];
|
|
19
|
+
}
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.Walker = void 0;
|
|
4
|
-
const settings_1 = require("../../settings");
|
|
5
|
-
class Walker {
|
|
6
|
-
constructor(type) {
|
|
7
|
-
this.type = type;
|
|
8
|
-
}
|
|
9
|
-
sortType(types) {
|
|
10
|
-
if (settings_1.Settings.getInstance().sortMembersAlphabetically()) {
|
|
11
|
-
return types.sort((a, b) => a.name.localeCompare(b.name));
|
|
12
|
-
}
|
|
13
|
-
return types;
|
|
14
|
-
}
|
|
15
|
-
}
|
|
16
|
-
exports.Walker = Walker;
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Walker = void 0;
|
|
4
|
+
const settings_1 = require("../../settings");
|
|
5
|
+
class Walker {
|
|
6
|
+
constructor(type) {
|
|
7
|
+
this.type = type;
|
|
8
|
+
}
|
|
9
|
+
sortType(types) {
|
|
10
|
+
if (settings_1.Settings.getInstance().sortMembersAlphabetically()) {
|
|
11
|
+
return types.sort((a, b) => a.name.localeCompare(b.name));
|
|
12
|
+
}
|
|
13
|
+
return types;
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
exports.Walker = Walker;
|
|
17
17
|
//# sourceMappingURL=walker.js.map
|
package/lib/settings.d.ts
CHANGED
|
@@ -1,64 +1,70 @@
|
|
|
1
|
-
import { GeneratorChoices } from './transpiler/generator-choices';
|
|
2
|
-
export type OnBeforeFileWrite = (file: TargetFile) => TargetFile;
|
|
3
|
-
export type TargetFile = {
|
|
4
|
-
name: string;
|
|
5
|
-
extension: string;
|
|
6
|
-
dir: OutputDir;
|
|
7
|
-
};
|
|
8
|
-
export type OutputDir = {
|
|
9
|
-
baseDir: string;
|
|
10
|
-
fileDir: string;
|
|
11
|
-
};
|
|
12
|
-
export type TargetType = {
|
|
13
|
-
name: string;
|
|
14
|
-
typeName: 'class' | 'interface' | 'enum';
|
|
15
|
-
accessModifier: string;
|
|
16
|
-
description?: string;
|
|
17
|
-
group?: string;
|
|
18
|
-
};
|
|
19
|
-
export interface SettingsConfig {
|
|
20
|
-
sourceDirectory: string;
|
|
21
|
-
recursive: boolean;
|
|
22
|
-
scope: string[];
|
|
23
|
-
outputDir: string;
|
|
24
|
-
targetGenerator: GeneratorChoices;
|
|
25
|
-
indexOnly: boolean;
|
|
26
|
-
defaultGroupName: string;
|
|
27
|
-
sanitizeHtml: boolean;
|
|
28
|
-
openApiTitle?: string;
|
|
29
|
-
title: string;
|
|
30
|
-
namespace?: string;
|
|
31
|
-
openApiFileName: string;
|
|
32
|
-
includeMetadata: boolean;
|
|
33
|
-
rootDir?: string;
|
|
34
|
-
sortMembersAlphabetically?: boolean;
|
|
35
|
-
onAfterProcess?: (files: TargetFile[]) => void;
|
|
36
|
-
onBeforeFileWrite?: (file: TargetFile) => TargetFile;
|
|
37
|
-
frontMatterHeader?: (file: TargetType) => string[];
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
static
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
get
|
|
49
|
-
get
|
|
50
|
-
get
|
|
51
|
-
get
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
1
|
+
import { GeneratorChoices } from './transpiler/generator-choices';
|
|
2
|
+
export type OnBeforeFileWrite = (file: TargetFile) => TargetFile;
|
|
3
|
+
export type TargetFile = {
|
|
4
|
+
name: string;
|
|
5
|
+
extension: string;
|
|
6
|
+
dir: OutputDir;
|
|
7
|
+
};
|
|
8
|
+
export type OutputDir = {
|
|
9
|
+
baseDir: string;
|
|
10
|
+
fileDir: string;
|
|
11
|
+
};
|
|
12
|
+
export type TargetType = {
|
|
13
|
+
name: string;
|
|
14
|
+
typeName: 'class' | 'interface' | 'enum';
|
|
15
|
+
accessModifier: string;
|
|
16
|
+
description?: string;
|
|
17
|
+
group?: string;
|
|
18
|
+
};
|
|
19
|
+
export interface SettingsConfig {
|
|
20
|
+
sourceDirectory: string;
|
|
21
|
+
recursive: boolean;
|
|
22
|
+
scope: string[];
|
|
23
|
+
outputDir: string;
|
|
24
|
+
targetGenerator: GeneratorChoices;
|
|
25
|
+
indexOnly: boolean;
|
|
26
|
+
defaultGroupName: string;
|
|
27
|
+
sanitizeHtml: boolean;
|
|
28
|
+
openApiTitle?: string;
|
|
29
|
+
title: string;
|
|
30
|
+
namespace?: string;
|
|
31
|
+
openApiFileName: string;
|
|
32
|
+
includeMetadata: boolean;
|
|
33
|
+
rootDir?: string;
|
|
34
|
+
sortMembersAlphabetically?: boolean;
|
|
35
|
+
onAfterProcess?: (files: TargetFile[]) => void;
|
|
36
|
+
onBeforeFileWrite?: (file: TargetFile) => TargetFile;
|
|
37
|
+
frontMatterHeader?: (file: TargetType) => string[];
|
|
38
|
+
singleFile?: boolean;
|
|
39
|
+
fileName?: string;
|
|
40
|
+
templateFilePath?: string;
|
|
41
|
+
}
|
|
42
|
+
export declare class Settings {
|
|
43
|
+
config: SettingsConfig;
|
|
44
|
+
private static instance;
|
|
45
|
+
private constructor();
|
|
46
|
+
static build(config: SettingsConfig): void;
|
|
47
|
+
static getInstance(): Settings;
|
|
48
|
+
get sourceDirectory(): string;
|
|
49
|
+
get recursive(): boolean;
|
|
50
|
+
get scope(): string[];
|
|
51
|
+
get outputDir(): string;
|
|
52
|
+
get targetGenerator(): GeneratorChoices;
|
|
53
|
+
get indexOnly(): boolean;
|
|
54
|
+
get sanitizeHtml(): boolean;
|
|
55
|
+
getDefaultGroupName(): string;
|
|
56
|
+
getOpenApiTitle(): string | undefined;
|
|
57
|
+
getTitle(): string;
|
|
58
|
+
getNamespace(): string | undefined;
|
|
59
|
+
getNamespacePrefix(): string;
|
|
60
|
+
openApiFileName(): string;
|
|
61
|
+
includeMetadata(): boolean;
|
|
62
|
+
sortMembersAlphabetically(): boolean;
|
|
63
|
+
getRootDir(): string | undefined;
|
|
64
|
+
onAfterProcess(files: TargetFile[]): void;
|
|
65
|
+
onBeforeFileWrite(file: TargetFile): TargetFile;
|
|
66
|
+
frontMatterHeader(file: TargetType): string[];
|
|
67
|
+
shouldOutputSingleFile(): boolean;
|
|
68
|
+
getSingleFileName(): string;
|
|
69
|
+
getTemplateFilePath(): string | undefined;
|
|
70
|
+
}
|
package/lib/settings.js
CHANGED
|
@@ -1,89 +1,100 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.Settings = void 0;
|
|
4
|
-
class Settings {
|
|
5
|
-
constructor(config) {
|
|
6
|
-
this.config = config;
|
|
7
|
-
}
|
|
8
|
-
static build(config) {
|
|
9
|
-
Settings.instance = new Settings(config);
|
|
10
|
-
}
|
|
11
|
-
static getInstance() {
|
|
12
|
-
if (!Settings.instance) {
|
|
13
|
-
throw new Error('Settings has not been initialized');
|
|
14
|
-
}
|
|
15
|
-
return Settings.instance;
|
|
16
|
-
}
|
|
17
|
-
get sourceDirectory() {
|
|
18
|
-
return this.config.sourceDirectory;
|
|
19
|
-
}
|
|
20
|
-
get recursive() {
|
|
21
|
-
return this.config.recursive;
|
|
22
|
-
}
|
|
23
|
-
get scope() {
|
|
24
|
-
return this.config.scope;
|
|
25
|
-
}
|
|
26
|
-
get outputDir() {
|
|
27
|
-
return this.config.outputDir;
|
|
28
|
-
}
|
|
29
|
-
get targetGenerator() {
|
|
30
|
-
return this.config.targetGenerator;
|
|
31
|
-
}
|
|
32
|
-
get indexOnly() {
|
|
33
|
-
return this.config.indexOnly;
|
|
34
|
-
}
|
|
35
|
-
get sanitizeHtml() {
|
|
36
|
-
return this.config.sanitizeHtml;
|
|
37
|
-
}
|
|
38
|
-
getDefaultGroupName() {
|
|
39
|
-
return this.config.defaultGroupName;
|
|
40
|
-
}
|
|
41
|
-
getOpenApiTitle() {
|
|
42
|
-
var _a;
|
|
43
|
-
return (_a = this.config.openApiTitle) !== null && _a !== void 0 ? _a : this.config.title;
|
|
44
|
-
}
|
|
45
|
-
getTitle() {
|
|
46
|
-
return this.config.title;
|
|
47
|
-
}
|
|
48
|
-
getNamespace() {
|
|
49
|
-
return this.config.namespace;
|
|
50
|
-
}
|
|
51
|
-
getNamespacePrefix() {
|
|
52
|
-
if (!this.config.namespace) {
|
|
53
|
-
return '';
|
|
54
|
-
}
|
|
55
|
-
return `${this.config.namespace}.`;
|
|
56
|
-
}
|
|
57
|
-
openApiFileName() {
|
|
58
|
-
return this.config.openApiFileName;
|
|
59
|
-
}
|
|
60
|
-
includeMetadata() {
|
|
61
|
-
return this.config.includeMetadata;
|
|
62
|
-
}
|
|
63
|
-
sortMembersAlphabetically() {
|
|
64
|
-
var _a;
|
|
65
|
-
return (_a = this.config.sortMembersAlphabetically) !== null && _a !== void 0 ? _a : false;
|
|
66
|
-
}
|
|
67
|
-
getRootDir() {
|
|
68
|
-
return this.config.rootDir;
|
|
69
|
-
}
|
|
70
|
-
onAfterProcess(files) {
|
|
71
|
-
if (this.config.onAfterProcess) {
|
|
72
|
-
this.config.onAfterProcess(files);
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
onBeforeFileWrite(file) {
|
|
76
|
-
if (this.config.onBeforeFileWrite) {
|
|
77
|
-
return this.config.onBeforeFileWrite(file);
|
|
78
|
-
}
|
|
79
|
-
return file;
|
|
80
|
-
}
|
|
81
|
-
frontMatterHeader(file) {
|
|
82
|
-
if (this.config.frontMatterHeader) {
|
|
83
|
-
return this.config.frontMatterHeader(file);
|
|
84
|
-
}
|
|
85
|
-
return [];
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Settings = void 0;
|
|
4
|
+
class Settings {
|
|
5
|
+
constructor(config) {
|
|
6
|
+
this.config = config;
|
|
7
|
+
}
|
|
8
|
+
static build(config) {
|
|
9
|
+
Settings.instance = new Settings(config);
|
|
10
|
+
}
|
|
11
|
+
static getInstance() {
|
|
12
|
+
if (!Settings.instance) {
|
|
13
|
+
throw new Error('Settings has not been initialized');
|
|
14
|
+
}
|
|
15
|
+
return Settings.instance;
|
|
16
|
+
}
|
|
17
|
+
get sourceDirectory() {
|
|
18
|
+
return this.config.sourceDirectory;
|
|
19
|
+
}
|
|
20
|
+
get recursive() {
|
|
21
|
+
return this.config.recursive;
|
|
22
|
+
}
|
|
23
|
+
get scope() {
|
|
24
|
+
return this.config.scope;
|
|
25
|
+
}
|
|
26
|
+
get outputDir() {
|
|
27
|
+
return this.config.outputDir;
|
|
28
|
+
}
|
|
29
|
+
get targetGenerator() {
|
|
30
|
+
return this.config.targetGenerator;
|
|
31
|
+
}
|
|
32
|
+
get indexOnly() {
|
|
33
|
+
return this.config.indexOnly;
|
|
34
|
+
}
|
|
35
|
+
get sanitizeHtml() {
|
|
36
|
+
return this.config.sanitizeHtml;
|
|
37
|
+
}
|
|
38
|
+
getDefaultGroupName() {
|
|
39
|
+
return this.config.defaultGroupName;
|
|
40
|
+
}
|
|
41
|
+
getOpenApiTitle() {
|
|
42
|
+
var _a;
|
|
43
|
+
return (_a = this.config.openApiTitle) !== null && _a !== void 0 ? _a : this.config.title;
|
|
44
|
+
}
|
|
45
|
+
getTitle() {
|
|
46
|
+
return this.config.title;
|
|
47
|
+
}
|
|
48
|
+
getNamespace() {
|
|
49
|
+
return this.config.namespace;
|
|
50
|
+
}
|
|
51
|
+
getNamespacePrefix() {
|
|
52
|
+
if (!this.config.namespace) {
|
|
53
|
+
return '';
|
|
54
|
+
}
|
|
55
|
+
return `${this.config.namespace}.`;
|
|
56
|
+
}
|
|
57
|
+
openApiFileName() {
|
|
58
|
+
return this.config.openApiFileName;
|
|
59
|
+
}
|
|
60
|
+
includeMetadata() {
|
|
61
|
+
return this.config.includeMetadata;
|
|
62
|
+
}
|
|
63
|
+
sortMembersAlphabetically() {
|
|
64
|
+
var _a;
|
|
65
|
+
return (_a = this.config.sortMembersAlphabetically) !== null && _a !== void 0 ? _a : false;
|
|
66
|
+
}
|
|
67
|
+
getRootDir() {
|
|
68
|
+
return this.config.rootDir;
|
|
69
|
+
}
|
|
70
|
+
onAfterProcess(files) {
|
|
71
|
+
if (this.config.onAfterProcess) {
|
|
72
|
+
this.config.onAfterProcess(files);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
onBeforeFileWrite(file) {
|
|
76
|
+
if (this.config.onBeforeFileWrite) {
|
|
77
|
+
return this.config.onBeforeFileWrite(file);
|
|
78
|
+
}
|
|
79
|
+
return file;
|
|
80
|
+
}
|
|
81
|
+
frontMatterHeader(file) {
|
|
82
|
+
if (this.config.frontMatterHeader) {
|
|
83
|
+
return this.config.frontMatterHeader(file);
|
|
84
|
+
}
|
|
85
|
+
return [];
|
|
86
|
+
}
|
|
87
|
+
shouldOutputSingleFile() {
|
|
88
|
+
var _a;
|
|
89
|
+
return (_a = this.config.singleFile) !== null && _a !== void 0 ? _a : false;
|
|
90
|
+
}
|
|
91
|
+
getSingleFileName() {
|
|
92
|
+
var _a;
|
|
93
|
+
return (_a = this.config.fileName) !== null && _a !== void 0 ? _a : 'README';
|
|
94
|
+
}
|
|
95
|
+
getTemplateFilePath() {
|
|
96
|
+
return this.config.templateFilePath;
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
exports.Settings = Settings;
|
|
89
100
|
//# sourceMappingURL=settings.js.map
|
package/lib/settings.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AA+CA,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;IAEM,eAAe;;QACpB,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,YAAY,mCAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IACvD,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAEM,kBAAkB;QACvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAC1B,OAAO,EAAE,CAAC;SACX;QACD,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,yBAAyB;;QAC9B,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,yBAAyB,mCAAI,KAAK,CAAC;IACxD,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAEM,cAAc,CAAC,KAAmB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;SACnC;IACH,CAAC;IAEM,iBAAiB,CAAC,IAAgB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,iBAAiB,CAAC,IAAgB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,sBAAsB;;QAC3B,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,UAAU,mCAAI,KAAK,CAAC;IACzC,CAAC;IAEM,iBAAiB;;QACtB,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,QAAQ,mCAAI,QAAQ,CAAC;IAC1C,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;CACF;AAlHD,4BAkHC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { EnumSource, ConvertRenderableContentsToString, InterfaceSource, ClassSource } from './types';
|
|
2
|
+
type CompileOptions = {
|
|
3
|
+
renderableContentConverter: ConvertRenderableContentsToString;
|
|
4
|
+
codeBlockConverter: (language: string, lines: string[]) => string;
|
|
5
|
+
};
|
|
6
|
+
export declare function compile(template: string, source: EnumSource | InterfaceSource | ClassSource, options: CompileOptions): string;
|
|
7
|
+
export {};
|