@cparra/apexdocs 2.25.0-alpha.3 → 2.25.0-alpha.5
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/dist/cli/generate.js +2746 -40
- package/dist/defaults-DUwru49Q.js +12 -0
- package/dist/defaults-SH0Rsi5E.js +11 -0
- package/dist/index.d.ts +62 -2
- package/dist/index.js +36 -1
- package/examples/plain-markdown/docs/Miscellaneous/ns.BaseClass.md +1 -1
- package/examples/plain-markdown/docs/Miscellaneous/ns.MultiInheritanceClass.md +1 -1
- package/examples/plain-markdown/docs/Miscellaneous/ns.ParentInterface.md +1 -1
- package/examples/plain-markdown/docs/Miscellaneous/ns.ReferencedEnum.md +1 -1
- package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +1 -1
- package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +1 -1
- package/examples/plain-markdown/docs/Miscellaneous/ns.Url.md +320 -0
- package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +1 -1
- package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +1 -1
- package/examples/plain-markdown/docs/index.md +83 -1
- package/examples/plain-markdown/force-app/classes/Url.cls +194 -0
- package/examples/plain-markdown/package.json +2 -2
- package/examples/vitepress/.forceignore +12 -0
- package/examples/vitepress/apexdocs.config.ts +108 -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/Miscellaneous/apexdocs.BaseClass.md +20 -0
- package/examples/vitepress/docs/Miscellaneous/apexdocs.MultiInheritanceClass.md +78 -0
- package/examples/vitepress/docs/Miscellaneous/apexdocs.ParentInterface.md +19 -0
- package/examples/vitepress/docs/Miscellaneous/apexdocs.ReferencedEnum.md +15 -0
- package/examples/vitepress/docs/Miscellaneous/apexdocs.SampleException.md +28 -0
- package/examples/vitepress/docs/Miscellaneous/apexdocs.SampleInterface.md +122 -0
- package/examples/vitepress/docs/Miscellaneous/apexdocs.Url.md +318 -0
- package/examples/vitepress/docs/Sample-Enums/apexdocs.SampleEnum.md +41 -0
- package/examples/vitepress/docs/SampleGroup/apexdocs.SampleClass.md +178 -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 +127 -0
- package/examples/vitepress/docs/markdown-examples.md +85 -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 +195 -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 +1 -0
- package/package.json +10 -6
- package/src/application/Apexdocs.ts +16 -106
- 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 +25 -0
- package/src/application/generators/markdown.ts +53 -0
- package/src/application/generators/openapi.ts +56 -0
- package/src/cli/args.ts +17 -110
- package/src/cli/commands/markdown.ts +58 -0
- package/src/cli/generate.ts +7 -7
- package/src/{model/__tests__ → core/__test__}/manifest.spec.ts +1 -1
- package/src/core/manifest.ts +57 -51
- package/src/{__spec__/core → core/markdown/__test__}/expect-extensions.ts +5 -5
- package/src/core/markdown/__test__/generating-class-docs.spec.ts +727 -0
- package/src/{__spec__/core → core/markdown/__test__}/generating-enum-docs.spec.ts +82 -59
- package/src/{__spec__/core → core/markdown/__test__}/generating-interface-docs.spec.ts +94 -75
- package/src/core/markdown/__test__/generating-reference-guide.spec.ts +184 -0
- package/src/core/{__test__ → markdown/__test__}/inheritance-chain.test.ts +2 -2
- package/src/core/markdown/__test__/test-helpers.ts +22 -0
- package/src/core/markdown/adapters/__tests__/documentables.spec.ts +109 -0
- package/src/core/{adapters → markdown/adapters}/__tests__/interface-adapter.spec.ts +38 -8
- package/src/core/{adapters → markdown/adapters}/__tests__/references.spec.ts +12 -1
- package/src/core/{adapters → markdown/adapters}/apex-types.ts +8 -5
- package/src/core/{adapters → markdown/adapters}/documentables.ts +2 -62
- package/src/core/{adapters → markdown/adapters}/fields-and-properties.ts +7 -2
- package/src/core/{adapters/references.ts → markdown/adapters/inline.ts} +43 -10
- package/src/core/{adapters → markdown/adapters}/methods-and-constructors.ts +7 -2
- package/src/core/markdown/adapters/renderable-bundle.ts +144 -0
- package/src/core/markdown/adapters/renderable-to-page-data.ts +92 -0
- package/src/core/{adapters → markdown/adapters}/type-utils.ts +5 -1
- package/src/core/{adapters → markdown/adapters}/types.d.ts +24 -3
- package/src/core/markdown/generate-docs.ts +158 -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/inherited-member-expansion.ts +105 -0
- package/src/core/markdown/reflection/reflect-source.ts +41 -0
- package/src/core/markdown/reflection/sort-members.ts +59 -0
- package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/class-template.ts +2 -0
- package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/constructors-partial-template.ts +1 -1
- package/src/core/markdown/templates/hookable.ts +7 -0
- package/src/core/{template.ts → markdown/templates/template.ts} +15 -12
- 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 +14 -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 +92 -0
- package/src/core/shared/utils.ts +5 -0
- package/src/defaults.ts +8 -0
- package/src/index.ts +34 -2
- package/src/test-helpers/InterfaceMirrorBuilder.ts +0 -5
- package/src/test-helpers/SettingsBuilder.ts +1 -5
- package/src/util/fp.ts +3 -0
- package/src/util/logger.ts +2 -2
- package/src/util/string-utils.ts +0 -4
- package/tsconfig.json +5 -1
- package/apexdocs.config.ts +0 -13
- package/dist/__spec__/core/expect-extensions.d.ts +0 -3
- package/dist/__spec__/core/expect-extensions.js +0 -55
- package/dist/__spec__/core/expect-extensions.js.map +0 -1
- package/dist/__spec__/core/generating-class-docs.spec.d.ts +0 -1
- package/dist/__spec__/core/generating-class-docs.spec.js +0 -444
- package/dist/__spec__/core/generating-class-docs.spec.js.map +0 -1
- package/dist/__spec__/core/generating-enum-docs.spec.d.ts +0 -1
- package/dist/__spec__/core/generating-enum-docs.spec.js +0 -306
- package/dist/__spec__/core/generating-enum-docs.spec.js.map +0 -1
- package/dist/__spec__/core/generating-interface-docs.spec.d.ts +0 -1
- package/dist/__spec__/core/generating-interface-docs.spec.js +0 -364
- package/dist/__spec__/core/generating-interface-docs.spec.js.map +0 -1
- package/dist/__spec__/core/generating-reference-guide.spec.d.ts +0 -1
- package/dist/__spec__/core/generating-reference-guide.spec.js +0 -162
- package/dist/__spec__/core/generating-reference-guide.spec.js.map +0 -1
- package/dist/__spec__/core/test-helpers.d.ts +0 -2
- package/dist/__spec__/core/test-helpers.js +0 -12
- package/dist/__spec__/core/test-helpers.js.map +0 -1
- package/dist/application/Apexdocs.d.ts +0 -15
- package/dist/application/Apexdocs.js +0 -113
- package/dist/application/Apexdocs.js.map +0 -1
- package/dist/application/generators/generate-markdown-files.d.ts +0 -3
- package/dist/application/generators/generate-markdown-files.js +0 -64
- package/dist/application/generators/generate-markdown-files.js.map +0 -1
- package/dist/cli/args.d.ts +0 -39
- package/dist/cli/args.js +0 -154
- package/dist/cli/args.js.map +0 -1
- package/dist/cli/generate.d.ts +0 -2
- package/dist/cli/generate.js.map +0 -1
- package/dist/core/__test__/inheritance-chain.test.d.ts +0 -1
- package/dist/core/__test__/inheritance-chain.test.js +0 -42
- package/dist/core/__test__/inheritance-chain.test.js.map +0 -1
- package/dist/core/adapters/apex-types.d.ts +0 -6
- package/dist/core/adapters/apex-types.js +0 -109
- package/dist/core/adapters/apex-types.js.map +0 -1
- package/dist/core/adapters/documentables.d.ts +0 -7
- package/dist/core/adapters/documentables.js +0 -154
- package/dist/core/adapters/documentables.js.map +0 -1
- package/dist/core/adapters/fields-and-properties.d.ts +0 -3
- package/dist/core/adapters/fields-and-properties.js +0 -37
- package/dist/core/adapters/fields-and-properties.js.map +0 -1
- package/dist/core/adapters/methods-and-constructors.d.ts +0 -5
- package/dist/core/adapters/methods-and-constructors.js +0 -100
- package/dist/core/adapters/methods-and-constructors.js.map +0 -1
- package/dist/core/adapters/references.d.ts +0 -4
- package/dist/core/adapters/references.js +0 -78
- package/dist/core/adapters/references.js.map +0 -1
- package/dist/core/adapters/type-utils.d.ts +0 -3
- package/dist/core/adapters/type-utils.js +0 -12
- package/dist/core/adapters/type-utils.js.map +0 -1
- package/dist/core/apex-bundle.d.ts +0 -6
- package/dist/core/apex-bundle.js +0 -11
- package/dist/core/apex-bundle.js.map +0 -1
- package/dist/core/generate-docs.d.ts +0 -28
- package/dist/core/generate-docs.js +0 -296
- package/dist/core/generate-docs.js.map +0 -1
- package/dist/core/inheritance-chain.d.ts +0 -2
- package/dist/core/inheritance-chain.js +0 -36
- package/dist/core/inheritance-chain.js.map +0 -1
- package/dist/core/manifest.d.ts +0 -22
- package/dist/core/manifest.js +0 -53
- package/dist/core/manifest.js.map +0 -1
- package/dist/core/template.d.ts +0 -10
- package/dist/core/template.js +0 -97
- package/dist/core/template.js.map +0 -1
- package/dist/core/templates/reference-guide.d.ts +0 -1
- package/dist/core/templates/reference-guide.js +0 -18
- package/dist/core/templates/reference-guide.js.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +0 -7
- package/dist/model/apex-type-wrappers/ClassMirrorWrapper.js +0 -14
- package/dist/model/apex-type-wrappers/ClassMirrorWrapper.js.map +0 -1
- package/dist/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +0 -7
- package/dist/model/apex-type-wrappers/MethodMirrorWrapper.js +0 -12
- package/dist/model/apex-type-wrappers/MethodMirrorWrapper.js.map +0 -1
- package/dist/model/markdown-file.d.ts +0 -16
- package/dist/model/markdown-file.js +0 -111
- package/dist/model/markdown-file.js.map +0 -1
- package/dist/model/markdown-generation-util/doc-comment-annotation-util.d.ts +0 -8
- package/dist/model/markdown-generation-util/doc-comment-annotation-util.js +0 -47
- package/dist/model/markdown-generation-util/doc-comment-annotation-util.js.map +0 -1
- package/dist/model/markdown-generation-util/field-declaration-util.d.ts +0 -3
- package/dist/model/markdown-generation-util/field-declaration-util.js +0 -55
- package/dist/model/markdown-generation-util/field-declaration-util.js.map +0 -1
- package/dist/model/markdown-generation-util/index.d.ts +0 -3
- package/dist/model/markdown-generation-util/index.js +0 -20
- package/dist/model/markdown-generation-util/index.js.map +0 -1
- package/dist/model/markdown-generation-util/method-declaration-util.d.ts +0 -4
- package/dist/model/markdown-generation-util/method-declaration-util.js +0 -115
- package/dist/model/markdown-generation-util/method-declaration-util.js.map +0 -1
- package/dist/model/markdown-generation-util/type-declaration-util.d.ts +0 -3
- package/dist/model/markdown-generation-util/type-declaration-util.js +0 -82
- package/dist/model/markdown-generation-util/type-declaration-util.js.map +0 -1
- package/dist/model/markdown-home-file.d.ts +0 -11
- package/dist/model/markdown-home-file.js +0 -57
- package/dist/model/markdown-home-file.js.map +0 -1
- package/dist/model/markdown-type-file.d.ts +0 -26
- package/dist/model/markdown-type-file.js +0 -137
- package/dist/model/markdown-type-file.js.map +0 -1
- package/dist/model/openapi/apex-doc-types.d.ts +0 -19
- package/dist/model/openapi/apex-doc-types.js +0 -5
- package/dist/model/openapi/apex-doc-types.js.map +0 -1
- package/dist/model/openapi/open-api-types.d.ts +0 -93
- package/dist/model/openapi/open-api-types.js +0 -3
- package/dist/model/openapi/open-api-types.js.map +0 -1
- package/dist/model/openapi/open-api.d.ts +0 -16
- package/dist/model/openapi/open-api.js +0 -34
- package/dist/model/openapi/open-api.js.map +0 -1
- package/dist/model/openapi/openapi-type-file.d.ts +0 -7
- package/dist/model/openapi/openapi-type-file.js +0 -17
- package/dist/model/openapi/openapi-type-file.js.map +0 -1
- package/dist/model/outputFile.d.ts +0 -10
- package/dist/model/outputFile.js +0 -22
- package/dist/model/outputFile.js.map +0 -1
- package/dist/model/types-repository.d.ts +0 -16
- package/dist/model/types-repository.js +0 -54
- package/dist/model/types-repository.js.map +0 -1
- package/dist/service/apex-file-reader.d.ts +0 -14
- package/dist/service/apex-file-reader.js +0 -49
- package/dist/service/apex-file-reader.js.map +0 -1
- package/dist/service/file-system.d.ts +0 -14
- package/dist/service/file-system.js +0 -48
- package/dist/service/file-system.js.map +0 -1
- package/dist/service/file-writer.d.ts +0 -6
- package/dist/service/file-writer.js +0 -57
- package/dist/service/file-writer.js.map +0 -1
- package/dist/service/manifest-factory.d.ts +0 -10
- package/dist/service/manifest-factory.js +0 -17
- package/dist/service/manifest-factory.js.map +0 -1
- package/dist/service/metadata-processor.d.ts +0 -3
- package/dist/service/metadata-processor.js +0 -17
- package/dist/service/metadata-processor.js.map +0 -1
- package/dist/service/parser.d.ts +0 -21
- package/dist/service/parser.js +0 -138
- package/dist/service/parser.js.map +0 -1
- package/dist/service/state.d.ts +0 -9
- package/dist/service/state.js +0 -20
- package/dist/service/state.js.map +0 -1
- package/dist/service/walkers/class-walker.d.ts +0 -4
- package/dist/service/walkers/class-walker.js +0 -33
- package/dist/service/walkers/class-walker.js.map +0 -1
- package/dist/service/walkers/enum-walker.d.ts +0 -4
- package/dist/service/walkers/enum-walker.js +0 -11
- package/dist/service/walkers/enum-walker.js.map +0 -1
- package/dist/service/walkers/interface-walker.d.ts +0 -4
- package/dist/service/walkers/interface-walker.js +0 -15
- package/dist/service/walkers/interface-walker.js.map +0 -1
- package/dist/service/walkers/walker-factory.d.ts +0 -5
- package/dist/service/walkers/walker-factory.js +0 -21
- package/dist/service/walkers/walker-factory.js.map +0 -1
- package/dist/service/walkers/walker.d.ts +0 -19
- package/dist/service/walkers/walker.js +0 -17
- package/dist/service/walkers/walker.js.map +0 -1
- package/dist/settings.d.ts +0 -67
- package/dist/settings.js +0 -92
- package/dist/settings.js.map +0 -1
- package/dist/test-helpers/AnnotationBuilder.d.ts +0 -12
- package/dist/test-helpers/AnnotationBuilder.js +0 -31
- package/dist/test-helpers/AnnotationBuilder.js.map +0 -1
- package/dist/test-helpers/ClassMirrorBuilder.d.ts +0 -22
- package/dist/test-helpers/ClassMirrorBuilder.js +0 -64
- package/dist/test-helpers/ClassMirrorBuilder.js.map +0 -1
- package/dist/test-helpers/DocCommentAnnotationBuilder.d.ts +0 -8
- package/dist/test-helpers/DocCommentAnnotationBuilder.js +0 -26
- package/dist/test-helpers/DocCommentAnnotationBuilder.js.map +0 -1
- package/dist/test-helpers/DocCommentBuilder.d.ts +0 -12
- package/dist/test-helpers/DocCommentBuilder.js +0 -38
- package/dist/test-helpers/DocCommentBuilder.js.map +0 -1
- package/dist/test-helpers/FieldMirrorBuilder.d.ts +0 -18
- package/dist/test-helpers/FieldMirrorBuilder.js +0 -54
- package/dist/test-helpers/FieldMirrorBuilder.js.map +0 -1
- package/dist/test-helpers/InterfaceMirrorBuilder.d.ts +0 -16
- package/dist/test-helpers/InterfaceMirrorBuilder.js +0 -43
- package/dist/test-helpers/InterfaceMirrorBuilder.js.map +0 -1
- package/dist/test-helpers/MethodMirrorBuilder.d.ts +0 -29
- package/dist/test-helpers/MethodMirrorBuilder.js +0 -72
- package/dist/test-helpers/MethodMirrorBuilder.js.map +0 -1
- package/dist/test-helpers/SettingsBuilder.d.ts +0 -8
- package/dist/test-helpers/SettingsBuilder.js +0 -28
- package/dist/test-helpers/SettingsBuilder.js.map +0 -1
- package/dist/transpiler/factory.d.ts +0 -6
- package/dist/transpiler/factory.js +0 -33
- package/dist/transpiler/factory.js.map +0 -1
- package/dist/transpiler/file-container.d.ts +0 -6
- package/dist/transpiler/file-container.js +0 -16
- package/dist/transpiler/file-container.js.map +0 -1
- package/dist/transpiler/generator-choices.d.ts +0 -1
- package/dist/transpiler/generator-choices.js +0 -3
- package/dist/transpiler/generator-choices.js.map +0 -1
- package/dist/transpiler/markdown/class-file-generatorHelper.d.ts +0 -9
- package/dist/transpiler/markdown/class-file-generatorHelper.js +0 -61
- package/dist/transpiler/markdown/class-file-generatorHelper.js.map +0 -1
- package/dist/transpiler/markdown/docsify/docsify-docs-processor.d.ts +0 -6
- package/dist/transpiler/markdown/docsify/docsify-docs-processor.js +0 -13
- package/dist/transpiler/markdown/docsify/docsify-docs-processor.js.map +0 -1
- package/dist/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +0 -11
- package/dist/transpiler/markdown/jekyll/jekyll-docsProcessor.js +0 -51
- package/dist/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +0 -1
- package/dist/transpiler/markdown/markdown-transpiler-base.d.ts +0 -11
- package/dist/transpiler/markdown/markdown-transpiler-base.js +0 -27
- package/dist/transpiler/markdown/markdown-transpiler-base.js.map +0 -1
- package/dist/transpiler/markdown/plain-markdown/class-template.d.ts +0 -1
- package/dist/transpiler/markdown/plain-markdown/class-template.js +0 -77
- package/dist/transpiler/markdown/plain-markdown/class-template.js.map +0 -1
- package/dist/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +0 -1
- package/dist/transpiler/markdown/plain-markdown/constructors-partial-template.js +0 -36
- package/dist/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +0 -1
- package/dist/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +0 -1
- package/dist/transpiler/markdown/plain-markdown/documentable-partial-template.js +0 -30
- package/dist/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +0 -1
- package/dist/transpiler/markdown/plain-markdown/enum-template.d.ts +0 -1
- package/dist/transpiler/markdown/plain-markdown/enum-template.js +0 -16
- package/dist/transpiler/markdown/plain-markdown/enum-template.js.map +0 -1
- package/dist/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +0 -1
- package/dist/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +0 -27
- package/dist/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +0 -1
- package/dist/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +0 -1
- package/dist/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +0 -10
- package/dist/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +0 -1
- package/dist/transpiler/markdown/plain-markdown/interface-template.d.ts +0 -1
- package/dist/transpiler/markdown/plain-markdown/interface-template.js +0 -20
- package/dist/transpiler/markdown/plain-markdown/interface-template.js.map +0 -1
- package/dist/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +0 -1
- package/dist/transpiler/markdown/plain-markdown/methods-partial-template.js +0 -47
- package/dist/transpiler/markdown/plain-markdown/methods-partial-template.js.map +0 -1
- package/dist/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +0 -1
- package/dist/transpiler/markdown/plain-markdown/type-doc-partial.js +0 -31
- package/dist/transpiler/markdown/plain-markdown/type-doc-partial.js.map +0 -1
- package/dist/transpiler/openapi/open-api-docs-processor.d.ts +0 -13
- package/dist/transpiler/openapi/open-api-docs-processor.js +0 -78
- package/dist/transpiler/openapi/open-api-docs-processor.js.map +0 -1
- package/dist/transpiler/openapi/parsers/Builder.d.ts +0 -16
- package/dist/transpiler/openapi/parsers/Builder.js +0 -30
- package/dist/transpiler/openapi/parsers/Builder.js.map +0 -1
- package/dist/transpiler/openapi/parsers/MethodParser.d.ts +0 -20
- package/dist/transpiler/openapi/parsers/MethodParser.js +0 -190
- package/dist/transpiler/openapi/parsers/MethodParser.js.map +0 -1
- package/dist/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +0 -7
- package/dist/transpiler/openapi/parsers/ParameterObjectBuilder.js +0 -11
- package/dist/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +0 -1
- package/dist/transpiler/openapi/parsers/ReferenceBuilder.d.ts +0 -39
- package/dist/transpiler/openapi/parsers/ReferenceBuilder.js +0 -250
- package/dist/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -1
- package/dist/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -10
- package/dist/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -20
- package/dist/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -1
- package/dist/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -7
- package/dist/transpiler/openapi/parsers/ResponsesBuilder.js +0 -22
- package/dist/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -1
- package/dist/transpiler/processor-type-transpiler.d.ts +0 -10
- package/dist/transpiler/processor-type-transpiler.js +0 -9
- package/dist/transpiler/processor-type-transpiler.js.map +0 -1
- package/dist/transpiler/transpiler.d.ts +0 -5
- package/dist/transpiler/transpiler.js +0 -30
- package/dist/transpiler/transpiler.js.map +0 -1
- package/dist/util/error-logger.d.ts +0 -8
- package/dist/util/error-logger.js +0 -90
- package/dist/util/error-logger.js.map +0 -1
- package/dist/util/logger.d.ts +0 -21
- package/dist/util/logger.js +0 -61
- package/dist/util/logger.js.map +0 -1
- package/dist/util/string-utils.d.ts +0 -2
- package/dist/util/string-utils.js +0 -15
- package/dist/util/string-utils.js.map +0 -1
- package/examples/plain-markdown/template.md +0 -3
- package/src/__spec__/core/generating-class-docs.spec.ts +0 -531
- package/src/__spec__/core/generating-reference-guide.spec.ts +0 -164
- package/src/__spec__/core/test-helpers.ts +0 -9
- package/src/application/generators/generate-markdown-files.ts +0 -53
- package/src/core/apex-bundle.ts +0 -3
- package/src/core/generate-docs.ts +0 -432
- 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 -169
- 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 -93
- 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 -153
- package/src/transpiler/factory.ts +0 -31
- 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 -61
- 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/processor-type-transpiler.ts +0 -18
- /package/src/{service → application}/file-system.ts +0 -0
- /package/src/core/{inheritance-chain.ts → markdown/reflection/inheritance-chain.ts} +0 -0
- /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/documentable-partial-template.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}/fieldsPartialTemplate.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}/methods-partial-template.ts +0 -0
- /package/src/core/{templates → markdown/templates}/reference-guide.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,296 +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
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
26
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
27
|
-
};
|
|
28
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
-
exports.ReflectionError = exports.generateDocs = void 0;
|
|
30
|
-
const apex_reflection_1 = require("@cparra/apex-reflection");
|
|
31
|
-
const O = __importStar(require("fp-ts/Option"));
|
|
32
|
-
const function_1 = require("fp-ts/function");
|
|
33
|
-
const E = __importStar(require("fp-ts/Either"));
|
|
34
|
-
const apex_types_1 = require("./adapters/apex-types");
|
|
35
|
-
const template_1 = require("./template");
|
|
36
|
-
const reference_guide_1 = require("./templates/reference-guide");
|
|
37
|
-
const documentables_1 = require("./adapters/documentables");
|
|
38
|
-
const inheritance_chain_1 = require("./inheritance-chain");
|
|
39
|
-
const manifest_1 = __importDefault(require("./manifest"));
|
|
40
|
-
// TODO: The core should never depend on things from the outside, so it should never reference "back" (../)
|
|
41
|
-
const class_template_1 = require("../transpiler/markdown/plain-markdown/class-template");
|
|
42
|
-
const interface_template_1 = require("../transpiler/markdown/plain-markdown/interface-template");
|
|
43
|
-
const enum_template_1 = require("../transpiler/markdown/plain-markdown/enum-template");
|
|
44
|
-
const metadata_processor_1 = __importDefault(require("../service/metadata-processor"));
|
|
45
|
-
const configDefaults = {
|
|
46
|
-
scope: ['public'],
|
|
47
|
-
outputDir: 'docs',
|
|
48
|
-
defaultGroupName: 'Miscellaneous',
|
|
49
|
-
referenceGuideTemplate: reference_guide_1.referenceGuideTemplate,
|
|
50
|
-
};
|
|
51
|
-
function generateDocs(input, config) {
|
|
52
|
-
const configWithDefaults = Object.assign(Object.assign({}, configDefaults), config);
|
|
53
|
-
return (0, function_1.pipe)(input, (input) => input.map((bundle) => reflectSourceBody(bundle)), checkForReflectionErrors, E.map((types) => filterTypesOutOfScope(types, configWithDefaults.scope)), E.map((types) => types.map((type) => addInheritedMembers(type, types))), E.map((types) => types.map((type) => addInheritanceChain(type, types))), E.map((types) => typesToRenderableBundle(types, configWithDefaults)), E.map(({ references, renderables }) => ({
|
|
54
|
-
referenceGuide: (0, function_1.pipe)(referencesToReferenceGuide(references, configWithDefaults.referenceGuideTemplate)),
|
|
55
|
-
docs: renderables.map((renderable) => renderableToOutputDoc(Object.values(references).flat(), renderable)),
|
|
56
|
-
})), E.map(({ referenceGuide, docs }) => ({ format: 'markdown', referenceGuide: referenceGuide, docs })));
|
|
57
|
-
}
|
|
58
|
-
exports.generateDocs = generateDocs;
|
|
59
|
-
function typesToRenderableBundle(types, config) {
|
|
60
|
-
return types.reduce((acc, type) => {
|
|
61
|
-
var _a;
|
|
62
|
-
const renderable = (0, apex_types_1.typeToRenderable)(type, (referenceName) => {
|
|
63
|
-
return linkFromTypeNameGenerator(type, types, referenceName, config);
|
|
64
|
-
}, config.namespace);
|
|
65
|
-
acc.renderables.push(renderable);
|
|
66
|
-
const descriptionLines = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines;
|
|
67
|
-
const reference = {
|
|
68
|
-
typeName: type.name,
|
|
69
|
-
directory: getDirectoryFromRoot(config, type),
|
|
70
|
-
title: getLinkFromRoot(config, type),
|
|
71
|
-
description: (0, documentables_1.adaptDescribable)(descriptionLines, (referenceName) => getPossibleLinkFromRoot(config, referenceName, findType(types, referenceName))).description,
|
|
72
|
-
};
|
|
73
|
-
const group = getTypeGroup(type, config);
|
|
74
|
-
if (!acc.references[group]) {
|
|
75
|
-
acc.references[group] = [];
|
|
76
|
-
}
|
|
77
|
-
acc.references[group].push(reference);
|
|
78
|
-
return acc;
|
|
79
|
-
}, {
|
|
80
|
-
references: {},
|
|
81
|
-
renderables: [],
|
|
82
|
-
});
|
|
83
|
-
}
|
|
84
|
-
function renderableToOutputDoc(referenceGuideReference, renderable) {
|
|
85
|
-
function buildDocOutput(renderable, docContents) {
|
|
86
|
-
const reference = referenceGuideReference.find((ref) => ref.typeName.toLowerCase() === renderable.name.toLowerCase());
|
|
87
|
-
return {
|
|
88
|
-
directory: reference.directory,
|
|
89
|
-
docContents,
|
|
90
|
-
typeName: renderable.name,
|
|
91
|
-
type: renderable.type,
|
|
92
|
-
};
|
|
93
|
-
}
|
|
94
|
-
return (0, function_1.pipe)(renderable, resolveApexTypeTemplate, compile, (docContents) => buildDocOutput(renderable, docContents));
|
|
95
|
-
}
|
|
96
|
-
function referencesToReferenceGuide(references, template) {
|
|
97
|
-
function alphabetizeReferences(references) {
|
|
98
|
-
return Object.keys(references)
|
|
99
|
-
.sort((a, b) => a.localeCompare(b))
|
|
100
|
-
.reduce((acc, key) => {
|
|
101
|
-
acc[key] = references[key].sort((a, b) => a.title.toString().localeCompare(b.title.toString()));
|
|
102
|
-
return acc;
|
|
103
|
-
}, {});
|
|
104
|
-
}
|
|
105
|
-
return (0, function_1.pipe)(references, alphabetizeReferences, (references) => compile({
|
|
106
|
-
template: template,
|
|
107
|
-
source: references,
|
|
108
|
-
}));
|
|
109
|
-
}
|
|
110
|
-
function filterTypesOutOfScope(types, scope) {
|
|
111
|
-
return new manifest_1.default(types).filteredByAccessModifierAndAnnotations(scope);
|
|
112
|
-
}
|
|
113
|
-
function checkForReflectionErrors(reflectionResult) {
|
|
114
|
-
function reduceReflectionResultIntoSingleEither(results) {
|
|
115
|
-
return results.reduce((acc, result) => {
|
|
116
|
-
E.isLeft(result) ? acc.errors.push(result.left) : acc.types.push(result.right);
|
|
117
|
-
return acc;
|
|
118
|
-
}, {
|
|
119
|
-
errors: [],
|
|
120
|
-
types: [],
|
|
121
|
-
});
|
|
122
|
-
}
|
|
123
|
-
return (0, function_1.pipe)(reflectionResult, reduceReflectionResultIntoSingleEither, ({ errors, types }) => errors.length ? E.left(errors) : E.right(types));
|
|
124
|
-
}
|
|
125
|
-
function addFileMetadataToTypeAnnotation(type, metadata) {
|
|
126
|
-
return (0, function_1.pipe)(O.fromNullable(metadata), O.map((metadata) => {
|
|
127
|
-
const metadataParams = metadata_processor_1.default.process(metadata);
|
|
128
|
-
metadataParams.forEach((value, key) => {
|
|
129
|
-
const declaration = `${key}: ${value}`;
|
|
130
|
-
type.annotations.push({
|
|
131
|
-
rawDeclaration: declaration,
|
|
132
|
-
name: declaration,
|
|
133
|
-
type: declaration,
|
|
134
|
-
});
|
|
135
|
-
});
|
|
136
|
-
return type;
|
|
137
|
-
}), O.getOrElse(() => type));
|
|
138
|
-
}
|
|
139
|
-
class ReflectionError {
|
|
140
|
-
constructor(file, message) {
|
|
141
|
-
this.file = file;
|
|
142
|
-
this.message = message;
|
|
143
|
-
}
|
|
144
|
-
}
|
|
145
|
-
exports.ReflectionError = ReflectionError;
|
|
146
|
-
function reflectSourceBody(apexBundle) {
|
|
147
|
-
const { filePath, rawTypeContent: input, rawMetadataContent: metadata } = apexBundle;
|
|
148
|
-
const result = (0, apex_reflection_1.reflect)(input);
|
|
149
|
-
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
150
|
-
return result.error
|
|
151
|
-
? E.left(new ReflectionError(filePath, result.error.message))
|
|
152
|
-
: E.right(addFileMetadataToTypeAnnotation(result.typeMirror, metadata));
|
|
153
|
-
}
|
|
154
|
-
function resolveApexTypeTemplate(renderable) {
|
|
155
|
-
function getTemplate(renderable) {
|
|
156
|
-
switch (renderable.type) {
|
|
157
|
-
case 'enum':
|
|
158
|
-
return enum_template_1.enumMarkdownTemplate;
|
|
159
|
-
case 'interface':
|
|
160
|
-
return interface_template_1.interfaceMarkdownTemplate;
|
|
161
|
-
case 'class':
|
|
162
|
-
return class_template_1.classMarkdownTemplate;
|
|
163
|
-
}
|
|
164
|
-
}
|
|
165
|
-
return {
|
|
166
|
-
template: getTemplate(renderable),
|
|
167
|
-
source: renderable,
|
|
168
|
-
};
|
|
169
|
-
}
|
|
170
|
-
function compile(request) {
|
|
171
|
-
return template_1.Template.getInstance().compile(request);
|
|
172
|
-
}
|
|
173
|
-
function findType(repository, referenceName) {
|
|
174
|
-
return repository.find((currentType) => currentType.name.toLowerCase() === referenceName.toLowerCase());
|
|
175
|
-
}
|
|
176
|
-
function addInheritedMembers(current, repository) {
|
|
177
|
-
if (current.type_name === 'enum') {
|
|
178
|
-
return current;
|
|
179
|
-
}
|
|
180
|
-
else if (current.type_name === 'interface') {
|
|
181
|
-
return addInheritedInterfaceMethods(current, repository);
|
|
182
|
-
}
|
|
183
|
-
else {
|
|
184
|
-
return addInheritedClassMembers(current, repository);
|
|
185
|
-
}
|
|
186
|
-
}
|
|
187
|
-
function addInheritanceChain(current, repository) {
|
|
188
|
-
if (current.type_name === 'enum' || current.type_name === 'interface') {
|
|
189
|
-
return current;
|
|
190
|
-
}
|
|
191
|
-
else {
|
|
192
|
-
const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, current);
|
|
193
|
-
return Object.assign(Object.assign({}, current), { inheritanceChain });
|
|
194
|
-
}
|
|
195
|
-
}
|
|
196
|
-
function getParents(extendedNamesExtractor, current, repository) {
|
|
197
|
-
return (0, function_1.pipe)(extendedNamesExtractor(current), (interfaces) => interfaces.map((interfaceName) => repository.find((type) => type.name === interfaceName)), (interfaces = []) => interfaces.filter((type) => type !== undefined), (interfaces) => interfaces.reduce((acc, current) => [...acc, ...getParents(extendedNamesExtractor, current, repository)], interfaces));
|
|
198
|
-
}
|
|
199
|
-
function addInheritedInterfaceMethods(interfaceMirror, repository) {
|
|
200
|
-
function methodAlreadyExists(memberName, members) {
|
|
201
|
-
return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
|
|
202
|
-
}
|
|
203
|
-
function parentExtractor(interfaceMirror) {
|
|
204
|
-
return interfaceMirror.extended_interfaces;
|
|
205
|
-
}
|
|
206
|
-
const parents = getParents(parentExtractor, interfaceMirror, repository);
|
|
207
|
-
return Object.assign(Object.assign({}, interfaceMirror), { methods: parents.reduce((acc, currentValue) => [
|
|
208
|
-
...acc,
|
|
209
|
-
...currentValue.methods
|
|
210
|
-
.filter((method) => !methodAlreadyExists(method.name, acc))
|
|
211
|
-
.map((method) => (Object.assign(Object.assign({}, method), { inherited: true }))),
|
|
212
|
-
], interfaceMirror.methods) });
|
|
213
|
-
}
|
|
214
|
-
function addInheritedClassMembers(classMirror, repository) {
|
|
215
|
-
function memberAlreadyExists(memberName, members) {
|
|
216
|
-
return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
|
|
217
|
-
}
|
|
218
|
-
function parentExtractor(classMirror) {
|
|
219
|
-
return classMirror.extended_class ? [classMirror.extended_class] : [];
|
|
220
|
-
}
|
|
221
|
-
function filterMember(members, existing) {
|
|
222
|
-
return members
|
|
223
|
-
.filter((member) => member.access_modifier.toLowerCase() !== 'private')
|
|
224
|
-
.filter((member) => !memberAlreadyExists(member.name, existing))
|
|
225
|
-
.map((member) => (Object.assign(Object.assign({}, member), { inherited: true })));
|
|
226
|
-
}
|
|
227
|
-
const parents = getParents(parentExtractor, classMirror, repository);
|
|
228
|
-
return Object.assign(Object.assign({}, classMirror), { fields: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.fields, acc)], classMirror.fields), properties: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.properties, acc)], classMirror.properties), methods: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.methods, acc)], classMirror.methods) });
|
|
229
|
-
}
|
|
230
|
-
function linkFromTypeNameGenerator(typeBeingDocumented, repository, referenceName, config) {
|
|
231
|
-
const type = findType(repository, referenceName);
|
|
232
|
-
if (!type) {
|
|
233
|
-
// If the type is not found, we return the type name as a string.
|
|
234
|
-
return referenceName;
|
|
235
|
-
}
|
|
236
|
-
const [fullClassName, fileLink] = getFileLinkTuple(typeBeingDocumented, type, config);
|
|
237
|
-
return {
|
|
238
|
-
__type: 'link',
|
|
239
|
-
title: fullClassName,
|
|
240
|
-
url: fileLink,
|
|
241
|
-
};
|
|
242
|
-
}
|
|
243
|
-
function getFileLinkTuple(typeBeingDocumented, referencedType, config) {
|
|
244
|
-
const namespacePrefix = config.namespace ? `${config.namespace}.` : '';
|
|
245
|
-
const directoryRoot = `${getDirectoryRoot(typeBeingDocumented, referencedType, config)}`;
|
|
246
|
-
// TODO: Instead of adding a "." to the name when there is a namespace, maybe we want to create a folder for everything
|
|
247
|
-
// within that namespace and put the files in there.
|
|
248
|
-
const fullClassName = `${namespacePrefix}${referencedType.name}`;
|
|
249
|
-
return [fullClassName, `${directoryRoot}${fullClassName}.md`];
|
|
250
|
-
}
|
|
251
|
-
function getDirectoryFromRoot(config, type) {
|
|
252
|
-
if (!type) {
|
|
253
|
-
return '';
|
|
254
|
-
}
|
|
255
|
-
return `./${getSanitizedGroup(type, config)}`;
|
|
256
|
-
}
|
|
257
|
-
function getPossibleLinkFromRoot(config, fallback, type) {
|
|
258
|
-
if (!type) {
|
|
259
|
-
return fallback;
|
|
260
|
-
}
|
|
261
|
-
const namespacePrefix = config.namespace ? `${config.namespace}.` : '';
|
|
262
|
-
const title = `${namespacePrefix}${type.name}`;
|
|
263
|
-
return {
|
|
264
|
-
__type: 'link',
|
|
265
|
-
title: title,
|
|
266
|
-
url: `${getDirectoryFromRoot(config, type)}/${title}.md`,
|
|
267
|
-
};
|
|
268
|
-
}
|
|
269
|
-
function getLinkFromRoot(config, type) {
|
|
270
|
-
const namespacePrefix = config.namespace ? `${config.namespace}.` : '';
|
|
271
|
-
const title = `${namespacePrefix}${type.name}`;
|
|
272
|
-
return {
|
|
273
|
-
__type: 'link',
|
|
274
|
-
title: title,
|
|
275
|
-
url: `${getDirectoryFromRoot(config, type)}/${title}.md`,
|
|
276
|
-
};
|
|
277
|
-
}
|
|
278
|
-
function getDirectoryRoot(typeBeingDocumented, referencedType, config) {
|
|
279
|
-
if (getTypeGroup(typeBeingDocumented, config) === getTypeGroup(referencedType, config)) {
|
|
280
|
-
// If the types the same groups then we simply link directly to that file
|
|
281
|
-
return './';
|
|
282
|
-
}
|
|
283
|
-
else {
|
|
284
|
-
// If the types have different groups, then we have to go up a directory
|
|
285
|
-
return `../${getSanitizedGroup(referencedType, config)}/`;
|
|
286
|
-
}
|
|
287
|
-
}
|
|
288
|
-
function getTypeGroup(type, config) {
|
|
289
|
-
var _a, _b;
|
|
290
|
-
const groupAnnotation = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === 'group');
|
|
291
|
-
return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : config.defaultGroupName;
|
|
292
|
-
}
|
|
293
|
-
function getSanitizedGroup(classModel, config) {
|
|
294
|
-
return getTypeGroup(classModel, config).replace(/ /g, '-').replace('.', '');
|
|
295
|
-
}
|
|
296
|
-
//# sourceMappingURL=generate-docs.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"generate-docs.js","sourceRoot":"","sources":["../../src/core/generate-docs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6DAA0G;AAC1G,gDAAkC;AAClC,6CAAsC;AACtC,gDAAkC;AAElC,sDAAyD;AAEzD,yCAA0D;AAC1D,iEAAqE;AACrE,4DAA4D;AAC5D,2DAA6D;AAE7D,0DAAkC;AAElC,2GAA2G;AAC3G,yFAA6F;AAC7F,iGAAqG;AACrG,uFAA2F;AAC3F,uFAA8D;AAwB9D,MAAM,cAAc,GAAwB;IAC1C,KAAK,EAAE,CAAC,QAAQ,CAAC;IACjB,SAAS,EAAE,MAAM;IACjB,gBAAgB,EAAE,eAAe;IACjC,sBAAsB,EAAE,wCAAsB;CAC/C,CAAC;AAEF,SAAgB,YAAY,CAC1B,KAAmB,EACnB,MAAqC;IAErC,MAAM,kBAAkB,mCAAQ,cAAc,GAAK,MAAM,CAAE,CAAC;IAC5D,OAAO,IAAA,eAAI,EACT,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,EAC3D,wBAAwB,EACxB,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC,EACxE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACvE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACvE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAuB,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,EACpE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,cAAc,EAAE,IAAA,eAAI,EAAC,0BAA0B,CAAC,UAAU,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;QACvG,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE,UAAU,CAAC,CAAC;KAC3G,CAAC,CAAC,EACH,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CACpG,CAAC;AACJ,CAAC;AAnBD,oCAmBC;AAiBD,SAAS,uBAAuB,CAAC,KAAa,EAAE,MAA2B;IACzE,OAAO,KAAK,CAAC,MAAM,CACjB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;;QACZ,MAAM,UAAU,GAAG,IAAA,6BAAgB,EACjC,IAAI,EACJ,CAAC,aAAa,EAAE,EAAE;YAChB,OAAO,yBAAyB,CAAC,IAAI,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;QACvE,CAAC,EACD,MAAM,CAAC,SAAS,CACjB,CAAC;QACF,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjC,MAAM,gBAAgB,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,gBAAgB,CAAC;QAC3D,MAAM,SAAS,GAAG;YAChB,QAAQ,EAAE,IAAI,CAAC,IAAI;YACnB,SAAS,EAAE,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC;YAC7C,KAAK,EAAE,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;YACpC,WAAW,EAAE,IAAA,gCAAgB,EAAC,gBAAgB,EAAE,CAAC,aAAa,EAAE,EAAE,CAChE,uBAAuB,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAC/E,CAAC,WAAW;SACd,CAAC;QAEF,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC7B,CAAC;QACD,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtC,OAAO,GAAG,CAAC;IACb,CAAC,EACD;QACE,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,EAAE;KAChB,CACF,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,uBAAkD,EAAE,UAAsB;IACvG,SAAS,cAAc,CAAC,UAAsB,EAAE,WAAmB;QACjE,MAAM,SAAS,GAAG,uBAAuB,CAAC,IAAI,CAC5C,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CACtE,CAAC;QACF,OAAO;YACL,SAAS,EAAE,SAAU,CAAC,SAAS;YAC/B,WAAW;YACX,QAAQ,EAAE,UAAU,CAAC,IAAI;YACzB,IAAI,EAAE,UAAU,CAAC,IAAI;SACtB,CAAC;IACJ,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,UAAU,EAAE,uBAAuB,EAAE,OAAO,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;AACtH,CAAC;AAED,SAAS,0BAA0B,CACjC,UAAwD,EACxD,QAAgB;IAEhB,SAAS,qBAAqB,CAAC,UAAwD;QAGrF,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;aAC3B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;aAClC,MAAM,CAA+C,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACjE,GAAG,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAChG,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,UAAU,EAAE,qBAAqB,EAAE,CAAC,UAAU,EAAE,EAAE,CAC5D,OAAO,CAAC;QACN,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,UAAU;KACnB,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAa,EAAE,KAAe;IAC3D,OAAO,IAAI,kBAAQ,CAAC,KAAK,CAAC,CAAC,sCAAsC,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,wBAAwB,CAAC,gBAAmD;IACnF,SAAS,sCAAsC,CAAC,OAA0C;QAIxF,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACd,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC/E,OAAO,GAAG,CAAC;QACb,CAAC,EACD;YACE,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,EAAE;SACV,CACF,CAAC;IACJ,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,gBAAgB,EAAE,sCAAsC,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAC1F,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,SAAS,+BAA+B,CAAC,IAAU,EAAE,QAAuB;IAC1E,OAAO,IAAA,eAAI,EACT,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,EACxB,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjB,MAAM,cAAc,GAAG,4BAAiB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3D,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACpC,MAAM,WAAW,GAAG,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC;YACvC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;gBACpB,cAAc,EAAE,WAAW;gBAC3B,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,EACF,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CACxB,CAAC;AACJ,CAAC;AAED,MAAa,eAAe;IAC1B,YACS,IAAY,EACZ,OAAe;QADf,SAAI,GAAJ,IAAI,CAAQ;QACZ,YAAO,GAAP,OAAO,CAAQ;IACrB,CAAC;CACL;AALD,0CAKC;AAED,SAAS,iBAAiB,CAAC,UAAsB;IAC/C,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,kBAAkB,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;IACrF,MAAM,MAAM,GAAG,IAAA,yBAAgB,EAAC,KAAK,CAAC,CAAC;IACvC,oEAAoE;IACpE,OAAO,MAAM,CAAC,KAAK;QACjB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,+BAA+B,CAAC,MAAM,CAAC,UAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC7E,CAAC;AAED,SAAS,uBAAuB,CAAC,UAAsB;IACrD,SAAS,WAAW,CAAC,UAAsB;QACzC,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;YACxB,KAAK,MAAM;gBACT,OAAO,oCAAoB,CAAC;YAC9B,KAAK,WAAW;gBACd,OAAO,8CAAyB,CAAC;YACnC,KAAK,OAAO;gBACV,OAAO,sCAAqB,CAAC;QACjC,CAAC;IACH,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC;QACjC,MAAM,EAAE,UAA4B;KACrC,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,OAA2B;IAC1C,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,QAAQ,CAAC,UAAkB,EAAE,aAAqB;IACzD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;AAChH,CAAC;AAED,SAAS,mBAAmB,CAAiB,OAAU,EAAE,UAAkB;IACzE,IAAI,OAAO,CAAC,SAAS,KAAK,MAAM,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC;IACjB,CAAC;SAAM,IAAI,OAAO,CAAC,SAAS,KAAK,WAAW,EAAE,CAAC;QAC7C,OAAO,4BAA4B,CAAC,OAA0B,EAAE,UAAU,CAAM,CAAC;IACnF,CAAC;SAAM,CAAC;QACN,OAAO,wBAAwB,CAAC,OAAsB,EAAE,UAAU,CAAM,CAAC;IAC3E,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAAiB,OAAU,EAAE,UAAkB;IACzE,IAAI,OAAO,CAAC,SAAS,KAAK,MAAM,IAAI,OAAO,CAAC,SAAS,KAAK,WAAW,EAAE,CAAC;QACtE,OAAO,OAAO,CAAC;IACjB,CAAC;SAAM,CAAC;QACN,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,OAAsB,CAAC,CAAC;QACpF,uCACK,OAAO,KACV,gBAAgB,IAChB;IACJ,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CACjB,sBAAgD,EAChD,OAAU,EACV,UAAkB;IAElB,OAAO,IAAA,eAAI,EACT,sBAAsB,CAAC,OAAO,CAAC,EAC/B,CAAC,UAAoB,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC,EACnH,CAAC,UAAU,GAAG,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAQ,EAC3E,CAAC,UAAU,EAAE,EAAE,CACb,UAAU,CAAC,MAAM,CACf,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,UAAU,CAAC,sBAAsB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,EACtF,UAAU,CACX,CACJ,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CAAC,eAAgC,EAAE,UAAkB;IACxF,SAAS,mBAAmB,CAAC,UAAkB,EAAE,OAA2B;QAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,SAAS,eAAe,CAAC,eAAgC;QACvD,OAAO,eAAe,CAAC,mBAAmB,CAAC;IAC7C,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;IACzE,uCACK,eAAe,KAClB,OAAO,EAAE,OAAO,CAAC,MAAM,CACrB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC;YACrB,GAAG,GAAG;YACN,GAAG,YAAY,CAAC,OAAO;iBACpB,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;iBAC1D,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACZ,MAAM,KACT,SAAS,EAAE,IAAI,IACf,CAAC;SACN,EACD,eAAe,CAAC,OAAO,CACxB,IACD;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,WAAwB,EAAE,UAAkB;IAC5E,SAAS,mBAAmB,CAAC,UAAkB,EAAE,OAA2B;QAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,SAAS,eAAe,CAAC,WAAwB;QAC/C,OAAO,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,CAAC;IAED,SAAS,YAAY,CAAsD,OAAY,EAAE,QAAa;QACpG,OAAO,OAAO;aACX,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC;aACtE,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;aAC/D,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACZ,MAAM,KACT,SAAS,EAAE,IAAI,IACf,CAAC,CAAC;IACR,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;IACrE,uCACK,WAAW,KACd,MAAM,EAAE,OAAO,CAAC,MAAM,CACpB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAC1E,WAAW,CAAC,MAAM,CACnB,EACD,UAAU,EAAE,OAAO,CAAC,MAAM,CACxB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,EAC9E,WAAW,CAAC,UAAU,CACvB,EACD,OAAO,EAAE,OAAO,CAAC,MAAM,CACrB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,EAC3E,WAAW,CAAC,OAAO,CACpB,IACD;AACJ,CAAC;AAED,SAAS,yBAAyB,CAChC,mBAAyB,EACzB,UAAkB,EAClB,aAAqB,EACrB,MAA2B;IAE3B,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;IACjD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,iEAAiE;QACjE,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,gBAAgB,CAAC,mBAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACtF,OAAO;QACL,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,aAAa;QACpB,GAAG,EAAE,QAAQ;KACd,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CACvB,mBAAyB,EACzB,cAAoB,EACpB,MAA2B;IAE3B,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,MAAM,aAAa,GAAG,GAAG,gBAAgB,CAAC,mBAAmB,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,CAAC;IACzF,uHAAuH;IACvH,oDAAoD;IACpD,MAAM,aAAa,GAAG,GAAG,eAAe,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC;IACjE,OAAO,CAAC,aAAa,EAAE,GAAG,aAAa,GAAG,aAAa,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,oBAAoB,CAAC,MAA2B,EAAE,IAAW;IACpE,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,KAAK,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;AAChD,CAAC;AAED,SAAS,uBAAuB,CAAC,MAA2B,EAAE,QAAgB,EAAE,IAAW;IACzF,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,MAAM,KAAK,GAAG,GAAG,eAAe,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC/C,OAAO;QACL,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,KAAK;QACZ,GAAG,EAAE,GAAG,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,KAAK,KAAK;KACzD,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,MAA2B,EAAE,IAAU;IAC9D,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,MAAM,KAAK,GAAG,GAAG,eAAe,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC/C,OAAO;QACL,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,KAAK;QACZ,GAAG,EAAE,GAAG,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,KAAK,KAAK;KACzD,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,mBAAyB,EAAE,cAAoB,EAAE,MAA2B;IACpG,IAAI,YAAY,CAAC,mBAAmB,EAAE,MAAM,CAAC,KAAK,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,CAAC;QACvF,yEAAyE;QACzE,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,CAAC;QACN,wEAAwE;QACxE,OAAO,MAAM,iBAAiB,CAAC,cAAc,EAAE,MAAM,CAAC,GAAG,CAAC;IAC5D,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAU,EAAE,MAA2B;;IAC3D,MAAM,eAAe,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,CAAC;IACrH,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,MAAM,CAAC,gBAAgB,CAAC;AAC1D,CAAC;AAED,SAAS,iBAAiB,CAAC,UAAgB,EAAE,MAA2B;IACtE,OAAO,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AAC9E,CAAC"}
|
|
@@ -1,36 +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.createInheritanceChain = void 0;
|
|
27
|
-
const function_1 = require("fp-ts/function");
|
|
28
|
-
const O = __importStar(require("fp-ts/Option"));
|
|
29
|
-
function createInheritanceChain(repository, classMirror) {
|
|
30
|
-
return (0, function_1.pipe)(O.fromNullable(classMirror.extended_class), O.match(() => [], (extendedClassName) => inheritanceChainFromParentClassName(repository, extendedClassName)));
|
|
31
|
-
}
|
|
32
|
-
exports.createInheritanceChain = createInheritanceChain;
|
|
33
|
-
function inheritanceChainFromParentClassName(repository, className) {
|
|
34
|
-
return (0, function_1.pipe)(O.fromNullable(repository.find((type) => type.name.toLowerCase() === className.toLowerCase())), O.match(() => [className], (extendedClass) => [className, ...createInheritanceChain(repository, extendedClass)]));
|
|
35
|
-
}
|
|
36
|
-
//# sourceMappingURL=inheritance-chain.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"inheritance-chain.js","sourceRoot":"","sources":["../../src/core/inheritance-chain.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAAsC;AACtC,gDAAkC;AAElC,SAAgB,sBAAsB,CAAC,UAAkB,EAAE,WAAwB;IACjF,OAAO,IAAA,eAAI,EACT,CAAC,CAAC,YAAY,CAAC,WAAW,CAAC,cAAc,CAAC,EAC1C,CAAC,CAAC,KAAK,CACL,GAAG,EAAE,CAAC,EAAE,EACR,CAAC,iBAAiB,EAAE,EAAE,CAAC,mCAAmC,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAC1F,CACF,CAAC;AACJ,CAAC;AARD,wDAQC;AAED,SAAS,mCAAmC,CAAC,UAAkB,EAAE,SAAiB;IAChF,OAAO,IAAA,eAAI,EACT,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,EAC9F,CAAC,CAAC,KAAK,CACL,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC,EACjB,CAAC,aAAmB,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,GAAG,sBAAsB,CAAC,UAAU,EAAE,aAA4B,CAAC,CAAC,CAC1G,CACF,CAAC;AACJ,CAAC"}
|
package/dist/core/manifest.d.ts
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
import { Type, Annotation, DocComment } from '@cparra/apex-reflection';
|
|
2
|
-
type AccessAndDocAware = {
|
|
3
|
-
access_modifier: string;
|
|
4
|
-
annotations: Annotation[];
|
|
5
|
-
docComment?: DocComment;
|
|
6
|
-
};
|
|
7
|
-
/**
|
|
8
|
-
* Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
|
|
9
|
-
*/
|
|
10
|
-
export default class Manifest {
|
|
11
|
-
types: Type[];
|
|
12
|
-
isForInnerTypes: boolean;
|
|
13
|
-
/**
|
|
14
|
-
* Constructs a new Manifest object.
|
|
15
|
-
* @param types List of types to be wrapped by this object.
|
|
16
|
-
* @param isForInnerTypes Whether this manifest represent an inner type or not.
|
|
17
|
-
*/
|
|
18
|
-
constructor(types: Type[], isForInnerTypes?: boolean);
|
|
19
|
-
filteredByAccessModifierAndAnnotations(modifiers: string[]): Type[];
|
|
20
|
-
filterAccessibleModifier(accessAndDocAware: AccessAndDocAware[], modifiers: string[]): AccessAndDocAware[];
|
|
21
|
-
}
|
|
22
|
-
export {};
|
package/dist/core/manifest.js
DELETED
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
/**
|
|
4
|
-
* Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
|
|
5
|
-
*/
|
|
6
|
-
class Manifest {
|
|
7
|
-
/**
|
|
8
|
-
* Constructs a new Manifest object.
|
|
9
|
-
* @param types List of types to be wrapped by this object.
|
|
10
|
-
* @param isForInnerTypes Whether this manifest represent an inner type or not.
|
|
11
|
-
*/
|
|
12
|
-
constructor(types, isForInnerTypes = false) {
|
|
13
|
-
this.types = types;
|
|
14
|
-
this.isForInnerTypes = isForInnerTypes;
|
|
15
|
-
}
|
|
16
|
-
filteredByAccessModifierAndAnnotations(modifiers) {
|
|
17
|
-
const filteredTypes = this.filterAccessibleModifier(this.types, modifiers);
|
|
18
|
-
const typesToReturn = [];
|
|
19
|
-
for (const filteredType of filteredTypes) {
|
|
20
|
-
const currentType = filteredType;
|
|
21
|
-
if (currentType.type_name === 'enum') {
|
|
22
|
-
// Ignoring enum values is not supported.
|
|
23
|
-
typesToReturn.push(currentType);
|
|
24
|
-
continue;
|
|
25
|
-
}
|
|
26
|
-
if (currentType.type_name === 'interface') {
|
|
27
|
-
const currentInterface = currentType;
|
|
28
|
-
typesToReturn.push(Object.assign(Object.assign({}, currentType), { methods: this.filterAccessibleModifier(currentInterface.methods, modifiers) }));
|
|
29
|
-
continue;
|
|
30
|
-
}
|
|
31
|
-
const currentClass = currentType;
|
|
32
|
-
let filteredClass = Object.assign(Object.assign({}, currentType), { methods: this.filterAccessibleModifier(currentClass.methods, modifiers), properties: this.filterAccessibleModifier(currentClass.properties, modifiers), fields: this.filterAccessibleModifier(currentClass.fields, modifiers), constructors: this.filterAccessibleModifier(currentClass.constructors, modifiers) });
|
|
33
|
-
if (!this.isForInnerTypes) {
|
|
34
|
-
filteredClass = Object.assign(Object.assign({}, filteredClass), { enums: this.filterAccessibleModifier(currentClass.enums, modifiers), interfaces: this.filterAccessibleModifier(currentClass.interfaces, modifiers), classes: new Manifest(currentClass.classes, true).filteredByAccessModifierAndAnnotations(modifiers) });
|
|
35
|
-
}
|
|
36
|
-
typesToReturn.push(filteredClass);
|
|
37
|
-
}
|
|
38
|
-
return typesToReturn;
|
|
39
|
-
}
|
|
40
|
-
filterAccessibleModifier(accessAndDocAware, modifiers) {
|
|
41
|
-
return accessAndDocAware.filter((currentType) => {
|
|
42
|
-
var _a;
|
|
43
|
-
const hasIgnoreDocAnnotation = (_a = currentType.docComment) === null || _a === void 0 ? void 0 : _a.annotations.some((annotation) => annotation.name.toLowerCase() === 'ignore');
|
|
44
|
-
if (hasIgnoreDocAnnotation) {
|
|
45
|
-
return false;
|
|
46
|
-
}
|
|
47
|
-
return (modifiers.includes(currentType.access_modifier) ||
|
|
48
|
-
currentType.annotations.some((annotation) => modifiers.includes(annotation.type.toLowerCase())));
|
|
49
|
-
});
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
exports.default = Manifest;
|
|
53
|
-
//# sourceMappingURL=manifest.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../src/core/manifest.ts"],"names":[],"mappings":";;AAYA;;GAEG;AACH,MAAqB,QAAQ;IAC3B;;;;OAIG;IACH,YAAmB,KAAa,EAAS,kBAA2B,KAAK;QAAtD,UAAK,GAAL,KAAK,CAAQ;QAAS,oBAAe,GAAf,eAAe,CAAiB;IAAG,CAAC;IAE7E,sCAAsC,CAAC,SAAmB;QACxD,MAAM,aAAa,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC3E,MAAM,aAAa,GAAW,EAAE,CAAC;QACjC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,MAAM,WAAW,GAAG,YAAoB,CAAC;YACzC,IAAI,WAAW,CAAC,SAAS,KAAK,MAAM,EAAE,CAAC;gBACrC,yCAAyC;gBACzC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAChC,SAAS;YACX,CAAC;YAED,IAAI,WAAW,CAAC,SAAS,KAAK,WAAW,EAAE,CAAC;gBAC1C,MAAM,gBAAgB,GAAG,WAA8B,CAAC;gBACxD,aAAa,CAAC,IAAI,CAAC,gCACd,WAAW,KACd,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,GACzD,CAAC,CAAC;gBACtB,SAAS;YACX,CAAC;YAED,MAAM,YAAY,GAAG,WAA0B,CAAC;YAChD,IAAI,aAAa,GAAG,gCACf,WAAW,KACd,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EACvE,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,EAC7E,MAAM,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,EACrE,YAAY,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,GACnE,CAAC;YAEjB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;gBAC1B,aAAa,mCACR,aAAa,KAChB,KAAK,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,CAAiB,EACnF,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAsB,EAClG,OAAO,EAAE,IAAI,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,sCAAsC,CACtF,SAAS,CACO,GACnB,CAAC;YACJ,CAAC;YAED,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,wBAAwB,CAAC,iBAAsC,EAAE,SAAmB;QAClF,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE;;YAC9C,MAAM,sBAAsB,GAAG,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACrE,CAAC,UAAgC,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,QAAQ,CACjF,CAAC;YACF,IAAI,sBAAsB,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,CACL,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,eAAe,CAAC;gBAC/C,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAsB,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAC5G,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AApED,2BAoEC"}
|
package/dist/core/template.d.ts
DELETED
package/dist/core/template.js
DELETED
|
@@ -1,97 +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.Template = void 0;
|
|
7
|
-
const handlebars_1 = __importDefault(require("handlebars"));
|
|
8
|
-
const type_doc_partial_1 = require("../transpiler/markdown/plain-markdown/type-doc-partial");
|
|
9
|
-
const documentable_partial_template_1 = require("../transpiler/markdown/plain-markdown/documentable-partial-template");
|
|
10
|
-
const methods_partial_template_1 = require("../transpiler/markdown/plain-markdown/methods-partial-template");
|
|
11
|
-
const constructors_partial_template_1 = require("../transpiler/markdown/plain-markdown/constructors-partial-template");
|
|
12
|
-
const fieldsPartialTemplate_1 = require("../transpiler/markdown/plain-markdown/fieldsPartialTemplate");
|
|
13
|
-
const class_template_1 = require("../transpiler/markdown/plain-markdown/class-template");
|
|
14
|
-
const enum_template_1 = require("../transpiler/markdown/plain-markdown/enum-template");
|
|
15
|
-
const interface_template_1 = require("../transpiler/markdown/plain-markdown/interface-template");
|
|
16
|
-
const type_utils_1 = require("./adapters/type-utils");
|
|
17
|
-
const grouped_members_partial_template_1 = require("../transpiler/markdown/plain-markdown/grouped-members-partial-template");
|
|
18
|
-
class Template {
|
|
19
|
-
constructor() {
|
|
20
|
-
handlebars_1.default.registerPartial('typeDocumentation', type_doc_partial_1.typeDocPartial);
|
|
21
|
-
handlebars_1.default.registerPartial('documentablePartialTemplate', documentable_partial_template_1.documentablePartialTemplate);
|
|
22
|
-
handlebars_1.default.registerPartial('methodsPartialTemplate', methods_partial_template_1.methodsPartialTemplate);
|
|
23
|
-
handlebars_1.default.registerPartial('constructorsPartialTemplate', constructors_partial_template_1.constructorsPartialTemplate);
|
|
24
|
-
handlebars_1.default.registerPartial('groupedMembersPartialTemplate', grouped_members_partial_template_1.groupedMembersPartialTemplate);
|
|
25
|
-
handlebars_1.default.registerPartial('fieldsPartialTemplate', fieldsPartialTemplate_1.fieldsPartialTemplate);
|
|
26
|
-
handlebars_1.default.registerPartial('classTemplate', class_template_1.classMarkdownTemplate);
|
|
27
|
-
handlebars_1.default.registerPartial('enumTemplate', enum_template_1.enumMarkdownTemplate);
|
|
28
|
-
handlebars_1.default.registerPartial('interfaceTemplate', interface_template_1.interfaceMarkdownTemplate);
|
|
29
|
-
handlebars_1.default.registerHelper('link', link);
|
|
30
|
-
handlebars_1.default.registerHelper('code', convertCodeBlock);
|
|
31
|
-
handlebars_1.default.registerHelper('renderContent', resolveRenderableContent);
|
|
32
|
-
handlebars_1.default.registerHelper('heading', heading);
|
|
33
|
-
handlebars_1.default.registerHelper('inlineCode', inlineCode);
|
|
34
|
-
handlebars_1.default.registerHelper('splitAndCapitalize', splitAndCapitalize);
|
|
35
|
-
}
|
|
36
|
-
static getInstance() {
|
|
37
|
-
if (!Template.instance) {
|
|
38
|
-
Template.instance = new Template();
|
|
39
|
-
}
|
|
40
|
-
return Template.instance;
|
|
41
|
-
}
|
|
42
|
-
compile(request) {
|
|
43
|
-
const compiled = handlebars_1.default.compile(request.template);
|
|
44
|
-
return (compiled(request.source)
|
|
45
|
-
.trim()
|
|
46
|
-
// clean up extra newlines
|
|
47
|
-
.replace(/\n{3,}/g, '\n\n'));
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
exports.Template = Template;
|
|
51
|
-
const splitAndCapitalize = (text) => {
|
|
52
|
-
const words = text.split(/[-_]+/);
|
|
53
|
-
const capitalizedWords = [];
|
|
54
|
-
for (const word of words) {
|
|
55
|
-
capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
|
|
56
|
-
}
|
|
57
|
-
return capitalizedWords.join(' ');
|
|
58
|
-
};
|
|
59
|
-
const heading = (level, text) => {
|
|
60
|
-
return `${'#'.repeat(level)} ${text}`;
|
|
61
|
-
};
|
|
62
|
-
const inlineCode = (text) => {
|
|
63
|
-
return new handlebars_1.default.SafeString(`\`${text}\``);
|
|
64
|
-
};
|
|
65
|
-
const convertCodeBlock = (codeBlock) => {
|
|
66
|
-
return new handlebars_1.default.SafeString(`
|
|
67
|
-
\`\`\`${codeBlock.language}
|
|
68
|
-
${codeBlock.content.join('\n')}
|
|
69
|
-
\`\`\`
|
|
70
|
-
`.trim());
|
|
71
|
-
};
|
|
72
|
-
const resolveRenderableContent = (description) => {
|
|
73
|
-
if (!description) {
|
|
74
|
-
return '';
|
|
75
|
-
}
|
|
76
|
-
function reduceDescription(acc, curr) {
|
|
77
|
-
if ((0, type_utils_1.isEmptyLine)(curr)) {
|
|
78
|
-
return acc + '\n\n';
|
|
79
|
-
}
|
|
80
|
-
if ((0, type_utils_1.isCodeBlock)(curr)) {
|
|
81
|
-
return acc + convertCodeBlock(curr) + '\n';
|
|
82
|
-
}
|
|
83
|
-
else {
|
|
84
|
-
return acc + handlebars_1.default.escapeExpression(link(curr)).trim() + ' ';
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
return description.reduce(reduceDescription, '').trim();
|
|
88
|
-
};
|
|
89
|
-
const link = (source) => {
|
|
90
|
-
if (typeof source === 'string') {
|
|
91
|
-
return source;
|
|
92
|
-
}
|
|
93
|
-
else {
|
|
94
|
-
return `[${source.title}](${source.url})`;
|
|
95
|
-
}
|
|
96
|
-
};
|
|
97
|
-
//# sourceMappingURL=template.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"template.js","sourceRoot":"","sources":["../../src/core/template.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAoC;AACpC,6FAAwF;AACxF,uHAAkH;AAClH,6GAAwG;AACxG,uHAAkH;AAClH,uGAAoG;AACpG,yFAA6F;AAC7F,uFAA2F;AAC3F,iGAAqG;AAErG,sDAAiE;AACjE,6HAAuH;AAOvH,MAAa,QAAQ;IAGnB;QACE,oBAAU,CAAC,eAAe,CAAC,mBAAmB,EAAE,iCAAc,CAAC,CAAC;QAChE,oBAAU,CAAC,eAAe,CAAC,6BAA6B,EAAE,2DAA2B,CAAC,CAAC;QACvF,oBAAU,CAAC,eAAe,CAAC,wBAAwB,EAAE,iDAAsB,CAAC,CAAC;QAC7E,oBAAU,CAAC,eAAe,CAAC,6BAA6B,EAAE,2DAA2B,CAAC,CAAC;QACvF,oBAAU,CAAC,eAAe,CAAC,+BAA+B,EAAE,gEAA6B,CAAC,CAAC;QAC3F,oBAAU,CAAC,eAAe,CAAC,uBAAuB,EAAE,6CAAqB,CAAC,CAAC;QAC3E,oBAAU,CAAC,eAAe,CAAC,eAAe,EAAE,sCAAqB,CAAC,CAAC;QACnE,oBAAU,CAAC,eAAe,CAAC,cAAc,EAAE,oCAAoB,CAAC,CAAC;QACjE,oBAAU,CAAC,eAAe,CAAC,mBAAmB,EAAE,8CAAyB,CAAC,CAAC;QAE3E,oBAAU,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACxC,oBAAU,CAAC,cAAc,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACpD,oBAAU,CAAC,cAAc,CAAC,eAAe,EAAE,wBAAwB,CAAC,CAAC;QACrE,oBAAU,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC9C,oBAAU,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACpD,oBAAU,CAAC,cAAc,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,CAAC;IACtE,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACvB,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QACrC,CAAC;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,OAAO,CAAC,OAA2B;QACjC,MAAM,QAAQ,GAAG,oBAAU,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACtD,OAAO,CACL,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;aACrB,IAAI,EAAE;YACP,0BAA0B;aACzB,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAC9B,CAAC;IACJ,CAAC;CACF;AAtCD,4BAsCC;AAED,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,EAAE;IAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,IAAY,EAAE,EAAE;IAC9C,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE;IAClC,OAAO,IAAI,oBAAU,CAAC,UAAU,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,SAAoB,EAAyB,EAAE;IACvE,OAAO,IAAI,oBAAU,CAAC,UAAU,CAC9B;QACI,SAAS,CAAC,QAAQ;EACxB,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;;GAE3B,CAAC,IAAI,EAAE,CACP,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,WAAiC,EAAU,EAAE;IAC7E,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,SAAS,iBAAiB,CAAC,GAAW,EAAE,IAAuB;QAC7D,IAAI,IAAA,wBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,GAAG,GAAG,MAAM,CAAC;QACtB,CAAC;QACD,IAAI,IAAA,wBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,GAAG,GAAG,gBAAgB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QAC7C,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,GAAG,oBAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC;QACpE,CAAC;IACH,CAAC;IAED,OAAO,WAAW,CAAC,MAAM,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,CAAC,MAAoB,EAAU,EAAE;IAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,GAAG,GAAG,CAAC;IAC5C,CAAC;AACH,CAAC,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const referenceGuideTemplate: string;
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.referenceGuideTemplate = void 0;
|
|
4
|
-
exports.referenceGuideTemplate = `
|
|
5
|
-
# Apex Reference Guide
|
|
6
|
-
|
|
7
|
-
{{#each this}}
|
|
8
|
-
## {{@key}}
|
|
9
|
-
|
|
10
|
-
{{#each this}}
|
|
11
|
-
### {{link title}}
|
|
12
|
-
|
|
13
|
-
{{{renderContent description}}}
|
|
14
|
-
|
|
15
|
-
{{/each}}
|
|
16
|
-
{{/each}}
|
|
17
|
-
`.trim();
|
|
18
|
-
//# sourceMappingURL=reference-guide.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"reference-guide.js","sourceRoot":"","sources":["../../../src/core/templates/reference-guide.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;;;;;;;;;;;;;CAarC,CAAC,IAAI,EAAE,CAAC"}
|
package/dist/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAAsD;AAE7C,gCAAU"}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { ClassMirror, MethodMirror } from '@cparra/apex-reflection';
|
|
2
|
-
export declare class ClassMirrorWrapper {
|
|
3
|
-
classMirror: ClassMirror;
|
|
4
|
-
constructor(classMirror: ClassMirror);
|
|
5
|
-
getMethodsByAnnotation(annotation: string): MethodMirror[];
|
|
6
|
-
private hasAnnotation;
|
|
7
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ClassMirrorWrapper = void 0;
|
|
4
|
-
class ClassMirrorWrapper {
|
|
5
|
-
constructor(classMirror) {
|
|
6
|
-
this.classMirror = classMirror;
|
|
7
|
-
this.hasAnnotation = (method, annotationName) => method.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName);
|
|
8
|
-
}
|
|
9
|
-
getMethodsByAnnotation(annotation) {
|
|
10
|
-
return this.classMirror.methods.filter((method) => this.hasAnnotation(method, annotation));
|
|
11
|
-
}
|
|
12
|
-
}
|
|
13
|
-
exports.ClassMirrorWrapper = ClassMirrorWrapper;
|
|
14
|
-
//# sourceMappingURL=ClassMirrorWrapper.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ClassMirrorWrapper.js","sourceRoot":"","sources":["../../../src/model/apex-type-wrappers/ClassMirrorWrapper.ts"],"names":[],"mappings":";;;AAEA,MAAa,kBAAkB;IAC7B,YAAmB,WAAwB;QAAxB,gBAAW,GAAX,WAAW,CAAa;QAMnC,kBAAa,GAAG,CAAC,MAAoB,EAAE,cAAsB,EAAE,EAAE,CACvE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;IAP9C,CAAC;IAE/C,sBAAsB,CAAC,UAAkB;QACvC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IAC7F,CAAC;CAIF;AATD,gDASC"}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { DocCommentAnnotation, MethodMirror } from '@cparra/apex-reflection';
|
|
2
|
-
export declare class MethodMirrorWrapper {
|
|
3
|
-
methodMirror: MethodMirror;
|
|
4
|
-
constructor(methodMirror: MethodMirror);
|
|
5
|
-
hasDocCommentAnnotation: (annotationName: string) => boolean | undefined;
|
|
6
|
-
getDocCommentAnnotation: (annotationName: string) => DocCommentAnnotation | undefined;
|
|
7
|
-
}
|