@cparra/apexdocs 2.25.0-alpha.1 → 2.25.0-alpha.10
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 +2963 -0
- package/dist/defaults-DUwru49Q.js +12 -0
- package/dist/defaults-SH0Rsi5E.js +11 -0
- package/dist/defaults-jLXD2y8-.js +13 -0
- package/dist/index.d.ts +101 -0
- package/dist/index.js +36 -0
- package/examples/markdown/docs/index.md +109 -0
- package/examples/{plain-markdown/docs/Miscellaneous/ns.BaseClass.md → markdown/docs/miscellaneous/BaseClass.md} +1 -1
- package/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md +72 -0
- package/examples/{plain-markdown/docs/Miscellaneous/ns.ParentInterface.md → markdown/docs/miscellaneous/ParentInterface.md} +1 -1
- package/examples/{plain-markdown/docs/Miscellaneous/ns.ReferencedEnum.md → markdown/docs/miscellaneous/ReferencedEnum.md} +1 -1
- package/examples/markdown/docs/miscellaneous/SampleException.md +24 -0
- package/examples/{plain-markdown/docs/Miscellaneous/ns.SampleInterface.md → markdown/docs/miscellaneous/SampleInterface.md} +29 -32
- package/examples/markdown/docs/miscellaneous/Url.md +309 -0
- package/examples/markdown/docs/sample-enums/SampleEnum.md +36 -0
- package/examples/{plain-markdown/docs/SampleGroup/ns.SampleClass.md → markdown/docs/samplegroup/SampleClass.md} +11 -14
- package/examples/markdown/force-app/classes/MultiInheritanceClass.cls +1 -0
- package/examples/markdown/force-app/classes/SampleException.cls +17 -0
- package/examples/markdown/force-app/classes/Url.cls +194 -0
- package/examples/{plain-markdown → markdown}/package.json +2 -2
- package/examples/vitepress/.forceignore +12 -0
- package/examples/vitepress/apexdocs.config.ts +106 -0
- package/examples/vitepress/config/project-scratch-def.json +13 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js +259 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/_metadata.json +40 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js +11474 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js +9172 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/package.json +3 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +4339 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +567 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vue.js +323 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vue.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/config.mts +21 -0
- package/examples/vitepress/docs/.vitepress/sidebar.json +119 -0
- package/examples/vitepress/docs/api-examples.md +49 -0
- package/examples/vitepress/docs/index-frontmatter.md +16 -0
- package/examples/vitepress/docs/index.md +56 -0
- package/examples/vitepress/docs/markdown-examples.md +85 -0
- package/examples/vitepress/docs/miscellaneous/BaseClass.md +20 -0
- package/examples/vitepress/docs/miscellaneous/MultiInheritanceClass.md +76 -0
- package/examples/vitepress/docs/miscellaneous/ParentInterface.md +19 -0
- package/examples/vitepress/docs/miscellaneous/ReferencedEnum.md +15 -0
- package/examples/vitepress/docs/miscellaneous/SampleException.md +28 -0
- package/examples/vitepress/docs/miscellaneous/SampleInterface.md +116 -0
- package/examples/vitepress/docs/miscellaneous/Url.md +317 -0
- package/examples/vitepress/docs/sample-enums/SampleEnum.md +40 -0
- package/examples/vitepress/docs/samplegroup/SampleClass.md +174 -0
- package/examples/vitepress/force-app/main/default/classes/BaseClass.cls +3 -0
- package/examples/vitepress/force-app/main/default/classes/MultiInheritanceClass.cls +1 -0
- package/examples/vitepress/force-app/main/default/classes/ParentInterface.cls +3 -0
- package/examples/vitepress/force-app/main/default/classes/ReferencedEnum.cls +5 -0
- package/examples/vitepress/force-app/main/default/classes/SampleClass.cls +72 -0
- package/examples/vitepress/force-app/main/default/classes/SampleEnum.cls +30 -0
- package/examples/vitepress/force-app/main/default/classes/SampleException.cls +17 -0
- package/examples/vitepress/force-app/main/default/classes/SampleInterface.cls +46 -0
- package/examples/vitepress/force-app/main/default/classes/Url.cls +198 -0
- package/examples/vitepress/package-lock.json +2574 -0
- package/examples/vitepress/package.json +18 -0
- package/examples/vitepress/sfdx-project.json +12 -0
- package/jest.config.js +2 -1
- package/package.json +18 -19
- package/src/application/Apexdocs.ts +17 -70
- package/src/application/__tests__/apex-file-reader.spec.ts +104 -0
- package/src/application/apex-file-reader.ts +42 -0
- package/src/application/file-writer.ts +21 -0
- package/src/application/generators/markdown.ts +58 -0
- package/src/application/generators/openapi.ts +56 -0
- package/src/cli/args.ts +43 -0
- package/src/cli/commands/markdown.ts +52 -0
- package/src/cli/generate.ts +10 -134
- package/src/core/manifest.ts +90 -0
- package/src/{__spec__/core → core/markdown/__test__}/expect-extensions.ts +5 -5
- package/src/core/markdown/__test__/generating-class-docs.spec.ts +735 -0
- package/src/{__spec__/core → core/markdown/__test__}/generating-enum-docs.spec.ts +89 -59
- package/src/{__spec__/core → core/markdown/__test__}/generating-interface-docs.spec.ts +105 -75
- package/src/{__spec__/core → core/markdown/__test__}/generating-reference-guide.spec.ts +43 -26
- package/src/core/markdown/__test__/inheritance-chain.test.ts +54 -0
- package/src/core/markdown/__test__/test-helpers.ts +23 -0
- package/src/core/markdown/adapters/__tests__/documentables.spec.ts +109 -0
- package/src/core/markdown/adapters/__tests__/interface-adapter.spec.ts +148 -0
- package/src/{adapters → core/markdown/adapters}/__tests__/references.spec.ts +23 -2
- package/src/{adapters → core/markdown/adapters}/apex-types.ts +58 -44
- package/src/{adapters → core/markdown/adapters}/documentables.ts +58 -35
- package/src/{adapters → core/markdown/adapters}/fields-and-properties.ts +18 -11
- package/src/{adapters/references.ts → core/markdown/adapters/inline.ts} +43 -13
- package/src/{adapters → core/markdown/adapters}/methods-and-constructors.ts +36 -20
- package/src/core/markdown/adapters/reference-guide.ts +35 -0
- package/src/core/markdown/adapters/renderable-bundle.ts +78 -0
- package/src/core/markdown/adapters/renderable-to-page-data.ts +89 -0
- package/src/core/markdown/adapters/type-utils.ts +13 -0
- package/src/core/{renderable → markdown/adapters}/types.d.ts +57 -8
- package/src/core/markdown/generate-docs.ts +216 -0
- package/src/core/markdown/reflection/error-handling.ts +37 -0
- package/src/core/markdown/reflection/filter-scope.ts +13 -0
- package/src/core/markdown/reflection/inheritance-chain-expanion.ts +22 -0
- package/src/core/markdown/reflection/inheritance-chain.ts +23 -0
- package/src/core/markdown/reflection/inherited-member-expansion.ts +105 -0
- package/src/core/markdown/reflection/reflect-source.ts +45 -0
- package/src/core/markdown/reflection/sort-members.ts +59 -0
- package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/class-template.ts +5 -3
- package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/constructors-partial-template.ts +2 -2
- package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/documentable-partial-template.ts +6 -4
- package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/fieldsPartialTemplate.ts +1 -1
- package/src/core/markdown/templates/hookable.ts +7 -0
- package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/methods-partial-template.ts +2 -2
- package/src/core/{templates → markdown/templates}/reference-guide.ts +1 -1
- package/src/core/{template.ts → markdown/templates/template.ts} +25 -19
- package/src/core/markdown/utils.ts +3 -0
- package/src/{transpiler → core}/openapi/__tests__/open-api-docs-processor.spec.ts +1 -1
- package/src/{model → core/openapi}/apex-type-wrappers/__tests__/ClassMirrorWrapper.spec.ts +3 -3
- package/src/core/openapi/file-container.ts +13 -0
- package/src/{service → core/openapi}/manifest-factory.ts +3 -3
- package/src/{transpiler → core}/openapi/open-api-docs-processor.ts +9 -10
- package/src/core/openapi/openapi-type-file.ts +12 -0
- package/src/{service → core/openapi}/parser.ts +8 -8
- package/src/{transpiler → core}/openapi/parsers/Builder.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/MethodParser.ts +5 -5
- package/src/{transpiler → core}/openapi/parsers/ParameterObjectBuilder.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/ReferenceBuilder.ts +3 -3
- package/src/{transpiler → core}/openapi/parsers/RequestBodyBuilder.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/ResponsesBuilder.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/MethodParser.spec.ts +1 -1
- package/src/{transpiler → core}/openapi/parsers/__tests__/ParameterObjectBuilder.spec.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/ReferenceBuilder.spec.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/RequestBodyBuilder.spec.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/ResponsesBuilder.spec.ts +1 -1
- package/src/{transpiler → core/openapi}/transpiler.ts +2 -6
- package/src/{model → core/openapi}/types-repository.ts +0 -9
- package/src/core/parse-apex-metadata.ts +14 -0
- package/src/core/settings.ts +56 -0
- package/src/core/shared/types.d.ts +131 -0
- package/src/core/shared/utils.ts +5 -0
- package/src/defaults.ts +9 -0
- package/src/index.ts +40 -2
- package/src/test-helpers/ClassMirrorBuilder.ts +14 -1
- package/src/test-helpers/InterfaceMirrorBuilder.ts +0 -5
- package/src/test-helpers/SettingsBuilder.ts +1 -4
- package/src/util/fp.ts +3 -0
- package/src/util/logger.ts +3 -3
- package/src/util/string-utils.ts +0 -4
- package/tsconfig.json +6 -2
- package/apexdocs.config.ts +0 -13
- 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/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +0 -7
- package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +0 -36
- package/examples/plain-markdown/docs/index.md +0 -36
- package/examples/plain-markdown/force-app/classes/SampleException.cls +0 -1
- package/examples/plain-markdown/template.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 -7
- package/lib/adapters/apex-types.js +0 -112
- 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 -32
- 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 -92
- 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 -80
- package/lib/application/Apexdocs.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/generate-docs.d.ts +0 -23
- package/lib/core/generate-docs.js +0 -241
- package/lib/core/generate-docs.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 -8
- 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 -18
- package/lib/test-helpers/ClassMirrorBuilder.js +0 -54
- 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/__spec__/core/generating-class-docs.spec.ts +0 -511
- package/src/adapters/__tests__/interface-adapter.spec.ts +0 -80
- package/src/adapters/type-utils.ts +0 -5
- package/src/adapters/types.d.ts +0 -8
- package/src/core/generate-docs.ts +0 -357
- package/src/model/apex-bundle.ts +0 -3
- package/src/model/inheritance.ts +0 -7
- package/src/model/manifest.ts +0 -84
- package/src/model/markdown-file.ts +0 -122
- package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +0 -50
- package/src/model/markdown-generation-util/field-declaration-util.ts +0 -71
- package/src/model/markdown-generation-util/index.ts +0 -3
- package/src/model/markdown-generation-util/method-declaration-util.ts +0 -166
- package/src/model/markdown-generation-util/type-declaration-util.ts +0 -91
- package/src/model/markdown-home-file.ts +0 -58
- package/src/model/markdown-type-file.ts +0 -165
- package/src/model/openapi/openapi-type-file.ts +0 -14
- package/src/model/outputFile.ts +0 -20
- package/src/service/__tests__/apex-file-reader.spec.ts +0 -92
- package/src/service/apex-file-reader.ts +0 -51
- package/src/service/file-writer.ts +0 -34
- package/src/service/metadata-processor.ts +0 -16
- package/src/service/state.ts +0 -24
- package/src/service/walkers/class-walker.ts +0 -30
- package/src/service/walkers/enum-walker.ts +0 -7
- package/src/service/walkers/interface-walker.ts +0 -12
- package/src/service/walkers/walker-factory.ts +0 -19
- package/src/service/walkers/walker.ts +0 -42
- package/src/settings.ts +0 -147
- package/src/transpiler/factory.ts +0 -33
- package/src/transpiler/file-container.ts +0 -13
- package/src/transpiler/generator-choices.ts +0 -1
- package/src/transpiler/markdown/class-file-generatorHelper.ts +0 -78
- package/src/transpiler/markdown/docsify/docsify-docs-processor.ts +0 -12
- package/src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts +0 -50
- package/src/transpiler/markdown/markdown-transpiler-base.ts +0 -28
- package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +0 -42
- package/src/transpiler/processor-type-transpiler.ts +0 -18
- /package/examples/{plain-markdown → markdown}/.forceignore +0 -0
- /package/examples/{plain-markdown → markdown}/config/project-scratch-def.json +0 -0
- /package/examples/{plain-markdown → markdown}/force-app/classes/BaseClass.cls +0 -0
- /package/examples/{plain-markdown → markdown}/force-app/classes/ParentInterface.cls +0 -0
- /package/examples/{plain-markdown → markdown}/force-app/classes/ReferencedEnum.cls +0 -0
- /package/examples/{plain-markdown → markdown}/force-app/classes/SampleClass.cls +0 -0
- /package/examples/{plain-markdown → markdown}/force-app/classes/SampleEnum.cls +0 -0
- /package/examples/{plain-markdown → markdown}/force-app/classes/SampleInterface.cls +0 -0
- /package/examples/{plain-markdown → markdown}/package-lock.json +0 -0
- /package/examples/{plain-markdown → markdown}/sfdx-project.json +0 -0
- /package/src/{service → application}/file-system.ts +0 -0
- /package/src/{model/__tests__ → core/__test__}/manifest.spec.ts +0 -0
- /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/enum-template.ts +0 -0
- /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/grouped-members-partial-template.ts +0 -0
- /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/interface-template.ts +0 -0
- /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/type-doc-partial.ts +0 -0
- /package/src/{service → core/openapi}/__tests__/manifest-factory.spec.ts +0 -0
- /package/src/{model → core}/openapi/__tests__/open-api.spec.ts +0 -0
- /package/src/{model → core}/openapi/apex-doc-types.ts +0 -0
- /package/src/{model → core/openapi}/apex-type-wrappers/ClassMirrorWrapper.ts +0 -0
- /package/src/{model → core/openapi}/apex-type-wrappers/MethodMirrorWrapper.ts +0 -0
- /package/src/{model → core}/openapi/open-api-types.ts +0 -0
- /package/src/{model → core}/openapi/open-api.ts +0 -0
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ParameterBuilder = exports.MethodMirrorBuilder = void 0;
|
|
4
|
-
class MethodMirrorBuilder {
|
|
5
|
-
constructor() {
|
|
6
|
-
this.name = 'sampleMethod';
|
|
7
|
-
this.annotations = [];
|
|
8
|
-
this.typeReference = {
|
|
9
|
-
type: 'void',
|
|
10
|
-
rawDeclaration: 'void',
|
|
11
|
-
};
|
|
12
|
-
this.parameters = [];
|
|
13
|
-
}
|
|
14
|
-
withName(name) {
|
|
15
|
-
this.name = name;
|
|
16
|
-
return this;
|
|
17
|
-
}
|
|
18
|
-
addAnnotation(annotation) {
|
|
19
|
-
this.annotations.push(annotation);
|
|
20
|
-
return this;
|
|
21
|
-
}
|
|
22
|
-
withDocComment(docComment) {
|
|
23
|
-
this.docComment = docComment;
|
|
24
|
-
return this;
|
|
25
|
-
}
|
|
26
|
-
withTypeReference(param) {
|
|
27
|
-
this.typeReference = param;
|
|
28
|
-
return this;
|
|
29
|
-
}
|
|
30
|
-
addParameter(parameter) {
|
|
31
|
-
this.parameters.push(parameter);
|
|
32
|
-
return this;
|
|
33
|
-
}
|
|
34
|
-
build() {
|
|
35
|
-
return {
|
|
36
|
-
access_modifier: 'public',
|
|
37
|
-
annotations: this.annotations,
|
|
38
|
-
name: this.name,
|
|
39
|
-
memberModifiers: [],
|
|
40
|
-
typeReference: this.typeReference,
|
|
41
|
-
parameters: this.parameters,
|
|
42
|
-
docComment: this.docComment,
|
|
43
|
-
};
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
exports.MethodMirrorBuilder = MethodMirrorBuilder;
|
|
47
|
-
class ParameterBuilder {
|
|
48
|
-
constructor() {
|
|
49
|
-
this.name = 'param';
|
|
50
|
-
this.typeReference = {
|
|
51
|
-
type: 'String',
|
|
52
|
-
rawDeclaration: 'String',
|
|
53
|
-
};
|
|
54
|
-
}
|
|
55
|
-
withName(name) {
|
|
56
|
-
this.name = name;
|
|
57
|
-
return this;
|
|
58
|
-
}
|
|
59
|
-
withTypeReference(param) {
|
|
60
|
-
this.typeReference = param;
|
|
61
|
-
return this;
|
|
62
|
-
}
|
|
63
|
-
build() {
|
|
64
|
-
return {
|
|
65
|
-
memberModifiers: [],
|
|
66
|
-
name: this.name,
|
|
67
|
-
typeReference: this.typeReference,
|
|
68
|
-
};
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
|
-
exports.ParameterBuilder = ParameterBuilder;
|
|
72
|
-
//# sourceMappingURL=MethodMirrorBuilder.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"MethodMirrorBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/MethodMirrorBuilder.ts"],"names":[],"mappings":";;;AAIA,MAAa,mBAAmB;IAAhC;QACU,SAAI,GAAG,cAAc,CAAC;QACtB,gBAAW,GAAiB,EAAE,CAAC;QAE/B,kBAAa,GAA6C;YAChE,IAAI,EAAE,MAAM;YACZ,cAAc,EAAE,MAAM;SACvB,CAAC;QACM,eAAU,GAAgB,EAAE,CAAC;IAsCvC,CAAC;IApCC,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,UAAsB;QAClC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,UAAsB;QACnC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iBAAiB,CAAC,KAA+C;QAC/D,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAY,CAAC,SAAoB;QAC/B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,eAAe,EAAE,EAAE;YACnB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;IACJ,CAAC;CACF;AA9CD,kDA8CC;AAED,MAAa,gBAAgB;IAA7B;QACU,SAAI,GAAG,OAAO,CAAC;QACf,kBAAa,GAA6C;YAChE,IAAI,EAAE,QAAQ;YACd,cAAc,EAAE,QAAQ;SACzB,CAAC;IAmBJ,CAAC;IAjBC,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iBAAiB,CAAC,KAA+C;QAC/D,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,eAAe,EAAE,EAAE;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;CACF;AAxBD,4CAwBC"}
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.SettingsBuilder = void 0;
|
|
4
|
-
/**
|
|
5
|
-
* Builder class to create SettingsConfig objects.
|
|
6
|
-
* For testing purposes only.
|
|
7
|
-
*/
|
|
8
|
-
class SettingsBuilder {
|
|
9
|
-
build() {
|
|
10
|
-
return {
|
|
11
|
-
sourceDirectory: './',
|
|
12
|
-
recursive: true,
|
|
13
|
-
scope: [],
|
|
14
|
-
outputDir: './',
|
|
15
|
-
targetGenerator: 'openapi',
|
|
16
|
-
indexOnly: false,
|
|
17
|
-
defaultGroupName: 'Misc',
|
|
18
|
-
sanitizeHtml: true,
|
|
19
|
-
openApiTitle: 'Apex API',
|
|
20
|
-
openApiFileName: 'openapi',
|
|
21
|
-
title: 'Classes',
|
|
22
|
-
includeMetadata: false,
|
|
23
|
-
};
|
|
24
|
-
}
|
|
25
|
-
}
|
|
26
|
-
exports.SettingsBuilder = SettingsBuilder;
|
|
27
|
-
//# sourceMappingURL=SettingsBuilder.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"SettingsBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/SettingsBuilder.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,eAAe;IAC1B,KAAK;QACH,OAAO;YACL,eAAe,EAAE,IAAI;YACrB,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,EAAE;YACT,SAAS,EAAE,IAAI;YACf,eAAe,EAAE,SAAS;YAC1B,SAAS,EAAE,KAAK;YAChB,gBAAgB,EAAE,MAAM;YACxB,YAAY,EAAE,IAAI;YAClB,YAAY,EAAE,UAAU;YACxB,eAAe,EAAE,SAAS;YAC1B,KAAK,EAAE,SAAS;YAChB,eAAe,EAAE,KAAK;SACvB,CAAC;IACJ,CAAC;CACF;AAjBD,0CAiBC"}
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import ProcessorTypeTranspiler from './processor-type-transpiler';
|
|
2
|
-
import { GeneratorChoices } from './generator-choices';
|
|
3
|
-
export declare class TypeTranspilerFactory {
|
|
4
|
-
private static typeTranspilerCache?;
|
|
5
|
-
static get(generator: GeneratorChoices): ProcessorTypeTranspiler;
|
|
6
|
-
}
|
|
@@ -1,35 +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.TypeTranspilerFactory = void 0;
|
|
7
|
-
const jekyll_docsProcessor_1 = require("./markdown/jekyll/jekyll-docsProcessor");
|
|
8
|
-
const docsify_docs_processor_1 = __importDefault(require("./markdown/docsify/docsify-docs-processor"));
|
|
9
|
-
const plain_docsProcessor_1 = require("./markdown/plain-markdown/plain-docsProcessor");
|
|
10
|
-
const open_api_docs_processor_1 = require("./openapi/open-api-docs-processor");
|
|
11
|
-
class TypeTranspilerFactory {
|
|
12
|
-
static get(generator) {
|
|
13
|
-
if (this.typeTranspilerCache) {
|
|
14
|
-
return this.typeTranspilerCache;
|
|
15
|
-
}
|
|
16
|
-
switch (generator) {
|
|
17
|
-
case 'jekyll':
|
|
18
|
-
this.typeTranspilerCache = new jekyll_docsProcessor_1.JekyllDocsProcessor();
|
|
19
|
-
return this.typeTranspilerCache;
|
|
20
|
-
case 'docsify':
|
|
21
|
-
this.typeTranspilerCache = new docsify_docs_processor_1.default();
|
|
22
|
-
return this.typeTranspilerCache;
|
|
23
|
-
case 'plain-markdown':
|
|
24
|
-
this.typeTranspilerCache = new plain_docsProcessor_1.PlainMarkdownDocsProcessor();
|
|
25
|
-
return this.typeTranspilerCache;
|
|
26
|
-
case 'openapi':
|
|
27
|
-
this.typeTranspilerCache = new open_api_docs_processor_1.OpenApiDocsProcessor();
|
|
28
|
-
return this.typeTranspilerCache;
|
|
29
|
-
default:
|
|
30
|
-
throw Error('Invalid target generator');
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
}
|
|
34
|
-
exports.TypeTranspilerFactory = TypeTranspilerFactory;
|
|
35
|
-
//# sourceMappingURL=factory.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../src/transpiler/factory.ts"],"names":[],"mappings":";;;;;;AAEA,iFAA6E;AAC7E,uGAA6E;AAC7E,uFAA2F;AAC3F,+EAAyE;AAEzE,MAAa,qBAAqB;IAGzB,MAAM,CAAC,GAAG,CAAC,SAA2B;QAC3C,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,mBAAmB,CAAC;QAClC,CAAC;QAED,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,QAAQ;gBACX,IAAI,CAAC,mBAAmB,GAAG,IAAI,0CAAmB,EAAE,CAAC;gBACrD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,SAAS;gBACZ,IAAI,CAAC,mBAAmB,GAAG,IAAI,gCAAoB,EAAE,CAAC;gBACtD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,gBAAgB;gBACnB,IAAI,CAAC,mBAAmB,GAAG,IAAI,gDAA0B,EAAE,CAAC;gBAC5D,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,SAAS;gBACZ,IAAI,CAAC,mBAAmB,GAAG,IAAI,8CAAoB,EAAE,CAAC;gBACtD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;CACF;AAzBD,sDAyBC"}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.FileContainer = void 0;
|
|
4
|
-
class FileContainer {
|
|
5
|
-
constructor() {
|
|
6
|
-
this._files = [];
|
|
7
|
-
}
|
|
8
|
-
files() {
|
|
9
|
-
return this._files;
|
|
10
|
-
}
|
|
11
|
-
pushFile(file) {
|
|
12
|
-
this._files.push(file);
|
|
13
|
-
}
|
|
14
|
-
}
|
|
15
|
-
exports.FileContainer = FileContainer;
|
|
16
|
-
//# sourceMappingURL=file-container.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"file-container.js","sourceRoot":"","sources":["../../src/transpiler/file-container.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IAA1B;QACE,WAAM,GAAiB,EAAE,CAAC;IAS5B,CAAC;IAPC,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,QAAQ,CAAC,IAAgB;QACvB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;CACF;AAVD,sCAUC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export type GeneratorChoices = 'jekyll' | 'docsify' | 'plain-markdown' | 'openapi';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"generator-choices.js","sourceRoot":"","sources":["../../src/transpiler/generator-choices.ts"],"names":[],"mappings":""}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { Type } from '@cparra/apex-reflection';
|
|
2
|
-
import { StringOrLink } from '../../core/renderable/types';
|
|
3
|
-
export default class ClassFileGeneratorHelper {
|
|
4
|
-
static getSanitizedGroup(classModel: Type): string;
|
|
5
|
-
static getFileLink(classModel: Type): string;
|
|
6
|
-
private static getFileLinkTuple;
|
|
7
|
-
static getFileLinkByTypeName(typeName: string): string;
|
|
8
|
-
static getRenderableLinkByTypeName(typeName: string): StringOrLink;
|
|
9
|
-
private static getDirectoryRoot;
|
|
10
|
-
private static getClassGroup;
|
|
11
|
-
}
|
|
@@ -1,75 +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
|
-
const types_repository_1 = require("../../model/types-repository");
|
|
7
|
-
const settings_1 = require("../../settings");
|
|
8
|
-
const state_1 = __importDefault(require("../../service/state"));
|
|
9
|
-
const factory_1 = require("../factory");
|
|
10
|
-
class ClassFileGeneratorHelper {
|
|
11
|
-
static getSanitizedGroup(classModel) {
|
|
12
|
-
return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
|
|
13
|
-
}
|
|
14
|
-
static getFileLink(classModel) {
|
|
15
|
-
const [fullClassName, fileLink] = ClassFileGeneratorHelper.getFileLinkTuple(classModel);
|
|
16
|
-
return `[${fullClassName}](${fileLink})`;
|
|
17
|
-
}
|
|
18
|
-
static getFileLinkTuple(classModel) {
|
|
19
|
-
var _a;
|
|
20
|
-
const documentationRoot = (_a = settings_1.Settings.getInstance().getRootDir()) !== null && _a !== void 0 ? _a : '';
|
|
21
|
-
const directoryRoot = `${documentationRoot}${this.getDirectoryRoot(classModel)}`;
|
|
22
|
-
const fullClassName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${classModel.name}`;
|
|
23
|
-
return [fullClassName, `${directoryRoot}${fullClassName}.md`];
|
|
24
|
-
}
|
|
25
|
-
static getFileLinkByTypeName(typeName) {
|
|
26
|
-
const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
|
|
27
|
-
if (!type) {
|
|
28
|
-
// If the type is not found, we return a Markdown hyperlink with whatever we received.
|
|
29
|
-
return `[${typeName}](${typeName})`;
|
|
30
|
-
}
|
|
31
|
-
return this.getFileLink(type);
|
|
32
|
-
}
|
|
33
|
-
static getRenderableLinkByTypeName(typeName) {
|
|
34
|
-
const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
|
|
35
|
-
if (!type) {
|
|
36
|
-
// If the type is not found, we return the type name as a string.
|
|
37
|
-
return typeName;
|
|
38
|
-
}
|
|
39
|
-
const [fullClassName, fileLink] = ClassFileGeneratorHelper.getFileLinkTuple(type);
|
|
40
|
-
return {
|
|
41
|
-
title: fullClassName,
|
|
42
|
-
url: fileLink,
|
|
43
|
-
};
|
|
44
|
-
}
|
|
45
|
-
static getDirectoryRoot(classModel) {
|
|
46
|
-
// root-relative links start from the root by using a leading '/'
|
|
47
|
-
const generator = settings_1.Settings.getInstance().targetGenerator;
|
|
48
|
-
if (factory_1.TypeTranspilerFactory.get(generator).getLinkingStrategy() === 'root-relative') {
|
|
49
|
-
return `/${this.getSanitizedGroup(classModel)}/`;
|
|
50
|
-
}
|
|
51
|
-
// path-relative links traverse the directory structure
|
|
52
|
-
const typeBeingProcessed = state_1.default.getInstance().getTypeBeingProcessed();
|
|
53
|
-
if (typeBeingProcessed) {
|
|
54
|
-
if (this.getClassGroup(typeBeingProcessed) === this.getClassGroup(classModel)) {
|
|
55
|
-
// If the types the same groups then we simply link directly to that file
|
|
56
|
-
return './';
|
|
57
|
-
}
|
|
58
|
-
else {
|
|
59
|
-
// If the types have different groups, then we have to go up a directory
|
|
60
|
-
return `../${this.getSanitizedGroup(classModel)}/`;
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
else {
|
|
64
|
-
// If nothing is being processed, then we assume we are at the root and links should include the groups
|
|
65
|
-
return `./${this.getSanitizedGroup(classModel)}/`;
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
static getClassGroup(classModel) {
|
|
69
|
-
var _a, _b;
|
|
70
|
-
const groupAnnotation = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === 'group');
|
|
71
|
-
return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : settings_1.Settings.getInstance().getDefaultGroupName();
|
|
72
|
-
}
|
|
73
|
-
}
|
|
74
|
-
exports.default = ClassFileGeneratorHelper;
|
|
75
|
-
//# sourceMappingURL=class-file-generatorHelper.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;;;;AACA,mEAA+D;AAC/D,6CAA0C;AAC1C,gEAAwC;AACxC,wCAAmD;AAGnD,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxF,OAAO,IAAI,aAAa,KAAK,QAAQ,GAAG,CAAC;IAC3C,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;;QAC9C,MAAM,iBAAiB,GAAG,MAAA,mBAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,mCAAI,EAAE,CAAC;QACpE,MAAM,aAAa,GAAG,GAAG,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QACjF,MAAM,aAAa,GAAG,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QACzF,OAAO,CAAC,aAAa,EAAE,GAAG,aAAa,GAAG,aAAa,KAAK,CAAC,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,sFAAsF;YACtF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;QACtC,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,2BAA2B,CAAC,QAAgB;QACxD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,iEAAiE;YACjE,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAClF,OAAO;YACL,KAAK,EAAE,aAAa;YACpB,GAAG,EAAE,QAAQ;SACd,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;QACzD,IAAI,+BAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE,CAAC;YAClF,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;QACnD,CAAC;QAED,uDAAuD;QACvD,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvE,IAAI,kBAAkB,EAAE,CAAC;YACvB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC9E,yEAAyE;gBACzE,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,wEAAwE;gBACxE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;YACrD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,uGAAuG;YACvG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAtED,2CAsEC"}
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
|
|
2
|
-
import { LinkingStrategy } from '../../processor-type-transpiler';
|
|
3
|
-
export default class DocsifyDocsProcessor extends MarkdownTranspilerBase {
|
|
4
|
-
homeFileName(): string;
|
|
5
|
-
getLinkingStrategy(): LinkingStrategy;
|
|
6
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
|
|
4
|
-
class DocsifyDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
|
|
5
|
-
homeFileName() {
|
|
6
|
-
return 'README';
|
|
7
|
-
}
|
|
8
|
-
getLinkingStrategy() {
|
|
9
|
-
return 'root-relative';
|
|
10
|
-
}
|
|
11
|
-
}
|
|
12
|
-
exports.default = DocsifyDocsProcessor;
|
|
13
|
-
//# sourceMappingURL=docsify-docs-processor.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"docsify-docs-processor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/docsify/docsify-docs-processor.ts"],"names":[],"mappings":";;AAAA,0EAAqE;AAGrE,MAAqB,oBAAqB,SAAQ,iDAAsB;IACtE,YAAY;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,uCAQC"}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
|
|
2
|
-
import { Type } from '@cparra/apex-reflection';
|
|
3
|
-
import { LinkingStrategy } from '../../processor-type-transpiler';
|
|
4
|
-
export declare class JekyllDocsProcessor extends MarkdownTranspilerBase {
|
|
5
|
-
homeFileName(): string;
|
|
6
|
-
onBeforeProcess: (types: Type[]) => void;
|
|
7
|
-
onProcess(type: Type): void;
|
|
8
|
-
get frontMatterForHomeFile(): string;
|
|
9
|
-
getFrontMatterHeader(type: Type): string;
|
|
10
|
-
getLinkingStrategy(): LinkingStrategy;
|
|
11
|
-
}
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.JekyllDocsProcessor = void 0;
|
|
4
|
-
const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
|
|
5
|
-
const markdown_home_file_1 = require("../../../model/markdown-home-file");
|
|
6
|
-
const markdown_type_file_1 = require("../../../model/markdown-type-file");
|
|
7
|
-
const settings_1 = require("../../../settings");
|
|
8
|
-
class JekyllDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
|
|
9
|
-
constructor() {
|
|
10
|
-
super(...arguments);
|
|
11
|
-
this.onBeforeProcess = (types) => {
|
|
12
|
-
this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types, this.frontMatterForHomeFile));
|
|
13
|
-
};
|
|
14
|
-
}
|
|
15
|
-
homeFileName() {
|
|
16
|
-
return 'index';
|
|
17
|
-
}
|
|
18
|
-
onProcess(type) {
|
|
19
|
-
this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type, 1, this.getFrontMatterHeader(type)));
|
|
20
|
-
}
|
|
21
|
-
get frontMatterForHomeFile() {
|
|
22
|
-
return '---\nlayout: default\n---';
|
|
23
|
-
}
|
|
24
|
-
getFrontMatterHeader(type) {
|
|
25
|
-
var _a;
|
|
26
|
-
const headerLines = ['---'];
|
|
27
|
-
// "layout: default" is a required front matter header for Jekyll
|
|
28
|
-
headerLines.push('layout: default');
|
|
29
|
-
// Add any additional front matter headers that might have been configured in the settings
|
|
30
|
-
const targetType = {
|
|
31
|
-
name: type.name,
|
|
32
|
-
typeName: type.type_name,
|
|
33
|
-
accessModifier: type.access_modifier,
|
|
34
|
-
group: type.group,
|
|
35
|
-
description: (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.description,
|
|
36
|
-
};
|
|
37
|
-
const configuredHeaders = settings_1.Settings.getInstance().frontMatterHeader(targetType);
|
|
38
|
-
if (configuredHeaders) {
|
|
39
|
-
configuredHeaders.forEach((header) => {
|
|
40
|
-
headerLines.push(header);
|
|
41
|
-
});
|
|
42
|
-
}
|
|
43
|
-
headerLines.push('---');
|
|
44
|
-
return headerLines.join('\n');
|
|
45
|
-
}
|
|
46
|
-
getLinkingStrategy() {
|
|
47
|
-
return 'path-relative';
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
exports.JekyllDocsProcessor = JekyllDocsProcessor;
|
|
51
|
-
//# sourceMappingURL=jekyll-docsProcessor.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"jekyll-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAErE,0EAAqE;AACrE,0EAAqE;AAErE,gDAA6C;AAE7C,MAAa,mBAAoB,SAAQ,iDAAsB;IAA/D;;QAKE,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAC9G,CAAC,CAAC;IAmCJ,CAAC;IAzCC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED,IAAI,sBAAsB;QACxB,OAAO,2BAA2B,CAAC;IACrC,CAAC;IAED,oBAAoB,CAAC,IAAU;;QAC7B,MAAM,WAAW,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,iEAAiE;QACjE,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACpC,0FAA0F;QAC1F,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,cAAc,EAAE,IAAI,CAAC,eAAe;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW;SAC1C,CAAC;QACF,MAAM,iBAAiB,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAC/E,IAAI,iBAAiB,EAAE,CAAC;YACtB,iBAAiB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gBACnC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;QACL,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AA1CD,kDA0CC"}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import ProcessorTypeTranspiler from '../processor-type-transpiler';
|
|
2
|
-
import { Type } from '@cparra/apex-reflection';
|
|
3
|
-
import { FileContainer } from '../file-container';
|
|
4
|
-
export declare abstract class MarkdownTranspilerBase extends ProcessorTypeTranspiler {
|
|
5
|
-
protected readonly _fileContainer: FileContainer;
|
|
6
|
-
constructor();
|
|
7
|
-
abstract homeFileName(): string;
|
|
8
|
-
fileBuilder(): FileContainer;
|
|
9
|
-
onBeforeProcess: (types: Type[]) => void;
|
|
10
|
-
onProcess(type: Type): void;
|
|
11
|
-
}
|
|
@@ -1,27 +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.MarkdownTranspilerBase = void 0;
|
|
7
|
-
const processor_type_transpiler_1 = __importDefault(require("../processor-type-transpiler"));
|
|
8
|
-
const file_container_1 = require("../file-container");
|
|
9
|
-
const markdown_home_file_1 = require("../../model/markdown-home-file");
|
|
10
|
-
const markdown_type_file_1 = require("../../model/markdown-type-file");
|
|
11
|
-
class MarkdownTranspilerBase extends processor_type_transpiler_1.default {
|
|
12
|
-
constructor() {
|
|
13
|
-
super();
|
|
14
|
-
this.onBeforeProcess = (types) => {
|
|
15
|
-
this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types));
|
|
16
|
-
};
|
|
17
|
-
this._fileContainer = new file_container_1.FileContainer();
|
|
18
|
-
}
|
|
19
|
-
fileBuilder() {
|
|
20
|
-
return this._fileContainer;
|
|
21
|
-
}
|
|
22
|
-
onProcess(type) {
|
|
23
|
-
this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type));
|
|
24
|
-
}
|
|
25
|
-
}
|
|
26
|
-
exports.MarkdownTranspilerBase = MarkdownTranspilerBase;
|
|
27
|
-
//# sourceMappingURL=markdown-transpiler-base.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;;;;;AAAA,6FAAmE;AAEnE,sDAAkD;AAClD,uEAAkE;AAClE,uEAAkE;AAElE,MAAsB,sBAAuB,SAAQ,mCAAuB;IAG1E;QACE,KAAK,EAAE,CAAC;QAUV,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC;QAXA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;IAC5C,CAAC;IAID,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF;AArBD,wDAqBC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const classMarkdownTemplate: string;
|
|
@@ -1,77 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.classMarkdownTemplate = void 0;
|
|
4
|
-
exports.classMarkdownTemplate = `
|
|
5
|
-
{{ heading headingLevel heading }}
|
|
6
|
-
{{#if classModifier}}
|
|
7
|
-
\`{{classModifier}}\`
|
|
8
|
-
{{/if}}
|
|
9
|
-
|
|
10
|
-
{{> typeDocumentation}}
|
|
11
|
-
|
|
12
|
-
{{#if extends}}
|
|
13
|
-
**Extends**
|
|
14
|
-
{{link extends}}
|
|
15
|
-
{{/if}}
|
|
16
|
-
|
|
17
|
-
{{#if implements}}
|
|
18
|
-
**Implements**
|
|
19
|
-
{{#each implements}}
|
|
20
|
-
{{link this}}{{#unless @last}}, {{/unless}}
|
|
21
|
-
{{/each}}
|
|
22
|
-
{{/if}}
|
|
23
|
-
|
|
24
|
-
{{#if fields.value}}
|
|
25
|
-
{{#if fields.isGrouped}}
|
|
26
|
-
{{> groupedMembersPartialTemplate fields subTemplate="fieldsPartialTemplate"}}
|
|
27
|
-
{{else}}
|
|
28
|
-
{{> fieldsPartialTemplate fields}}
|
|
29
|
-
{{/if}}
|
|
30
|
-
{{/if}}
|
|
31
|
-
|
|
32
|
-
{{#if properties.value}}
|
|
33
|
-
{{#if properties.isGrouped}}
|
|
34
|
-
{{> groupedMembersPartialTemplate properties subTemplate="fieldsPartialTemplate"}}
|
|
35
|
-
{{else}}
|
|
36
|
-
{{> fieldsPartialTemplate properties}}
|
|
37
|
-
{{/if}}
|
|
38
|
-
{{/if}}
|
|
39
|
-
|
|
40
|
-
{{#if constructors.value}}
|
|
41
|
-
{{#if constructors.isGrouped}}
|
|
42
|
-
{{> groupedMembersPartialTemplate constructors subTemplate="constructorsPartialTemplate"}}
|
|
43
|
-
{{else}}
|
|
44
|
-
{{> constructorsPartialTemplate constructors}}
|
|
45
|
-
{{/if}}
|
|
46
|
-
{{/if}}
|
|
47
|
-
|
|
48
|
-
{{#if methods.value}}
|
|
49
|
-
{{#if methods.isGrouped}}
|
|
50
|
-
{{> groupedMembersPartialTemplate methods subTemplate="methodsPartialTemplate"}}
|
|
51
|
-
{{else}}
|
|
52
|
-
{{> methodsPartialTemplate methods}}
|
|
53
|
-
{{/if}}
|
|
54
|
-
{{/if}}
|
|
55
|
-
|
|
56
|
-
{{#if innerClasses.value}}
|
|
57
|
-
{{ heading innerClasses.headingLevel innerClasses.heading }}
|
|
58
|
-
{{#each innerClasses.value}}
|
|
59
|
-
{{> classTemplate this}}
|
|
60
|
-
{{/each}}
|
|
61
|
-
{{/if}}
|
|
62
|
-
|
|
63
|
-
{{#if innerEnums.value}}
|
|
64
|
-
{{ heading innerEnums.headingLevel innerEnums.heading }}
|
|
65
|
-
{{#each innerEnums.value}}
|
|
66
|
-
{{> enumTemplate this}}
|
|
67
|
-
{{/each}}
|
|
68
|
-
{{/if}}
|
|
69
|
-
|
|
70
|
-
{{#if innerInterfaces.value}}
|
|
71
|
-
{{ heading innerInterfaces.headingLevel innerInterfaces.heading }}
|
|
72
|
-
{{#each innerInterfaces.value}}
|
|
73
|
-
{{> interfaceTemplate this}}
|
|
74
|
-
{{/each}}
|
|
75
|
-
{{/if}}
|
|
76
|
-
`.trim();
|
|
77
|
-
//# sourceMappingURL=class-template.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"class-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/class-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwEpC,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const constructorsPartialTemplate: string;
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.constructorsPartialTemplate = void 0;
|
|
4
|
-
exports.constructorsPartialTemplate = `
|
|
5
|
-
{{ heading headingLevel heading }}
|
|
6
|
-
{{#each value}}
|
|
7
|
-
{{{ heading headingLevel (inlineCode heading) }}}
|
|
8
|
-
|
|
9
|
-
{{#> documentablePartialTemplate}}
|
|
10
|
-
|
|
11
|
-
{{ heading signature.headingLevel signature.heading }}
|
|
12
|
-
{{ code "apex" signature.value }}
|
|
13
|
-
|
|
14
|
-
{{#if parameters.value}}
|
|
15
|
-
{{ heading parameters.headingLevel parameters.heading }}
|
|
16
|
-
| Name | Type | Description |
|
|
17
|
-
|------|------|-------------|
|
|
18
|
-
{{#each parameters.value}}
|
|
19
|
-
| {{name}} | {{type}} | {{description}} |
|
|
20
|
-
{{/each}}
|
|
21
|
-
{{/if}}
|
|
22
|
-
|
|
23
|
-
{{#if throws.value}}
|
|
24
|
-
{{ heading throws.headingLevel throws.heading }}
|
|
25
|
-
{{#each throws.value}}
|
|
26
|
-
{{link this.type}}: {{this.description}}
|
|
27
|
-
|
|
28
|
-
{{/each}}
|
|
29
|
-
{{/if}}
|
|
30
|
-
{{/documentablePartialTemplate}}
|
|
31
|
-
|
|
32
|
-
{{#unless @last}}---{{/unless}}
|
|
33
|
-
|
|
34
|
-
{{/each}}
|
|
35
|
-
`.trim();
|
|
36
|
-
//# sourceMappingURL=constructors-partial-template.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"constructors-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/constructors-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+B1C,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const documentablePartialTemplate: string;
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.documentablePartialTemplate = void 0;
|
|
4
|
-
exports.documentablePartialTemplate = `
|
|
5
|
-
{{#each doc.annotations}}
|
|
6
|
-
\`{{this}}\`
|
|
7
|
-
{{/each}}
|
|
8
|
-
|
|
9
|
-
{{withLinks doc.description}}
|
|
10
|
-
|
|
11
|
-
{{#each doc.customTags}}
|
|
12
|
-
**{{splitAndCapitalize name}}** {{withLinks description}}
|
|
13
|
-
|
|
14
|
-
{{/each}}
|
|
15
|
-
|
|
16
|
-
{{> @partial-block}}
|
|
17
|
-
|
|
18
|
-
{{#if doc.mermaid.value}}
|
|
19
|
-
{{ heading doc.mermaid.headingLevel doc.mermaid.heading }}
|
|
20
|
-
{{code "mermaid" doc.mermaid.value}}
|
|
21
|
-
{{/if}}
|
|
22
|
-
|
|
23
|
-
{{#if doc.example.value}}
|
|
24
|
-
{{ heading doc.example.headingLevel doc.example.heading }}
|
|
25
|
-
{{code "apex" doc.example.value}}
|
|
26
|
-
{{/if}}
|
|
27
|
-
`.trim();
|
|
28
|
-
//# sourceMappingURL=documentable-partial-template.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"documentable-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/documentable-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;;;;CAuB1C,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const enumMarkdownTemplate: string;
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.enumMarkdownTemplate = void 0;
|
|
4
|
-
exports.enumMarkdownTemplate = `
|
|
5
|
-
{{ heading headingLevel heading }}
|
|
6
|
-
|
|
7
|
-
{{> typeDocumentation }}
|
|
8
|
-
|
|
9
|
-
{{ heading values.headingLevel values.heading }}
|
|
10
|
-
| Value | Description |
|
|
11
|
-
|-------|-------------|
|
|
12
|
-
{{#each values.value}}
|
|
13
|
-
| {{value}} | {{description}} |
|
|
14
|
-
{{/each}}
|
|
15
|
-
`.trim();
|
|
16
|
-
//# sourceMappingURL=enum-template.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"enum-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/enum-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,oBAAoB,GAAG;;;;;;;;;;;CAWnC,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const fieldsPartialTemplate: string;
|