@cparra/apexdocs 2.25.0-alpha.2 → 2.25.0-alpha.4
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/README.md +37 -0
- package/dist/cli/generate.js +291 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1 -0
- package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +18 -0
- package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +6 -2
- package/examples/plain-markdown/docs/Miscellaneous/ns.Url.md +320 -0
- package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +3 -1
- package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +1 -1
- package/examples/plain-markdown/docs/index.md +84 -0
- package/examples/plain-markdown/force-app/classes/SampleException.cls +16 -0
- package/examples/plain-markdown/force-app/classes/Url.cls +194 -0
- package/examples/plain-markdown/package.json +2 -1
- package/jest.config.js +1 -1
- package/package.json +11 -13
- package/src/__spec__/core/generating-class-docs.spec.ts +57 -37
- package/src/__spec__/core/generating-enum-docs.spec.ts +25 -22
- package/src/__spec__/core/generating-interface-docs.spec.ts +33 -30
- package/src/__spec__/core/generating-reference-guide.spec.ts +8 -7
- package/src/__spec__/core/test-helpers.ts +9 -0
- package/src/application/Apexdocs.ts +34 -5
- package/src/application/{flows → generators}/generate-markdown-files.ts +19 -13
- package/src/cli/args.ts +138 -0
- package/src/cli/generate.ts +12 -138
- package/src/core/adapters/__tests__/documentables.spec.ts +109 -0
- package/src/{adapters → core/adapters}/__tests__/interface-adapter.spec.ts +13 -11
- package/src/{adapters → core/adapters}/__tests__/references.spec.ts +23 -2
- package/src/{adapters → core/adapters}/apex-types.ts +18 -15
- package/src/{adapters → core/adapters}/documentables.ts +54 -12
- package/src/{adapters → core/adapters}/fields-and-properties.ts +17 -10
- package/src/{adapters/references.ts → core/adapters/inline.ts} +43 -13
- package/src/{adapters → core/adapters}/methods-and-constructors.ts +21 -9
- package/src/core/adapters/type-utils.ts +13 -0
- package/src/core/{renderable → adapters}/types.d.ts +42 -4
- package/src/core/generate-docs.ts +55 -19
- package/src/core/template.ts +15 -9
- package/src/core/templates/reference-guide.ts +1 -1
- package/src/model/__tests__/manifest.spec.ts +1 -1
- package/src/model/markdown-generation-util/field-declaration-util.ts +1 -1
- package/src/model/markdown-generation-util/method-declaration-util.ts +1 -1
- package/src/model/markdown-type-file.ts +5 -1
- package/src/service/__tests__/apex-file-reader.spec.ts +1 -0
- package/src/service/apex-file-reader.ts +2 -6
- package/src/service/manifest-factory.ts +2 -2
- package/src/service/parser.ts +1 -1
- package/src/settings.ts +6 -10
- package/src/test-helpers/SettingsBuilder.ts +1 -2
- package/src/transpiler/factory.ts +2 -4
- package/src/transpiler/markdown/class-file-generatorHelper.ts +1 -18
- package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +2 -2
- package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +6 -4
- package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +1 -1
- package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +2 -2
- package/src/util/fp.ts +3 -0
- package/tsconfig.json +1 -1
- package/docs/.nojekyll +0 -0
- package/docs/__old/README.md +0 -1
- package/docs/__old/index.html +0 -22
- package/docs/__old/restapi.json +0 -589
- package/docs/__old/types/Classes/nspc.AnotherInterface.md +0 -22
- package/docs/__old/types/Classes/nspc.ChildClass.md +0 -97
- package/docs/__old/types/Main/nspc.GroupedClass.md +0 -10
- package/docs/__old/types/Main/nspc.SampleClass.md +0 -189
- package/docs/__old/types/Misc-Group/nspc.EscapedAnnotations.md +0 -4
- package/docs/__old/types/Misc-Group/nspc.GrandparentClass.md +0 -13
- package/docs/__old/types/Misc-Group/nspc.InterfaceWithInheritance.md +0 -29
- package/docs/__old/types/Misc-Group/nspc.MemberGrouping.md +0 -13
- package/docs/__old/types/Misc-Group/nspc.ParentClass.md +0 -37
- package/docs/__old/types/Misc-Group/nspc.Reference1.md +0 -18
- package/docs/__old/types/Misc-Group/nspc.Reference2.md +0 -12
- package/docs/__old/types/Misc-Group/nspc.Reference3.md +0 -7
- package/docs/__old/types/Misc-Group/nspc.Reference4.md +0 -7
- package/docs/__old/types/Misc-Group/nspc.Reference5.md +0 -7
- package/docs/__old/types/Misc-Group/nspc.Reference6.md +0 -9
- package/docs/__old/types/Misc-Group/nspc.Reference7.md +0 -7
- package/docs/__old/types/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -11
- package/docs/__old/types/Misc-Group/nspc.SampleRestResource.md +0 -104
- package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -33
- package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -14
- package/docs/__old/types/README.md +0 -97
- package/docs/__old/types/Sample-Interfaces/nspc.SampleInterface.md +0 -23
- package/examples/includes/header.md +0 -3
- package/lib/__spec__/core/expect-extensions.d.ts +0 -3
- package/lib/__spec__/core/expect-extensions.js +0 -54
- package/lib/__spec__/core/expect-extensions.js.map +0 -1
- package/lib/__spec__/core/generating-class-docs.spec.d.ts +0 -1
- package/lib/__spec__/core/generating-class-docs.spec.js +0 -427
- package/lib/__spec__/core/generating-class-docs.spec.js.map +0 -1
- package/lib/__spec__/core/generating-enum-docs.spec.d.ts +0 -1
- package/lib/__spec__/core/generating-enum-docs.spec.js +0 -303
- package/lib/__spec__/core/generating-enum-docs.spec.js.map +0 -1
- package/lib/__spec__/core/generating-interface-docs.spec.d.ts +0 -1
- package/lib/__spec__/core/generating-interface-docs.spec.js +0 -361
- package/lib/__spec__/core/generating-interface-docs.spec.js.map +0 -1
- package/lib/__spec__/core/generating-reference-guide.spec.d.ts +0 -1
- package/lib/__spec__/core/generating-reference-guide.spec.js +0 -161
- package/lib/__spec__/core/generating-reference-guide.spec.js.map +0 -1
- package/lib/adapters/apex-types.d.ts +0 -5
- package/lib/adapters/apex-types.js +0 -109
- package/lib/adapters/apex-types.js.map +0 -1
- package/lib/adapters/documentables.d.ts +0 -7
- package/lib/adapters/documentables.js +0 -56
- package/lib/adapters/documentables.js.map +0 -1
- package/lib/adapters/fields-and-properties.d.ts +0 -4
- package/lib/adapters/fields-and-properties.js +0 -31
- package/lib/adapters/fields-and-properties.js.map +0 -1
- package/lib/adapters/methods-and-constructors.d.ts +0 -5
- package/lib/adapters/methods-and-constructors.js +0 -91
- package/lib/adapters/methods-and-constructors.js.map +0 -1
- package/lib/adapters/references.d.ts +0 -5
- package/lib/adapters/references.js +0 -82
- package/lib/adapters/references.js.map +0 -1
- package/lib/adapters/type-utils.d.ts +0 -2
- package/lib/adapters/type-utils.js +0 -7
- package/lib/adapters/type-utils.js.map +0 -1
- package/lib/application/Apexdocs.d.ts +0 -13
- package/lib/application/Apexdocs.js +0 -86
- package/lib/application/Apexdocs.js.map +0 -1
- package/lib/application/flows/generate-markdown-files.d.ts +0 -3
- package/lib/application/flows/generate-markdown-files.js +0 -57
- package/lib/application/flows/generate-markdown-files.js.map +0 -1
- package/lib/cli/generate.d.ts +0 -2
- package/lib/cli/generate.js +0 -157
- package/lib/cli/generate.js.map +0 -1
- package/lib/core/__test__/inheritance-chain.test.d.ts +0 -1
- package/lib/core/__test__/inheritance-chain.test.js +0 -42
- package/lib/core/__test__/inheritance-chain.test.js.map +0 -1
- package/lib/core/generate-docs.d.ts +0 -24
- package/lib/core/generate-docs.js +0 -267
- package/lib/core/generate-docs.js.map +0 -1
- package/lib/core/inheritance-chain.d.ts +0 -2
- package/lib/core/inheritance-chain.js +0 -35
- package/lib/core/inheritance-chain.js.map +0 -1
- package/lib/core/template.d.ts +0 -10
- package/lib/core/template.js +0 -92
- package/lib/core/template.js.map +0 -1
- package/lib/core/templates/reference-guide.d.ts +0 -1
- package/lib/core/templates/reference-guide.js +0 -18
- package/lib/core/templates/reference-guide.js.map +0 -1
- package/lib/index.d.ts +0 -2
- package/lib/index.js +0 -29
- package/lib/index.js.map +0 -1
- package/lib/model/apex-bundle.d.ts +0 -6
- package/lib/model/apex-bundle.js +0 -11
- package/lib/model/apex-bundle.js.map +0 -1
- package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +0 -7
- package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +0 -14
- package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js.map +0 -1
- package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +0 -7
- package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +0 -12
- package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js.map +0 -1
- package/lib/model/inheritance.d.ts +0 -11
- package/lib/model/inheritance.js +0 -3
- package/lib/model/inheritance.js.map +0 -1
- package/lib/model/manifest.d.ts +0 -22
- package/lib/model/manifest.js +0 -53
- package/lib/model/manifest.js.map +0 -1
- package/lib/model/markdown-file.d.ts +0 -16
- package/lib/model/markdown-file.js +0 -111
- package/lib/model/markdown-file.js.map +0 -1
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +0 -8
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +0 -46
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +0 -1
- package/lib/model/markdown-generation-util/field-declaration-util.d.ts +0 -3
- package/lib/model/markdown-generation-util/field-declaration-util.js +0 -54
- package/lib/model/markdown-generation-util/field-declaration-util.js.map +0 -1
- package/lib/model/markdown-generation-util/index.d.ts +0 -3
- package/lib/model/markdown-generation-util/index.js +0 -20
- package/lib/model/markdown-generation-util/index.js.map +0 -1
- package/lib/model/markdown-generation-util/method-declaration-util.d.ts +0 -4
- package/lib/model/markdown-generation-util/method-declaration-util.js +0 -114
- package/lib/model/markdown-generation-util/method-declaration-util.js.map +0 -1
- package/lib/model/markdown-generation-util/type-declaration-util.d.ts +0 -3
- package/lib/model/markdown-generation-util/type-declaration-util.js +0 -81
- package/lib/model/markdown-generation-util/type-declaration-util.js.map +0 -1
- package/lib/model/markdown-home-file.d.ts +0 -11
- package/lib/model/markdown-home-file.js +0 -57
- package/lib/model/markdown-home-file.js.map +0 -1
- package/lib/model/markdown-type-file.d.ts +0 -26
- package/lib/model/markdown-type-file.js +0 -137
- package/lib/model/markdown-type-file.js.map +0 -1
- package/lib/model/openapi/apex-doc-types.d.ts +0 -19
- package/lib/model/openapi/apex-doc-types.js +0 -5
- package/lib/model/openapi/apex-doc-types.js.map +0 -1
- package/lib/model/openapi/open-api-types.d.ts +0 -93
- package/lib/model/openapi/open-api-types.js +0 -3
- package/lib/model/openapi/open-api-types.js.map +0 -1
- package/lib/model/openapi/open-api.d.ts +0 -16
- package/lib/model/openapi/open-api.js +0 -34
- package/lib/model/openapi/open-api.js.map +0 -1
- package/lib/model/openapi/openapi-type-file.d.ts +0 -7
- package/lib/model/openapi/openapi-type-file.js +0 -17
- package/lib/model/openapi/openapi-type-file.js.map +0 -1
- package/lib/model/outputFile.d.ts +0 -10
- package/lib/model/outputFile.js +0 -22
- package/lib/model/outputFile.js.map +0 -1
- package/lib/model/types-repository.d.ts +0 -16
- package/lib/model/types-repository.js +0 -54
- package/lib/model/types-repository.js.map +0 -1
- package/lib/service/apex-file-reader.d.ts +0 -14
- package/lib/service/apex-file-reader.js +0 -49
- package/lib/service/apex-file-reader.js.map +0 -1
- package/lib/service/file-system.d.ts +0 -14
- package/lib/service/file-system.js +0 -48
- package/lib/service/file-system.js.map +0 -1
- package/lib/service/file-writer.d.ts +0 -6
- package/lib/service/file-writer.js +0 -57
- package/lib/service/file-writer.js.map +0 -1
- package/lib/service/manifest-factory.d.ts +0 -10
- package/lib/service/manifest-factory.js +0 -16
- package/lib/service/manifest-factory.js.map +0 -1
- package/lib/service/metadata-processor.d.ts +0 -3
- package/lib/service/metadata-processor.js +0 -17
- package/lib/service/metadata-processor.js.map +0 -1
- package/lib/service/parser.d.ts +0 -21
- package/lib/service/parser.js +0 -138
- package/lib/service/parser.js.map +0 -1
- package/lib/service/state.d.ts +0 -9
- package/lib/service/state.js +0 -20
- package/lib/service/state.js.map +0 -1
- package/lib/service/walkers/class-walker.d.ts +0 -4
- package/lib/service/walkers/class-walker.js +0 -33
- package/lib/service/walkers/class-walker.js.map +0 -1
- package/lib/service/walkers/enum-walker.d.ts +0 -4
- package/lib/service/walkers/enum-walker.js +0 -11
- package/lib/service/walkers/enum-walker.js.map +0 -1
- package/lib/service/walkers/interface-walker.d.ts +0 -4
- package/lib/service/walkers/interface-walker.js +0 -15
- package/lib/service/walkers/interface-walker.js.map +0 -1
- package/lib/service/walkers/walker-factory.d.ts +0 -5
- package/lib/service/walkers/walker-factory.js +0 -21
- package/lib/service/walkers/walker-factory.js.map +0 -1
- package/lib/service/walkers/walker.d.ts +0 -19
- package/lib/service/walkers/walker.js +0 -17
- package/lib/service/walkers/walker.js.map +0 -1
- package/lib/settings.d.ts +0 -64
- package/lib/settings.js +0 -89
- package/lib/settings.js.map +0 -1
- package/lib/test-helpers/AnnotationBuilder.d.ts +0 -12
- package/lib/test-helpers/AnnotationBuilder.js +0 -31
- package/lib/test-helpers/AnnotationBuilder.js.map +0 -1
- package/lib/test-helpers/ClassMirrorBuilder.d.ts +0 -22
- package/lib/test-helpers/ClassMirrorBuilder.js +0 -64
- package/lib/test-helpers/ClassMirrorBuilder.js.map +0 -1
- package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +0 -8
- package/lib/test-helpers/DocCommentAnnotationBuilder.js +0 -26
- package/lib/test-helpers/DocCommentAnnotationBuilder.js.map +0 -1
- package/lib/test-helpers/DocCommentBuilder.d.ts +0 -12
- package/lib/test-helpers/DocCommentBuilder.js +0 -38
- package/lib/test-helpers/DocCommentBuilder.js.map +0 -1
- package/lib/test-helpers/FieldMirrorBuilder.d.ts +0 -18
- package/lib/test-helpers/FieldMirrorBuilder.js +0 -54
- package/lib/test-helpers/FieldMirrorBuilder.js.map +0 -1
- package/lib/test-helpers/InterfaceMirrorBuilder.d.ts +0 -16
- package/lib/test-helpers/InterfaceMirrorBuilder.js +0 -43
- package/lib/test-helpers/InterfaceMirrorBuilder.js.map +0 -1
- package/lib/test-helpers/MethodMirrorBuilder.d.ts +0 -29
- package/lib/test-helpers/MethodMirrorBuilder.js +0 -72
- package/lib/test-helpers/MethodMirrorBuilder.js.map +0 -1
- package/lib/test-helpers/SettingsBuilder.d.ts +0 -8
- package/lib/test-helpers/SettingsBuilder.js +0 -27
- package/lib/test-helpers/SettingsBuilder.js.map +0 -1
- package/lib/transpiler/factory.d.ts +0 -6
- package/lib/transpiler/factory.js +0 -35
- package/lib/transpiler/factory.js.map +0 -1
- package/lib/transpiler/file-container.d.ts +0 -6
- package/lib/transpiler/file-container.js +0 -16
- package/lib/transpiler/file-container.js.map +0 -1
- package/lib/transpiler/generator-choices.d.ts +0 -1
- package/lib/transpiler/generator-choices.js +0 -3
- package/lib/transpiler/generator-choices.js.map +0 -1
- package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +0 -11
- package/lib/transpiler/markdown/class-file-generatorHelper.js +0 -75
- package/lib/transpiler/markdown/class-file-generatorHelper.js.map +0 -1
- package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +0 -6
- package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +0 -13
- package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map +0 -1
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +0 -11
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +0 -51
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +0 -1
- package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +0 -11
- package/lib/transpiler/markdown/markdown-transpiler-base.js +0 -27
- package/lib/transpiler/markdown/markdown-transpiler-base.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/class-template.d.ts +0 -1
- package/lib/transpiler/markdown/plain-markdown/class-template.js +0 -77
- package/lib/transpiler/markdown/plain-markdown/class-template.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +0 -1
- package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js +0 -36
- package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +0 -1
- package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js +0 -28
- package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/enum-template.d.ts +0 -1
- package/lib/transpiler/markdown/plain-markdown/enum-template.js +0 -16
- package/lib/transpiler/markdown/plain-markdown/enum-template.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +0 -1
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +0 -27
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +0 -1
- package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +0 -10
- package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/interface-template.d.ts +0 -1
- package/lib/transpiler/markdown/plain-markdown/interface-template.js +0 -20
- package/lib/transpiler/markdown/plain-markdown/interface-template.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +0 -1
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js +0 -47
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +0 -9
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +0 -42
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +0 -1
- package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js +0 -31
- package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js.map +0 -1
- package/lib/transpiler/openapi/open-api-docs-processor.d.ts +0 -13
- package/lib/transpiler/openapi/open-api-docs-processor.js +0 -78
- package/lib/transpiler/openapi/open-api-docs-processor.js.map +0 -1
- package/lib/transpiler/openapi/parsers/Builder.d.ts +0 -16
- package/lib/transpiler/openapi/parsers/Builder.js +0 -30
- package/lib/transpiler/openapi/parsers/Builder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/MethodParser.d.ts +0 -20
- package/lib/transpiler/openapi/parsers/MethodParser.js +0 -190
- package/lib/transpiler/openapi/parsers/MethodParser.js.map +0 -1
- package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +0 -7
- package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +0 -11
- package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +0 -39
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +0 -250
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -10
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -20
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -7
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +0 -22
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -1
- package/lib/transpiler/processor-type-transpiler.d.ts +0 -10
- package/lib/transpiler/processor-type-transpiler.js +0 -9
- package/lib/transpiler/processor-type-transpiler.js.map +0 -1
- package/lib/transpiler/transpiler.d.ts +0 -5
- package/lib/transpiler/transpiler.js +0 -30
- package/lib/transpiler/transpiler.js.map +0 -1
- package/lib/util/error-logger.d.ts +0 -8
- package/lib/util/error-logger.js +0 -90
- package/lib/util/error-logger.js.map +0 -1
- package/lib/util/logger.d.ts +0 -21
- package/lib/util/logger.js +0 -61
- package/lib/util/logger.js.map +0 -1
- package/lib/util/string-utils.d.ts +0 -2
- package/lib/util/string-utils.js +0 -15
- package/lib/util/string-utils.js.map +0 -1
- package/src/adapters/type-utils.ts +0 -5
- package/src/adapters/types.d.ts +0 -8
- package/src/model/inheritance.ts +0 -8
- package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +0 -42
- /package/src/{model → core}/apex-bundle.ts +0 -0
- /package/src/{model → core}/manifest.ts +0 -0
|
@@ -1,109 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.typeToRenderableType = typeToRenderableType;
|
|
4
|
-
exports.interfaceTypeToInterfaceSource = interfaceTypeToInterfaceSource;
|
|
5
|
-
const documentables_1 = require("./documentables");
|
|
6
|
-
const methods_and_constructors_1 = require("./methods-and-constructors");
|
|
7
|
-
const fields_and_properties_1 = require("./fields-and-properties");
|
|
8
|
-
function typeToRenderableType(type, linkGenerator, namespace) {
|
|
9
|
-
function getRenderable() {
|
|
10
|
-
switch (type.type_name) {
|
|
11
|
-
case 'enum':
|
|
12
|
-
return enumTypeToEnumSource(type, linkGenerator);
|
|
13
|
-
case 'interface':
|
|
14
|
-
return interfaceTypeToInterfaceSource(type, linkGenerator);
|
|
15
|
-
case 'class':
|
|
16
|
-
return classTypeToClassSource(type, linkGenerator);
|
|
17
|
-
}
|
|
18
|
-
}
|
|
19
|
-
return Object.assign(Object.assign({}, getRenderable()), { namespace });
|
|
20
|
-
}
|
|
21
|
-
function baseTypeAdapter(type, linkGenerator, baseHeadingLevel) {
|
|
22
|
-
function getHeading(type) {
|
|
23
|
-
const suffixMap = {
|
|
24
|
-
class: 'Class',
|
|
25
|
-
interface: 'Interface',
|
|
26
|
-
enum: 'Enum',
|
|
27
|
-
};
|
|
28
|
-
return `${type.name} ${suffixMap[type.type_name]}`;
|
|
29
|
-
}
|
|
30
|
-
return {
|
|
31
|
-
headingLevel: baseHeadingLevel,
|
|
32
|
-
heading: getHeading(type),
|
|
33
|
-
doc: (0, documentables_1.adaptDocumentable)(type, linkGenerator, baseHeadingLevel + 1),
|
|
34
|
-
name: type.name,
|
|
35
|
-
meta: {
|
|
36
|
-
accessModifier: type.access_modifier,
|
|
37
|
-
},
|
|
38
|
-
};
|
|
39
|
-
}
|
|
40
|
-
function enumTypeToEnumSource(enumType, linkGenerator, baseHeadingLevel = 1) {
|
|
41
|
-
return Object.assign(Object.assign({ type: 'enum' }, baseTypeAdapter(enumType, linkGenerator, baseHeadingLevel)), { values: {
|
|
42
|
-
headingLevel: baseHeadingLevel + 1,
|
|
43
|
-
heading: 'Values',
|
|
44
|
-
value: enumType.values.map((value) => {
|
|
45
|
-
var _a;
|
|
46
|
-
return (Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)((_a = value.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines, linkGenerator)), { value: value.name }));
|
|
47
|
-
}),
|
|
48
|
-
} });
|
|
49
|
-
}
|
|
50
|
-
function interfaceTypeToInterfaceSource(interfaceType, linkGenerator, baseHeadingLevel = 1) {
|
|
51
|
-
return Object.assign(Object.assign({ type: 'interface' }, baseTypeAdapter(interfaceType, linkGenerator, baseHeadingLevel)), { extends: interfaceType.extended_interfaces.map(linkGenerator), methods: {
|
|
52
|
-
headingLevel: baseHeadingLevel + 1,
|
|
53
|
-
heading: 'Methods',
|
|
54
|
-
value: interfaceType.methods.map((method) => (0, methods_and_constructors_1.adaptMethod)(method, linkGenerator, baseHeadingLevel + 2)),
|
|
55
|
-
} });
|
|
56
|
-
}
|
|
57
|
-
function classTypeToClassSource(classType, linkGenerator, baseHeadingLevel = 1) {
|
|
58
|
-
return Object.assign(Object.assign({ type: 'class' }, baseTypeAdapter(classType, linkGenerator, baseHeadingLevel)), { classModifier: classType.classModifier, sharingModifier: classType.sharingModifier, implements: classType.implemented_interfaces.map(linkGenerator), extends: classType.inheritanceChain.map(linkGenerator), methods: adaptMembers('Methods', classType.methods, methods_and_constructors_1.adaptMethod, linkGenerator, baseHeadingLevel + 1), constructors: adaptMembers('Constructors', classType.constructors, (constructor, linkGenerator, baseHeadingLevel) => (0, methods_and_constructors_1.adaptConstructor)(classType.name, constructor, linkGenerator, baseHeadingLevel), linkGenerator, baseHeadingLevel + 1), fields: adaptMembers('Fields', classType.fields, fields_and_properties_1.adaptFieldOrProperty, linkGenerator, baseHeadingLevel + 1), properties: adaptMembers('Properties', classType.properties, fields_and_properties_1.adaptFieldOrProperty, linkGenerator, baseHeadingLevel + 1), innerClasses: {
|
|
59
|
-
headingLevel: baseHeadingLevel + 1,
|
|
60
|
-
heading: 'Classes',
|
|
61
|
-
value: classType.classes.map((innerClass) => classTypeToClassSource(Object.assign(Object.assign({}, innerClass), { inheritanceChain: [] }), linkGenerator, baseHeadingLevel + 2)),
|
|
62
|
-
}, innerEnums: {
|
|
63
|
-
headingLevel: baseHeadingLevel + 1,
|
|
64
|
-
heading: 'Enums',
|
|
65
|
-
value: classType.enums.map((innerEnum) => enumTypeToEnumSource(innerEnum, linkGenerator, baseHeadingLevel + 2)),
|
|
66
|
-
}, innerInterfaces: {
|
|
67
|
-
headingLevel: baseHeadingLevel + 1,
|
|
68
|
-
heading: 'Interfaces',
|
|
69
|
-
value: classType.interfaces.map((innerInterface) => interfaceTypeToInterfaceSource(innerInterface, linkGenerator, baseHeadingLevel + 2)),
|
|
70
|
-
} });
|
|
71
|
-
}
|
|
72
|
-
function adaptMembers(heading, members, adapter, linkFromTypeNameGenerator, headingLevel) {
|
|
73
|
-
return {
|
|
74
|
-
headingLevel,
|
|
75
|
-
heading,
|
|
76
|
-
isGrouped: hasGroup(members),
|
|
77
|
-
value: hasGroup(members)
|
|
78
|
-
? toGroupedMembers(members, adapter, linkFromTypeNameGenerator, headingLevel + 1)
|
|
79
|
-
: toFlat(members, adapter, linkFromTypeNameGenerator, headingLevel + 1),
|
|
80
|
-
};
|
|
81
|
-
}
|
|
82
|
-
function hasGroup(members) {
|
|
83
|
-
return members.some((member) => member.group);
|
|
84
|
-
}
|
|
85
|
-
function toFlat(members, adapter, linkGenerator, baseHeadingLevel) {
|
|
86
|
-
return members.map((member) => adapter(member, linkGenerator, baseHeadingLevel));
|
|
87
|
-
}
|
|
88
|
-
function toGroupedMembers(members, adapter, linkGenerator, baseHeadingLevel) {
|
|
89
|
-
const groupedMembers = groupByGroupName(members);
|
|
90
|
-
return Object.entries(groupedMembers).map(([groupName, members]) => singleGroup(baseHeadingLevel, groupName, adapter, members, linkGenerator));
|
|
91
|
-
}
|
|
92
|
-
function groupByGroupName(members) {
|
|
93
|
-
return members.reduce((acc, member) => {
|
|
94
|
-
var _a, _b;
|
|
95
|
-
const groupName = (_a = member.group) !== null && _a !== void 0 ? _a : 'Other';
|
|
96
|
-
acc[groupName] = (_b = acc[groupName]) !== null && _b !== void 0 ? _b : [];
|
|
97
|
-
acc[groupName].push(member);
|
|
98
|
-
return acc;
|
|
99
|
-
}, {});
|
|
100
|
-
}
|
|
101
|
-
function singleGroup(headingLevel, groupName, adapter, members, linkGenerator) {
|
|
102
|
-
return {
|
|
103
|
-
headingLevel: headingLevel,
|
|
104
|
-
heading: groupName,
|
|
105
|
-
groupDescription: members[0].groupDescription, // All fields in the group have the same description
|
|
106
|
-
value: toFlat(members, adapter, linkGenerator, headingLevel + 1),
|
|
107
|
-
};
|
|
108
|
-
}
|
|
109
|
-
//# sourceMappingURL=apex-types.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"apex-types.js","sourceRoot":"","sources":["../../src/adapters/apex-types.ts"],"names":[],"mappings":";;AAoBA,oDAoBC;AA+CD,wEAeC;AA5FD,mDAAsE;AAOtE,yEAA2E;AAC3E,mEAA+D;AAE/D,SAAgB,oBAAoB,CAClC,IAAU,EACV,aAA6C,EAC7C,SAAkB;IAElB,SAAS,aAAa;QACpB,QAAQ,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,KAAK,MAAM;gBACT,OAAO,oBAAoB,CAAC,IAAkB,EAAE,aAAa,CAAC,CAAC;YACjE,KAAK,WAAW;gBACd,OAAO,8BAA8B,CAAC,IAAuB,EAAE,aAAa,CAAC,CAAC;YAChF,KAAK,OAAO;gBACV,OAAO,sBAAsB,CAAC,IAAuC,EAAE,aAAa,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAED,uCACK,aAAa,EAAE,KAClB,SAAS,IACT;AACJ,CAAC;AAED,SAAS,eAAe,CACtB,IAAgD,EAChD,aAA6C,EAC7C,gBAAwB;IAExB,SAAS,UAAU,CAAC,IAAU;QAC5B,MAAM,SAAS,GAAG;YAChB,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,WAAW;YACtB,IAAI,EAAE,MAAM;SACb,CAAC;QAEF,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC;QACzB,GAAG,EAAE,IAAA,iCAAiB,EAAC,IAAI,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACjE,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE;YACJ,cAAc,EAAE,IAAI,CAAC,eAAe;SACrC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAAoB,EACpB,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,MAAM,IACT,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAC7D,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;gBAAC,OAAA,iCACjC,IAAA,gCAAgB,EAAC,MAAA,KAAK,CAAC,UAAU,0CAAE,gBAAgB,EAAE,aAAa,CAAC,KACtE,KAAK,EAAE,KAAK,CAAC,IAAI,IACjB,CAAA;aAAA,CAAC;SACJ,IACD;AACJ,CAAC;AAED,SAAgB,8BAA8B,CAC5C,aAA8B,EAC9B,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,WAAW,IACd,eAAe,CAAC,aAAa,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAClE,OAAO,EAAE,aAAa,CAAC,mBAAmB,CAAC,GAAG,CAAC,aAAa,CAAC,EAC7D,OAAO,EAAE;YACP,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,sCAAW,EAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CAAC;SACvG,IACD;AACJ,CAAC;AAED,SAAS,sBAAsB,CAC7B,SAA0C,EAC1C,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,OAAO,IACV,eAAe,CAAC,SAAS,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAC9D,aAAa,EAAE,SAAS,CAAC,aAAa,EACtC,eAAe,EAAE,SAAS,CAAC,eAAe,EAC1C,UAAU,EAAE,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,EAC/D,OAAO,EAAE,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAC,EACtD,OAAO,EAAE,YAAY,CAAC,SAAS,EAAE,SAAS,CAAC,OAAO,EAAE,sCAAW,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,EACrG,YAAY,EAAE,YAAY,CACxB,cAAc,EACd,SAAS,CAAC,YAAY,EACtB,CAAC,WAAW,EAAE,aAAa,EAAE,gBAAgB,EAAE,EAAE,CAC/C,IAAA,2CAAgB,EAAC,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,gBAAgB,CAAC,EAChF,aAAa,EACb,gBAAgB,GAAG,CAAC,CACrB,EACD,MAAM,EAAE,YAAY,CAClB,QAAQ,EACR,SAAS,CAAC,MAAsC,EAChD,4CAAoB,EACpB,aAAa,EACb,gBAAgB,GAAG,CAAC,CACrB,EACD,UAAU,EAAE,YAAY,CACtB,YAAY,EACZ,SAAS,CAAC,UAA6C,EACvD,4CAAoB,EACpB,aAAa,EACb,gBAAgB,GAAG,CAAC,CACrB,EACD,YAAY,EAAE;YACZ,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAC1C,sBAAsB,iCAAM,UAAU,KAAE,gBAAgB,EAAE,EAAE,KAAI,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CACrG;SACF,EACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,oBAAoB,CAAC,SAAS,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CAAC;SAChH,EACD,eAAe,EAAE;YACf,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CACjD,8BAA8B,CAAC,cAAc,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CACpF;SACF,IACD;AACJ,CAAC;AAID,SAAS,YAAY,CACnB,OAAe,EACf,OAAY,EACZ,OAAkG,EAClG,yBAAyD,EACzD,YAAoB;IAEpB,OAAO;QACL,YAAY;QACZ,OAAO;QACP,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC;QAC5B,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;YACtB,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,YAAY,GAAG,CAAC,CAAC;YACjF,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,YAAY,GAAG,CAAC,CAAC;KAC1E,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,OAAoB;IACpC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,MAAM,CACb,OAAY,EACZ,OAAkG,EAClG,aAA6C,EAC7C,gBAAwB;IAExB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,gBAAgB,CACvB,OAAY,EACZ,OAAkG,EAClG,aAA6C,EAC7C,gBAAwB;IAExB,MAAM,cAAc,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,EAAE,CACjE,WAAW,CAAC,gBAAgB,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,CAAC,CAC1E,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAsB,OAAY;IACzD,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;;QACd,MAAM,SAAS,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,OAAO,CAAC;QAC1C,GAAG,CAAC,SAAS,CAAC,GAAG,MAAA,GAAG,CAAC,SAAS,CAAC,mCAAI,EAAE,CAAC;QACtC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAyB,CAC1B,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAClB,YAAoB,EACpB,SAAiB,EACjB,OAAkG,EAClG,OAAY,EACZ,aAA6C;IAE7C,OAAO;QACL,YAAY,EAAE,YAAY;QAC1B,OAAO,EAAE,SAAS;QAClB,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,gBAAgB,EAAE,oDAAoD;QACnG,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,YAAY,GAAG,CAAC,CAAC;KACjE,CAAC;AACJ,CAAC"}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { RenderableDocumentation, RenderableContent } from '../core/renderable/types';
|
|
2
|
-
import { Describable, Documentable } from './types';
|
|
3
|
-
import { GetRenderableContentByTypeName } from './references';
|
|
4
|
-
export declare function adaptDescribable(describable: Describable, linkGenerator: GetRenderableContentByTypeName): {
|
|
5
|
-
description?: RenderableContent[];
|
|
6
|
-
};
|
|
7
|
-
export declare function adaptDocumentable(documentable: Documentable, linkGenerator: GetRenderableContentByTypeName, subHeadingLevel: number): RenderableDocumentation;
|
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.adaptDescribable = adaptDescribable;
|
|
4
|
-
exports.adaptDocumentable = adaptDocumentable;
|
|
5
|
-
const references_1 = require("./references");
|
|
6
|
-
const type_utils_1 = require("./type-utils");
|
|
7
|
-
function adaptDescribable(describable, linkGenerator) {
|
|
8
|
-
function describableToRenderableContent(describable) {
|
|
9
|
-
if (!describable) {
|
|
10
|
-
return;
|
|
11
|
-
}
|
|
12
|
-
return (describable
|
|
13
|
-
.map((line) => [
|
|
14
|
-
...(0, references_1.replaceInlineReferences)(line, linkGenerator),
|
|
15
|
-
{
|
|
16
|
-
type: 'empty-line',
|
|
17
|
-
},
|
|
18
|
-
])
|
|
19
|
-
.flatMap((line) => line)
|
|
20
|
-
// If the last element is an empty line, remove it
|
|
21
|
-
.filter((line, index, lines) => !((0, type_utils_1.isEmptyLine)(line) && index === lines.length - 1)));
|
|
22
|
-
}
|
|
23
|
-
return {
|
|
24
|
-
description: describableToRenderableContent(describable),
|
|
25
|
-
};
|
|
26
|
-
}
|
|
27
|
-
function adaptDocumentable(documentable, linkGenerator, subHeadingLevel) {
|
|
28
|
-
var _a, _b, _c;
|
|
29
|
-
function extractCustomTags(type) {
|
|
30
|
-
var _a, _b;
|
|
31
|
-
const baseTags = ['description', 'group', 'author', 'date', 'see', 'example', 'mermaid', 'throws', 'exception'];
|
|
32
|
-
return ((_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => !baseTags.includes(currentAnnotation.name.toLowerCase())).map((currentAnnotation) => (Object.assign(Object.assign({}, adaptDescribable(currentAnnotation.bodyLines, linkGenerator)), { name: currentAnnotation.name })))) !== null && _b !== void 0 ? _b : []);
|
|
33
|
-
}
|
|
34
|
-
function extractAnnotationBodyLines(type, annotationName) {
|
|
35
|
-
var _a, _b;
|
|
36
|
-
return (_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName)) === null || _b === void 0 ? void 0 : _b.bodyLines;
|
|
37
|
-
}
|
|
38
|
-
function extractAnnotationBody(type, annotationName) {
|
|
39
|
-
var _a, _b;
|
|
40
|
-
return (_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName)) === null || _b === void 0 ? void 0 : _b.body;
|
|
41
|
-
}
|
|
42
|
-
function extractSeeAnnotations(type) {
|
|
43
|
-
var _a, _b;
|
|
44
|
-
return ((_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => currentAnnotation.name.toLowerCase() === 'see').map((currentAnnotation) => currentAnnotation.body)) !== null && _b !== void 0 ? _b : []);
|
|
45
|
-
}
|
|
46
|
-
return Object.assign(Object.assign({}, adaptDescribable((_a = documentable.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines, linkGenerator)), { annotations: documentable.annotations.map((annotation) => annotation.type.toUpperCase()), customTags: extractCustomTags(documentable), mermaid: {
|
|
47
|
-
headingLevel: subHeadingLevel,
|
|
48
|
-
heading: 'Diagram',
|
|
49
|
-
value: extractAnnotationBodyLines(documentable, 'mermaid'),
|
|
50
|
-
}, example: {
|
|
51
|
-
headingLevel: subHeadingLevel,
|
|
52
|
-
heading: 'Example',
|
|
53
|
-
value: (_c = (_b = documentable.docComment) === null || _b === void 0 ? void 0 : _b.exampleAnnotation) === null || _c === void 0 ? void 0 : _c.bodyLines,
|
|
54
|
-
}, group: extractAnnotationBody(documentable, 'group'), author: extractAnnotationBody(documentable, 'author'), date: extractAnnotationBody(documentable, 'date'), sees: extractSeeAnnotations(documentable).map(linkGenerator) });
|
|
55
|
-
}
|
|
56
|
-
//# sourceMappingURL=documentables.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"documentables.js","sourceRoot":"","sources":["../../src/adapters/documentables.ts"],"names":[],"mappings":";;AAKA,4CA4BC;AAED,8CAyDC;AA1FD,6CAAuF;AACvF,6CAA2C;AAE3C,SAAgB,gBAAgB,CAC9B,WAAwB,EACxB,aAA6C;IAI7C,SAAS,8BAA8B,CAAC,WAAwB;QAC9D,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,OAAO,CACL,WAAW;aACR,GAAG,CAAsB,CAAC,IAAI,EAAE,EAAE,CAAC;YAClC,GAAG,IAAA,oCAAuB,EAAC,IAAI,EAAE,aAAa,CAAC;YAC/C;gBACE,IAAI,EAAE,YAAY;aACnB;SACF,CAAC;aACD,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;YACxB,kDAAkD;aACjD,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAA,wBAAW,EAAC,IAAI,CAAC,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACtF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,WAAW,EAAE,8BAA8B,CAAC,WAAW,CAAC;KACzD,CAAC;AACJ,CAAC;AAED,SAAgB,iBAAiB,CAC/B,YAA0B,EAC1B,aAA6C,EAC7C,eAAuB;;IAEvB,SAAS,iBAAiB,CAAC,IAAkB;;QAC3C,MAAM,QAAQ,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAEhH,OAAO,CACL,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CACzB,MAAM,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EACtF,GAAG,CAAY,CAAC,iBAAiB,EAAE,EAAE,CAAC,iCAClC,gBAAgB,CAAC,iBAAiB,CAAC,SAAS,EAAE,aAAa,CAAC,KAC/D,IAAI,EAAE,iBAAiB,CAAC,IAAI,IAC5B,CAAC,mCAAI,EAAE,CACZ,CAAC;IACJ,CAAC;IAED,SAAS,0BAA0B,CAAC,IAAkB,EAAE,cAAsB;;QAC5E,OAAO,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACtC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAC/E,0CAAE,SAAS,CAAC;IACf,CAAC;IAED,SAAS,qBAAqB,CAAC,IAAkB,EAAE,cAAsB;;QACvE,OAAO,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACtC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAC/E,0CAAE,IAAI,CAAC;IACV,CAAC;IAED,SAAS,qBAAqB,CAAC,IAAkB;;QAC/C,OAAO,CACL,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CACzB,MAAM,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,EAC5E,GAAG,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,mCAAI,EAAE,CAC5D,CAAC;IACJ,CAAC;IAED,uCACK,gBAAgB,CAAC,MAAA,YAAY,CAAC,UAAU,0CAAE,gBAAgB,EAAE,aAAa,CAAC,KAC7E,WAAW,EAAE,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EACxF,UAAU,EAAE,iBAAiB,CAAC,YAAY,CAAC,EAC3C,OAAO,EAAE;YACP,YAAY,EAAE,eAAe;YAC7B,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,0BAA0B,CAAC,YAAY,EAAE,SAAS,CAAC;SAC3D,EACD,OAAO,EAAE;YACP,YAAY,EAAE,eAAe;YAC7B,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,MAAA,MAAA,YAAY,CAAC,UAAU,0CAAE,iBAAiB,0CAAE,SAAS;SAC7D,EACD,KAAK,EAAE,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,EACnD,MAAM,EAAE,qBAAqB,CAAC,YAAY,EAAE,QAAQ,CAAC,EACrD,IAAI,EAAE,qBAAqB,CAAC,YAAY,EAAE,MAAM,CAAC,EACjD,IAAI,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,IAC5D;AACJ,CAAC"}
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from '../model/inheritance';
|
|
2
|
-
import { RenderableField } from '../core/renderable/types';
|
|
3
|
-
import { GetRenderableContentByTypeName } from './references';
|
|
4
|
-
export declare function adaptFieldOrProperty(field: FieldMirrorWithInheritance | PropertyMirrorWithInheritance, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel: number): RenderableField;
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.adaptFieldOrProperty = adaptFieldOrProperty;
|
|
4
|
-
const documentables_1 = require("./documentables");
|
|
5
|
-
function adaptFieldOrProperty(field, linkGenerator, baseHeadingLevel) {
|
|
6
|
-
function buildSignature() {
|
|
7
|
-
const { access_modifier, name } = field;
|
|
8
|
-
const memberModifiers = field.memberModifiers.join(' ');
|
|
9
|
-
return (`${access_modifier} ${memberModifiers} ${name}`
|
|
10
|
-
// remove double spaces
|
|
11
|
-
.replace(/ {2}/g, ' '));
|
|
12
|
-
}
|
|
13
|
-
return {
|
|
14
|
-
headingLevel: baseHeadingLevel,
|
|
15
|
-
doc: (0, documentables_1.adaptDocumentable)(field, linkGenerator, baseHeadingLevel + 1),
|
|
16
|
-
heading: field.name,
|
|
17
|
-
type: {
|
|
18
|
-
headingLevel: baseHeadingLevel + 1,
|
|
19
|
-
heading: 'Type',
|
|
20
|
-
value: linkGenerator(field.typeReference.rawDeclaration),
|
|
21
|
-
},
|
|
22
|
-
inherited: field.inherited,
|
|
23
|
-
accessModifier: field.access_modifier,
|
|
24
|
-
signature: {
|
|
25
|
-
headingLevel: baseHeadingLevel + 1,
|
|
26
|
-
heading: 'Signature',
|
|
27
|
-
value: [buildSignature()],
|
|
28
|
-
},
|
|
29
|
-
};
|
|
30
|
-
}
|
|
31
|
-
//# sourceMappingURL=fields-and-properties.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"fields-and-properties.js","sourceRoot":"","sources":["../../src/adapters/fields-and-properties.ts"],"names":[],"mappings":";;AAKA,oDAgCC;AAnCD,mDAAoD;AAGpD,SAAgB,oBAAoB,CAClC,KAAiE,EACjE,aAA6C,EAC7C,gBAAwB;IAExB,SAAS,cAAc;QACrB,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QACxC,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxD,OAAO,CACL,GAAG,eAAe,IAAI,eAAe,IAAI,IAAI,EAAE;YAC7C,uBAAuB;aACtB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CACzB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,GAAG,EAAE,IAAA,iCAAiB,EAAC,KAAK,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QAClE,OAAO,EAAE,KAAK,CAAC,IAAI;QACnB,IAAI,EAAE;YACJ,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC;SACzD;QACD,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,cAAc,EAAE,KAAK,CAAC,eAAe;QACrC,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC,cAAc,EAAE,CAAC;SAC1B;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import { ConstructorMirror, MethodMirror } from '@cparra/apex-reflection';
|
|
2
|
-
import { RenderableConstructor, RenderableMethod } from '../core/renderable/types';
|
|
3
|
-
import { GetRenderableContentByTypeName } from './references';
|
|
4
|
-
export declare function adaptMethod(method: MethodMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel: number): RenderableMethod;
|
|
5
|
-
export declare function adaptConstructor(typeName: string, constructor: ConstructorMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel: number): RenderableConstructor;
|
|
@@ -1,91 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.adaptMethod = adaptMethod;
|
|
4
|
-
exports.adaptConstructor = adaptConstructor;
|
|
5
|
-
const documentables_1 = require("./documentables");
|
|
6
|
-
function adaptMethod(method, linkGenerator, baseHeadingLevel) {
|
|
7
|
-
var _a, _b, _c;
|
|
8
|
-
function buildTitle(method) {
|
|
9
|
-
const { name, parameters } = method;
|
|
10
|
-
const parametersString = parameters.map((param) => param.name).join(', ');
|
|
11
|
-
return `${name}(${parametersString})`;
|
|
12
|
-
}
|
|
13
|
-
function buildSignature(method) {
|
|
14
|
-
const { access_modifier, typeReference, name, memberModifiers } = method;
|
|
15
|
-
const parameters = method.parameters
|
|
16
|
-
.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`)
|
|
17
|
-
.join(', ');
|
|
18
|
-
const members = memberModifiers.length > 0 ? `${memberModifiers.join(' ')} ` : '';
|
|
19
|
-
return `${access_modifier} ${members}${typeReference.rawDeclaration} ${name}(${parameters})`;
|
|
20
|
-
}
|
|
21
|
-
return {
|
|
22
|
-
headingLevel: baseHeadingLevel,
|
|
23
|
-
doc: (0, documentables_1.adaptDocumentable)(method, linkGenerator, baseHeadingLevel + 1),
|
|
24
|
-
heading: buildTitle(method),
|
|
25
|
-
signature: {
|
|
26
|
-
headingLevel: baseHeadingLevel + 1,
|
|
27
|
-
heading: 'Signature',
|
|
28
|
-
value: [buildSignature(method)],
|
|
29
|
-
},
|
|
30
|
-
returnType: {
|
|
31
|
-
headingLevel: baseHeadingLevel + 1,
|
|
32
|
-
heading: 'Return Type',
|
|
33
|
-
value: Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)((_b = (_a = method.docComment) === null || _a === void 0 ? void 0 : _a.returnAnnotation) === null || _b === void 0 ? void 0 : _b.bodyLines, linkGenerator)), { type: linkGenerator(method.typeReference.rawDeclaration) }),
|
|
34
|
-
},
|
|
35
|
-
throws: {
|
|
36
|
-
headingLevel: baseHeadingLevel + 1,
|
|
37
|
-
heading: 'Throws',
|
|
38
|
-
value: (_c = method.docComment) === null || _c === void 0 ? void 0 : _c.throwsAnnotations.map((thrown) => mapThrows(thrown, linkGenerator)),
|
|
39
|
-
},
|
|
40
|
-
parameters: {
|
|
41
|
-
headingLevel: baseHeadingLevel + 1,
|
|
42
|
-
heading: 'Parameters',
|
|
43
|
-
value: method.parameters.map((param) => mapParameters(method, param, linkGenerator)),
|
|
44
|
-
},
|
|
45
|
-
inherited: method.inherited,
|
|
46
|
-
};
|
|
47
|
-
}
|
|
48
|
-
function adaptConstructor(typeName, constructor, linkGenerator, baseHeadingLevel) {
|
|
49
|
-
var _a;
|
|
50
|
-
function buildTitle(name, constructor) {
|
|
51
|
-
const { parameters } = constructor;
|
|
52
|
-
const parametersString = parameters.map((param) => param.name).join(', ');
|
|
53
|
-
return `${name}(${parametersString})`;
|
|
54
|
-
}
|
|
55
|
-
function buildSignature(name, constructor) {
|
|
56
|
-
const { access_modifier } = constructor;
|
|
57
|
-
const parameters = constructor.parameters
|
|
58
|
-
.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`)
|
|
59
|
-
.join(', ');
|
|
60
|
-
return `${access_modifier} ${name}(${parameters})`;
|
|
61
|
-
}
|
|
62
|
-
return {
|
|
63
|
-
doc: (0, documentables_1.adaptDocumentable)(constructor, linkGenerator, baseHeadingLevel + 1),
|
|
64
|
-
headingLevel: baseHeadingLevel,
|
|
65
|
-
heading: buildTitle(typeName, constructor),
|
|
66
|
-
signature: {
|
|
67
|
-
headingLevel: baseHeadingLevel + 1,
|
|
68
|
-
heading: 'Signature',
|
|
69
|
-
value: [buildSignature(typeName, constructor)],
|
|
70
|
-
},
|
|
71
|
-
parameters: {
|
|
72
|
-
headingLevel: baseHeadingLevel + 1,
|
|
73
|
-
heading: 'Parameters',
|
|
74
|
-
value: constructor.parameters.map((param) => mapParameters(constructor, param, linkGenerator)),
|
|
75
|
-
},
|
|
76
|
-
throws: {
|
|
77
|
-
headingLevel: baseHeadingLevel + 1,
|
|
78
|
-
heading: 'Throws',
|
|
79
|
-
value: (_a = constructor.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.map((thrown) => mapThrows(thrown, linkGenerator)),
|
|
80
|
-
},
|
|
81
|
-
};
|
|
82
|
-
}
|
|
83
|
-
function mapParameters(documentable, param, linkGenerator) {
|
|
84
|
-
var _a;
|
|
85
|
-
const paramAnnotation = (_a = documentable.docComment) === null || _a === void 0 ? void 0 : _a.paramAnnotations.find((pa) => pa.paramName.toLowerCase() === param.name.toLowerCase());
|
|
86
|
-
return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(paramAnnotation === null || paramAnnotation === void 0 ? void 0 : paramAnnotation.bodyLines, linkGenerator)), { name: param.name, type: linkGenerator(param.typeReference.rawDeclaration) });
|
|
87
|
-
}
|
|
88
|
-
function mapThrows(thrown, linkGenerator) {
|
|
89
|
-
return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(thrown.bodyLines, linkGenerator)), { type: linkGenerator(thrown.exceptionName) });
|
|
90
|
-
}
|
|
91
|
-
//# sourceMappingURL=methods-and-constructors.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"methods-and-constructors.js","sourceRoot":"","sources":["../../src/adapters/methods-and-constructors.ts"],"names":[],"mappings":";;AAOA,kCAiDC;AAED,4CAwCC;AA/FD,mDAAsE;AAItE,SAAgB,WAAW,CACzB,MAAoB,EACpB,aAA6C,EAC7C,gBAAwB;;IAExB,SAAS,UAAU,CAAC,MAAmC;QACrD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACpC,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,IAAI,IAAI,gBAAgB,GAAG,CAAC;IACxC,CAAC;IAED,SAAS,cAAc,CAAC,MAAmC;QACzD,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACzE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU;aACjC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACrE,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAClF,OAAO,GAAG,eAAe,IAAI,OAAO,GAAG,aAAa,CAAC,cAAc,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;IAC/F,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,GAAG,EAAE,IAAA,iCAAiB,EAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACnE,OAAO,EAAE,UAAU,CAAC,MAAqC,CAAC;QAC1D,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC,cAAc,CAAC,MAAqC,CAAC,CAAC;SAC/D;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,aAAa;YACtB,KAAK,kCACA,IAAA,gCAAgB,EAAC,MAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,gBAAgB,0CAAE,SAAS,EAAE,aAAa,CAAC,KAClF,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,GACzD;SACF;QACD,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;SAC9F;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;SACrF;QACD,SAAS,EAAG,MAAsC,CAAC,SAAS;KAC7D,CAAC;AACJ,CAAC;AAED,SAAgB,gBAAgB,CAC9B,QAAgB,EAChB,WAA8B,EAC9B,aAA6C,EAC7C,gBAAwB;;IAExB,SAAS,UAAU,CAAC,IAAY,EAAE,WAA8B;QAC9D,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;QACnC,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,IAAI,IAAI,gBAAgB,GAAG,CAAC;IACxC,CAAC;IAED,SAAS,cAAc,CAAC,IAAY,EAAE,WAA8B;QAClE,MAAM,EAAE,eAAe,EAAE,GAAG,WAAW,CAAC;QACxC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU;aACtC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACrE,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,GAAG,eAAe,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;IACrD,CAAC;IAED,OAAO;QACL,GAAG,EAAE,IAAA,iCAAiB,EAAC,WAAW,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACxE,YAAY,EAAE,gBAAgB;QAC9B,OAAO,EAAE,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC;QAC1C,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;SAC/C;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;SAC/F;QACD,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,MAAA,WAAW,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;SACnG;KACF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CACpB,YAA0B,EAC1B,KAAsB,EACtB,aAA6C;;IAE7C,MAAM,eAAe,GAAG,MAAA,YAAY,CAAC,UAAU,0CAAE,gBAAgB,CAAC,IAAI,CACpE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAChE,CAAC;IACF,uCACK,IAAA,gCAAgB,EAAC,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,SAAS,EAAE,aAAa,CAAC,KAC9D,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,IACvD;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,MAAwB,EAAE,aAA6C;IACxF,uCACK,IAAA,gCAAgB,EAAC,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC,KACpD,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,IACzC;AACJ,CAAC"}
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import { RenderableContent, StringOrLink } from '../core/renderable/types';
|
|
2
|
-
export type GetRenderableContentByTypeName = (typeName: string) => StringOrLink;
|
|
3
|
-
export declare const linkFromTypeNameGenerator: GetRenderableContentByTypeName;
|
|
4
|
-
export declare function replaceInlineReferences(text: string, linkReplacer?: GetRenderableContentByTypeName, emailReplacer?: GetRenderableContentByTypeName): RenderableContent[];
|
|
5
|
-
export declare function replaceInlineEmails(renderableContents: RenderableContent[], getLinkByTypeName: GetRenderableContentByTypeName): RenderableContent[];
|
|
@@ -1,82 +0,0 @@
|
|
|
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.linkFromTypeNameGenerator = void 0;
|
|
7
|
-
exports.replaceInlineReferences = replaceInlineReferences;
|
|
8
|
-
exports.replaceInlineEmails = replaceInlineEmails;
|
|
9
|
-
const class_file_generatorHelper_1 = __importDefault(require("../transpiler/markdown/class-file-generatorHelper"));
|
|
10
|
-
exports.linkFromTypeNameGenerator = class_file_generatorHelper_1.default.getRenderableLinkByTypeName;
|
|
11
|
-
function defaultGetEmailByReference(email) {
|
|
12
|
-
return {
|
|
13
|
-
title: email,
|
|
14
|
-
url: `mailto:${email}`,
|
|
15
|
-
};
|
|
16
|
-
}
|
|
17
|
-
function replaceInlineReferences(text, linkReplacer = exports.linkFromTypeNameGenerator, emailReplacer = defaultGetEmailByReference) {
|
|
18
|
-
return replaceInlineEmails(replaceInlineLinks([text], linkReplacer), emailReplacer);
|
|
19
|
-
}
|
|
20
|
-
function replaceInlineLinks(renderableContents, getLinkByTypeName) {
|
|
21
|
-
return renderableContents.flatMap((renderableContent) => inlineLinkContent(renderableContent, getLinkByTypeName));
|
|
22
|
-
}
|
|
23
|
-
function inlineLinkContent(renderableContent, getLinkByTypeName) {
|
|
24
|
-
if (typeof renderableContent !== 'string') {
|
|
25
|
-
return [renderableContent];
|
|
26
|
-
}
|
|
27
|
-
const text = renderableContent;
|
|
28
|
-
// Matches either `<<ClassName>>` or `{@link ClassName}`
|
|
29
|
-
const linkFormatRegEx = '{@link (.*?)}|<<([^>]+)>>';
|
|
30
|
-
const matches = match(linkFormatRegEx, text);
|
|
31
|
-
return createRenderableContents(matches, text, getLinkByTypeName);
|
|
32
|
-
}
|
|
33
|
-
function replaceInlineEmails(renderableContents, getLinkByTypeName) {
|
|
34
|
-
return renderableContents.flatMap((renderableContent) => inlineEmailContent(renderableContent, getLinkByTypeName));
|
|
35
|
-
}
|
|
36
|
-
function inlineEmailContent(renderableContent, getLinkByTypeName) {
|
|
37
|
-
if (typeof renderableContent !== 'string') {
|
|
38
|
-
return [renderableContent];
|
|
39
|
-
}
|
|
40
|
-
const text = renderableContent;
|
|
41
|
-
// Parsing references using the format '{@email email}'
|
|
42
|
-
const linkFormatRegEx = '{@email (.*?)}';
|
|
43
|
-
const matches = match(linkFormatRegEx, text);
|
|
44
|
-
return createRenderableContents(matches, text, getLinkByTypeName);
|
|
45
|
-
}
|
|
46
|
-
function match(regex, text) {
|
|
47
|
-
const expression = new RegExp(regex, 'gi');
|
|
48
|
-
let match;
|
|
49
|
-
const matches = [];
|
|
50
|
-
do {
|
|
51
|
-
match = expression.exec(text);
|
|
52
|
-
if (match) {
|
|
53
|
-
matches.push(match);
|
|
54
|
-
}
|
|
55
|
-
} while (match);
|
|
56
|
-
return matches;
|
|
57
|
-
}
|
|
58
|
-
function createRenderableContents(matches, text, linker) {
|
|
59
|
-
if (matches.length === 0) {
|
|
60
|
-
return [text];
|
|
61
|
-
}
|
|
62
|
-
const result = [];
|
|
63
|
-
let lastIndex = 0;
|
|
64
|
-
for (const match of matches) {
|
|
65
|
-
const index = match.index;
|
|
66
|
-
const length = match[0].length;
|
|
67
|
-
// loop through the matches (skip the first one, which is the full match)
|
|
68
|
-
// until we find the first capturing group that has a value
|
|
69
|
-
const capturedGroup = match.slice(1).find((group) => group);
|
|
70
|
-
if (!capturedGroup) {
|
|
71
|
-
continue;
|
|
72
|
-
}
|
|
73
|
-
result.push(text.slice(lastIndex, index));
|
|
74
|
-
result.push(linker(capturedGroup));
|
|
75
|
-
lastIndex = index + length;
|
|
76
|
-
}
|
|
77
|
-
if (lastIndex < text.length) {
|
|
78
|
-
result.push(text.slice(lastIndex));
|
|
79
|
-
}
|
|
80
|
-
return result;
|
|
81
|
-
}
|
|
82
|
-
//# sourceMappingURL=references.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"references.js","sourceRoot":"","sources":["../../src/adapters/references.ts"],"names":[],"mappings":";;;;;;AAeA,0DAMC;AAyBD,kDAKC;AAnDD,mHAAyF;AAK5E,QAAA,yBAAyB,GACpC,oCAAwB,CAAC,2BAA2B,CAAC;AAEvD,SAAS,0BAA0B,CAAC,KAAa;IAC/C,OAAO;QACL,KAAK,EAAE,KAAK;QACZ,GAAG,EAAE,UAAU,KAAK,EAAE;KACvB,CAAC;AACJ,CAAC;AAED,SAAgB,uBAAuB,CACrC,IAAY,EACZ,eAA+C,iCAAyB,EACxE,gBAAgD,0BAA0B;IAE1E,OAAO,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,EAAE,aAAa,CAAC,CAAC;AACtF,CAAC;AAED,SAAS,kBAAkB,CACzB,kBAAuC,EACvC,iBAAiD;IAEjD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,CAAC;AACpH,CAAC;AAED,SAAS,iBAAiB,CACxB,iBAAoC,EACpC,iBAAiD;IAEjD,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE,CAAC;QAC1C,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,IAAI,GAAG,iBAAiB,CAAC;IAE/B,wDAAwD;IACxD,MAAM,eAAe,GAAG,2BAA2B,CAAC;IACpD,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,wBAAwB,CAAC,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACpE,CAAC;AAED,SAAgB,mBAAmB,CACjC,kBAAuC,EACvC,iBAAiD;IAEjD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,CAAC;AACrH,CAAC;AAED,SAAS,kBAAkB,CACzB,iBAAoC,EACpC,iBAAiD;IAEjD,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE,CAAC;QAC1C,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,IAAI,GAAG,iBAAiB,CAAC;IAE/B,uDAAuD;IACvD,MAAM,eAAe,GAAG,gBAAgB,CAAC;IACzC,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,wBAAwB,CAAC,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACpE,CAAC;AAED,SAAS,KAAK,CAAC,KAAa,EAAE,IAAY;IACxC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3C,IAAI,KAAK,CAAC;IACV,MAAM,OAAO,GAAG,EAAE,CAAC;IAEnB,GAAG,CAAC;QACF,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,QAAQ,KAAK,EAAE;IAEhB,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,wBAAwB,CAAC,OAA0B,EAAE,IAAY,EAAE,MAAsC;IAChH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1B,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAE/B,yEAAyE;QACzE,2DAA2D;QAC3D,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,SAAS;QACX,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;QAEnC,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isEmptyLine = isEmptyLine;
|
|
4
|
-
function isEmptyLine(content) {
|
|
5
|
-
return Object.keys(content).includes('type') && content.type === 'empty-line';
|
|
6
|
-
}
|
|
7
|
-
//# sourceMappingURL=type-utils.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"type-utils.js","sourceRoot":"","sources":["../../src/adapters/type-utils.ts"],"names":[],"mappings":";;AAEA,kCAEC;AAFD,SAAgB,WAAW,CAAC,OAA0B;IACpD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAK,OAA4B,CAAC,IAAI,KAAK,YAAY,CAAC;AACtG,CAAC"}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { ReflectionResult } from '@cparra/apex-reflection';
|
|
2
|
-
import ApexBundle from '../model/apex-bundle';
|
|
3
|
-
/**
|
|
4
|
-
* Application entry-point to generate documentation out of Apex source files.
|
|
5
|
-
*/
|
|
6
|
-
export declare class Apexdocs {
|
|
7
|
-
/**
|
|
8
|
-
* Generates documentation out of Apex source files.
|
|
9
|
-
*/
|
|
10
|
-
static generate(): void;
|
|
11
|
-
private static filterByScopes;
|
|
12
|
-
static _reflectionWithLogger: (apexBundle: ApexBundle) => ReflectionResult;
|
|
13
|
-
}
|
|
@@ -1,86 +0,0 @@
|
|
|
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.Apexdocs = void 0;
|
|
7
|
-
const apex_file_reader_1 = require("../service/apex-file-reader");
|
|
8
|
-
const file_system_1 = require("../service/file-system");
|
|
9
|
-
const apex_reflection_1 = require("@cparra/apex-reflection");
|
|
10
|
-
const logger_1 = require("../util/logger");
|
|
11
|
-
const manifest_factory_1 = require("../service/manifest-factory");
|
|
12
|
-
const parser_1 = require("../service/parser");
|
|
13
|
-
const settings_1 = require("../settings");
|
|
14
|
-
const transpiler_1 = __importDefault(require("../transpiler/transpiler"));
|
|
15
|
-
const file_writer_1 = require("../service/file-writer");
|
|
16
|
-
const error_logger_1 = __importDefault(require("../util/error-logger"));
|
|
17
|
-
const types_repository_1 = require("../model/types-repository");
|
|
18
|
-
const factory_1 = require("../transpiler/factory");
|
|
19
|
-
const generate_markdown_files_1 = require("./flows/generate-markdown-files");
|
|
20
|
-
/**
|
|
21
|
-
* Application entry-point to generate documentation out of Apex source files.
|
|
22
|
-
*/
|
|
23
|
-
class Apexdocs {
|
|
24
|
-
/**
|
|
25
|
-
* Generates documentation out of Apex source files.
|
|
26
|
-
*/
|
|
27
|
-
static generate() {
|
|
28
|
-
logger_1.Logger.log('Initializing...');
|
|
29
|
-
const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
|
|
30
|
-
if (settings_1.Settings.getInstance().targetGenerator === 'plain-markdown') {
|
|
31
|
-
(0, generate_markdown_files_1.generateMarkdownFiles)(fileBodies);
|
|
32
|
-
}
|
|
33
|
-
else {
|
|
34
|
-
const manifest = (0, manifest_factory_1.createManifest)(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
|
|
35
|
-
types_repository_1.TypesRepository.getInstance().populateAll(manifest.types);
|
|
36
|
-
const filteredTypes = this.filterByScopes(manifest);
|
|
37
|
-
types_repository_1.TypesRepository.getInstance().populateScoped(filteredTypes);
|
|
38
|
-
const processor = factory_1.TypeTranspilerFactory.get(settings_1.Settings.getInstance().targetGenerator);
|
|
39
|
-
transpiler_1.default.generate(filteredTypes, processor);
|
|
40
|
-
const generatedFiles = processor.fileBuilder().files();
|
|
41
|
-
const files = [];
|
|
42
|
-
file_writer_1.FileWriter.write(generatedFiles, (file) => {
|
|
43
|
-
logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
|
|
44
|
-
files.push(file);
|
|
45
|
-
});
|
|
46
|
-
settings_1.Settings.getInstance().onAfterProcess(files);
|
|
47
|
-
// Error logging
|
|
48
|
-
error_logger_1.default.logErrors(filteredTypes);
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
static filterByScopes(manifest) {
|
|
52
|
-
let filteredTypes;
|
|
53
|
-
let filteredLogMessage;
|
|
54
|
-
if (settings_1.Settings.getInstance().config.targetGenerator !== 'openapi') {
|
|
55
|
-
filteredTypes = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
|
|
56
|
-
filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${settings_1.Settings.getInstance().scope}`;
|
|
57
|
-
}
|
|
58
|
-
else {
|
|
59
|
-
// If we are dealing with an OpenApi generator, we ignore the passed in access modifiers, and instead
|
|
60
|
-
// we only keep classes annotated as @RestResource
|
|
61
|
-
filteredTypes = manifest.filteredByAccessModifierAndAnnotations([
|
|
62
|
-
'restresource',
|
|
63
|
-
'httpdelete',
|
|
64
|
-
'httpget',
|
|
65
|
-
'httppatch',
|
|
66
|
-
'httppost',
|
|
67
|
-
'httpput',
|
|
68
|
-
]);
|
|
69
|
-
filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s), only keeping classes annotated as @RestResource.`;
|
|
70
|
-
}
|
|
71
|
-
logger_1.Logger.clear();
|
|
72
|
-
logger_1.Logger.logSingle(filteredLogMessage, false, 'green', false);
|
|
73
|
-
logger_1.Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
|
|
74
|
-
return filteredTypes;
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
exports.Apexdocs = Apexdocs;
|
|
78
|
-
Apexdocs._reflectionWithLogger = (apexBundle) => {
|
|
79
|
-
var _a;
|
|
80
|
-
const result = (0, apex_reflection_1.reflect)(apexBundle.rawTypeContent);
|
|
81
|
-
if (result.error) {
|
|
82
|
-
logger_1.Logger.error(`${apexBundle.filePath} - Parsing error ${(_a = result.error) === null || _a === void 0 ? void 0 : _a.message}`);
|
|
83
|
-
}
|
|
84
|
-
return result;
|
|
85
|
-
};
|
|
86
|
-
//# sourceMappingURL=Apexdocs.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;;;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,0EAAkD;AAClD,wDAAoD;AACpD,wEAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAC9D,6EAAwE;AAExE;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QAExE,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,KAAK,gBAAgB,EAAE,CAAC;YAChE,IAAA,+CAAqB,EAAC,UAAU,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;YAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;YACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;YAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;YAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;gBACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;gBACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;YAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAE7C,gBAAgB;YAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAChE,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;QACL,CAAC;aAAM,CAAC;YACN,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;QAC/D,CAAC;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AA5DH,4BAqEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
|
|
@@ -1,57 +0,0 @@
|
|
|
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
|