@cparra/apexdocs 2.25.0-alpha.0 → 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/__mocks__/chalk.js +12 -0
- package/__mocks__/log-update.js +6 -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/eslint.config.mjs +10 -0
- package/examples/markdown/docs/index.md +109 -0
- package/examples/markdown/docs/miscellaneous/BaseClass.md +16 -0
- package/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md +72 -0
- package/examples/markdown/docs/miscellaneous/ParentInterface.md +15 -0
- package/examples/markdown/docs/miscellaneous/ReferencedEnum.md +8 -0
- package/examples/markdown/docs/miscellaneous/SampleException.md +24 -0
- package/examples/markdown/docs/miscellaneous/SampleInterface.md +112 -0
- package/examples/markdown/docs/miscellaneous/Url.md +309 -0
- package/examples/markdown/docs/sample-enums/SampleEnum.md +36 -0
- package/examples/markdown/docs/samplegroup/SampleClass.md +170 -0
- package/examples/markdown/force-app/classes/MultiInheritanceClass.cls +1 -0
- package/examples/{plain-markdown → markdown}/force-app/classes/SampleClass.cls +37 -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 +4 -8
- 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 +6 -1
- package/jest.d.ts +7 -0
- package/package.json +29 -30
- 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/core/markdown/__test__/expect-extensions.ts +32 -0
- package/src/core/markdown/__test__/generating-class-docs.spec.ts +735 -0
- package/src/core/markdown/__test__/generating-enum-docs.spec.ts +385 -0
- package/src/core/markdown/__test__/generating-interface-docs.spec.ts +461 -0
- package/src/core/markdown/__test__/generating-reference-guide.spec.ts +180 -0
- 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/core/markdown/adapters/apex-types.ts +238 -0
- package/src/core/markdown/adapters/documentables.ts +116 -0
- package/src/core/markdown/adapters/fields-and-properties.ts +45 -0
- package/src/{adapters/references.ts → core/markdown/adapters/inline.ts} +43 -13
- package/src/core/markdown/adapters/methods-and-constructors.ts +133 -0
- 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/markdown/adapters/types.d.ts +180 -0
- 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/core/markdown/templates/class-template.ts +75 -0
- package/src/core/markdown/templates/constructors-partial-template.ts +32 -0
- package/src/core/markdown/templates/documentable-partial-template.ts +26 -0
- package/src/core/markdown/templates/enum-template.ts +12 -0
- package/src/core/markdown/templates/fieldsPartialTemplate.ts +23 -0
- package/src/core/markdown/templates/grouped-members-partial-template.ts +6 -0
- package/src/core/markdown/templates/hookable.ts +7 -0
- package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/interface-template.ts +4 -4
- package/src/core/markdown/templates/methods-partial-template.ts +43 -0
- package/src/core/markdown/templates/reference-guide.ts +14 -0
- package/src/core/markdown/templates/template.ts +114 -0
- package/src/core/markdown/templates/type-doc-partial.ts +27 -0
- 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 +9 -9
- 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 +6 -5
- 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 +41 -1
- 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 +7 -3
- package/.eslintrc.js +0 -12
- 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/README.md +0 -301
- package/examples/plain-markdown/force-app/classes/SampleException.cls +0 -1
- package/examples/plain-markdown/template.md +0 -3
- package/lib/adapters/apex-types.d.ts +0 -5
- package/lib/adapters/apex-types.js +0 -34
- package/lib/adapters/apex-types.js.map +0 -1
- package/lib/adapters/documentables.d.ts +0 -6
- package/lib/adapters/documentables.js +0 -41
- package/lib/adapters/documentables.js.map +0 -1
- package/lib/adapters/fields-and-properties.d.ts +0 -3
- package/lib/adapters/fields-and-properties.js +0 -10
- package/lib/adapters/fields-and-properties.js.map +0 -1
- package/lib/adapters/methods-and-constructors.d.ts +0 -4
- package/lib/adapters/methods-and-constructors.js +0 -49
- 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 -8
- 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/index.d.ts +0 -1
- package/lib/index.js +0 -18
- 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 -47
- package/lib/model/manifest.js.map +0 -1
- package/lib/model/markdown-file.d.ts +0 -16
- package/lib/model/markdown-file.js +0 -110
- 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 -47
- 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 -55
- 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 -115
- 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 -82
- 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 -29
- 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 -17
- 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 -70
- package/lib/settings.js +0 -100
- package/lib/settings.js.map +0 -1
- package/lib/templating/compile.d.ts +0 -7
- package/lib/templating/compile.js +0 -98
- package/lib/templating/compile.js.map +0 -1
- package/lib/templating/helpers.d.ts +0 -2
- package/lib/templating/helpers.js +0 -18
- package/lib/templating/helpers.js.map +0 -1
- package/lib/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 -36
- 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 -39
- 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 -25
- 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 -15
- 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 -24
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.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 -49
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +0 -13
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +0 -122
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.d.ts +0 -1
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js +0 -31
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js.map +0 -1
- package/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 -249
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -10
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -20
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -7
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +0 -22
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -1
- package/lib/transpiler/processor-type-transpiler.d.ts +0 -10
- package/lib/transpiler/processor-type-transpiler.js +0 -9
- package/lib/transpiler/processor-type-transpiler.js.map +0 -1
- package/lib/transpiler/transpiler.d.ts +0 -5
- package/lib/transpiler/transpiler.js +0 -30
- package/lib/transpiler/transpiler.js.map +0 -1
- package/lib/util/error-logger.d.ts +0 -8
- package/lib/util/error-logger.js +0 -90
- package/lib/util/error-logger.js.map +0 -1
- package/lib/util/logger.d.ts +0 -21
- package/lib/util/logger.js +0 -61
- package/lib/util/logger.js.map +0 -1
- package/lib/util/string-utils.d.ts +0 -2
- package/lib/util/string-utils.js +0 -15
- package/lib/util/string-utils.js.map +0 -1
- package/src/adapters/__tests__/interface-adapter.spec.ts +0 -76
- package/src/adapters/apex-types.ts +0 -67
- package/src/adapters/documentables.ts +0 -58
- package/src/adapters/fields-and-properties.ts +0 -14
- package/src/adapters/methods-and-constructors.ts +0 -78
- package/src/adapters/type-utils.ts +0 -5
- package/src/adapters/types.d.ts +0 -8
- package/src/model/apex-bundle.ts +0 -3
- package/src/model/inheritance.ts +0 -7
- package/src/model/manifest.ts +0 -74
- package/src/model/markdown-file.ts +0 -121
- 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 -29
- 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 -162
- package/src/templating/__tests__/compile.spec.ts +0 -741
- package/src/templating/compile.ts +0 -187
- package/src/templating/helpers.ts +0 -14
- package/src/templating/types.d.ts +0 -104
- package/src/transpiler/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/class-template.ts +0 -32
- package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +0 -35
- package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +0 -21
- package/src/transpiler/markdown/plain-markdown/enum-template.ts +0 -11
- package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +0 -20
- package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +0 -45
- package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +0 -134
- package/src/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.ts +0 -27
- 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/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/{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,76 +0,0 @@
|
|
|
1
|
-
import { InterfaceMirrorBuilder } from '../../test-helpers/InterfaceMirrorBuilder';
|
|
2
|
-
import { AnnotationBuilder } from '../../test-helpers/AnnotationBuilder';
|
|
3
|
-
import { MethodMirrorBuilder, ParameterBuilder } from '../../test-helpers/MethodMirrorBuilder';
|
|
4
|
-
import { interfaceTypeToInterfaceSource } from '../apex-types';
|
|
5
|
-
|
|
6
|
-
describe('Conversion from InterfaceMirror to InterfaceSource understandable by the templating engine', () => {
|
|
7
|
-
it('converts the name', () => {
|
|
8
|
-
const interfaceMirror = new InterfaceMirrorBuilder().withName('SampleInterface').build();
|
|
9
|
-
const interfaceSource = interfaceTypeToInterfaceSource(interfaceMirror);
|
|
10
|
-
|
|
11
|
-
expect(interfaceSource.name).toBe('SampleInterface');
|
|
12
|
-
});
|
|
13
|
-
|
|
14
|
-
it('converts the access modifier', () => {
|
|
15
|
-
const interfaceMirror = new InterfaceMirrorBuilder().build();
|
|
16
|
-
const interfaceSource = interfaceTypeToInterfaceSource(interfaceMirror);
|
|
17
|
-
|
|
18
|
-
expect(interfaceSource.accessModifier).toBe('public');
|
|
19
|
-
});
|
|
20
|
-
|
|
21
|
-
it('converts annotations', () => {
|
|
22
|
-
const interfaceMirror = new InterfaceMirrorBuilder()
|
|
23
|
-
.addAnnotation(new AnnotationBuilder().withName('MyAnnotation').build())
|
|
24
|
-
.build();
|
|
25
|
-
const interfaceSource = interfaceTypeToInterfaceSource(interfaceMirror);
|
|
26
|
-
|
|
27
|
-
expect(interfaceSource.annotations).toEqual(['MYANNOTATION']);
|
|
28
|
-
});
|
|
29
|
-
|
|
30
|
-
it('converts method declarations. Method with no parameters', () => {
|
|
31
|
-
const interfaceMirror = new InterfaceMirrorBuilder()
|
|
32
|
-
.addMethod(
|
|
33
|
-
new MethodMirrorBuilder()
|
|
34
|
-
.withName('sampleMethod')
|
|
35
|
-
.withTypeReference({
|
|
36
|
-
type: 'String',
|
|
37
|
-
rawDeclaration: 'String',
|
|
38
|
-
})
|
|
39
|
-
.build(),
|
|
40
|
-
)
|
|
41
|
-
.build();
|
|
42
|
-
|
|
43
|
-
const interfaceSource = interfaceTypeToInterfaceSource(interfaceMirror);
|
|
44
|
-
|
|
45
|
-
expect(interfaceSource.methods).toHaveLength(1);
|
|
46
|
-
expect(interfaceSource.methods![0].signature).toBe('public String sampleMethod()');
|
|
47
|
-
});
|
|
48
|
-
|
|
49
|
-
it('converts method declarations. Method with parameters', () => {
|
|
50
|
-
const interfaceMirror = new InterfaceMirrorBuilder()
|
|
51
|
-
.addMethod(
|
|
52
|
-
new MethodMirrorBuilder()
|
|
53
|
-
.withName('sampleMethod')
|
|
54
|
-
.withTypeReference({
|
|
55
|
-
type: 'String',
|
|
56
|
-
rawDeclaration: 'String',
|
|
57
|
-
})
|
|
58
|
-
.addParameter(
|
|
59
|
-
new ParameterBuilder()
|
|
60
|
-
.withName('param1')
|
|
61
|
-
.withTypeReference({
|
|
62
|
-
type: 'String',
|
|
63
|
-
rawDeclaration: 'String',
|
|
64
|
-
})
|
|
65
|
-
.build(),
|
|
66
|
-
)
|
|
67
|
-
.build(),
|
|
68
|
-
)
|
|
69
|
-
.build();
|
|
70
|
-
|
|
71
|
-
const interfaceSource = interfaceTypeToInterfaceSource(interfaceMirror);
|
|
72
|
-
|
|
73
|
-
expect(interfaceSource.methods).toHaveLength(1);
|
|
74
|
-
expect(interfaceSource.methods![0].signature).toBe('public String sampleMethod(String param1)');
|
|
75
|
-
});
|
|
76
|
-
});
|
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
import { ClassMirror, EnumMirror, InterfaceMirror, Type } from '@cparra/apex-reflection';
|
|
2
|
-
import { BaseTypeSource, ClassSource, EnumSource, InterfaceSource } from '../templating/types';
|
|
3
|
-
import { adaptDescribable, adaptDocumentable } from './documentables';
|
|
4
|
-
import { linkFromTypeNameGenerator } from './references';
|
|
5
|
-
import { FieldMirrorWithInheritance } from '../model/inheritance';
|
|
6
|
-
import { adaptConstructor, adaptMethod } from './methods-and-constructors';
|
|
7
|
-
import { adaptField } from './fields-and-properties';
|
|
8
|
-
|
|
9
|
-
function baseTypeAdapter(type: EnumMirror | InterfaceMirror | ClassMirror): BaseTypeSource {
|
|
10
|
-
function extractAnnotationBody(type: Type, annotationName: string): string | undefined {
|
|
11
|
-
return type.docComment?.annotations.find(
|
|
12
|
-
(currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName,
|
|
13
|
-
)?.body;
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
function extractSeeAnnotations(type: Type): string[] {
|
|
17
|
-
return (
|
|
18
|
-
type.docComment?.annotations
|
|
19
|
-
.filter((currentAnnotation) => currentAnnotation.name.toLowerCase() === 'see')
|
|
20
|
-
.map((currentAnnotation) => currentAnnotation.body) ?? []
|
|
21
|
-
);
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
return {
|
|
25
|
-
...adaptDocumentable(type),
|
|
26
|
-
accessModifier: type.access_modifier,
|
|
27
|
-
name: type.name,
|
|
28
|
-
group: extractAnnotationBody(type, 'group'),
|
|
29
|
-
author: extractAnnotationBody(type, 'author'),
|
|
30
|
-
date: extractAnnotationBody(type, 'date'),
|
|
31
|
-
sees: extractSeeAnnotations(type).map(linkFromTypeNameGenerator),
|
|
32
|
-
};
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
export function enumTypeToEnumSource(enumType: EnumMirror): EnumSource {
|
|
36
|
-
return {
|
|
37
|
-
__type: 'enum',
|
|
38
|
-
...baseTypeAdapter(enumType),
|
|
39
|
-
values: enumType.values.map((value) => ({
|
|
40
|
-
...adaptDescribable(value.docComment?.descriptionLines),
|
|
41
|
-
value: value.name,
|
|
42
|
-
})),
|
|
43
|
-
};
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
export function interfaceTypeToInterfaceSource(interfaceType: InterfaceMirror): InterfaceSource {
|
|
47
|
-
return {
|
|
48
|
-
__type: 'interface',
|
|
49
|
-
...baseTypeAdapter(interfaceType),
|
|
50
|
-
extends: interfaceType.extended_interfaces.map(linkFromTypeNameGenerator),
|
|
51
|
-
methods: interfaceType.methods.map(adaptMethod),
|
|
52
|
-
};
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
export function classTypeToClassSource(classType: ClassMirror): ClassSource {
|
|
56
|
-
return {
|
|
57
|
-
__type: 'class',
|
|
58
|
-
...baseTypeAdapter(classType),
|
|
59
|
-
classModifier: classType.classModifier,
|
|
60
|
-
sharingModifier: classType.sharingModifier,
|
|
61
|
-
implements: classType.implemented_interfaces.map(linkFromTypeNameGenerator),
|
|
62
|
-
extends: classType.extended_class ? linkFromTypeNameGenerator(classType.extended_class) : undefined,
|
|
63
|
-
methods: classType.methods.map(adaptMethod),
|
|
64
|
-
constructors: classType.constructors.map((constructor) => adaptConstructor(classType.name, constructor)),
|
|
65
|
-
fields: classType.fields.map((field) => adaptField(field as FieldMirrorWithInheritance)),
|
|
66
|
-
};
|
|
67
|
-
}
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
import { CustomTag, DocumentableSource, RenderableContent } from '../templating/types';
|
|
2
|
-
import { Describable, Documentable } from './types';
|
|
3
|
-
import { replaceInlineReferences } from './references';
|
|
4
|
-
import { isEmptyLine } from './type-utils';
|
|
5
|
-
|
|
6
|
-
export function adaptDescribable(describable: Describable): { description?: RenderableContent[] } {
|
|
7
|
-
function describableToRenderableContent(describable: Describable): RenderableContent[] | undefined {
|
|
8
|
-
if (!describable) {
|
|
9
|
-
return;
|
|
10
|
-
}
|
|
11
|
-
|
|
12
|
-
return (
|
|
13
|
-
describable
|
|
14
|
-
.map<RenderableContent[]>((line) => [
|
|
15
|
-
...replaceInlineReferences(line),
|
|
16
|
-
{
|
|
17
|
-
type: 'empty-line',
|
|
18
|
-
},
|
|
19
|
-
])
|
|
20
|
-
.flatMap((line) => line)
|
|
21
|
-
// If the last element is an empty line, remove it
|
|
22
|
-
.filter((line, index, lines) => !(isEmptyLine(line) && index === lines.length - 1))
|
|
23
|
-
);
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
return {
|
|
27
|
-
description: describableToRenderableContent(describable),
|
|
28
|
-
};
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
export function adaptDocumentable(documentable: Documentable): DocumentableSource {
|
|
32
|
-
function extractCustomTags(type: Documentable): CustomTag[] {
|
|
33
|
-
const baseTags = ['description', 'group', 'author', 'date', 'see', 'example', 'mermaid', 'throws', 'exception'];
|
|
34
|
-
|
|
35
|
-
return (
|
|
36
|
-
type.docComment?.annotations
|
|
37
|
-
.filter((currentAnnotation) => !baseTags.includes(currentAnnotation.name.toLowerCase()))
|
|
38
|
-
.map<CustomTag>((currentAnnotation) => ({
|
|
39
|
-
...adaptDescribable(currentAnnotation.bodyLines),
|
|
40
|
-
name: currentAnnotation.name,
|
|
41
|
-
})) ?? []
|
|
42
|
-
);
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
function extractAnnotationBodyLines(type: Documentable, annotationName: string): string[] | undefined {
|
|
46
|
-
return type.docComment?.annotations.find(
|
|
47
|
-
(currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName,
|
|
48
|
-
)?.bodyLines;
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
return {
|
|
52
|
-
...adaptDescribable(documentable.docComment?.descriptionLines),
|
|
53
|
-
annotations: documentable.annotations.map((annotation) => annotation.type.toUpperCase()),
|
|
54
|
-
customTags: extractCustomTags(documentable),
|
|
55
|
-
mermaid: extractAnnotationBodyLines(documentable, 'mermaid'),
|
|
56
|
-
example: documentable.docComment?.exampleAnnotation?.bodyLines,
|
|
57
|
-
};
|
|
58
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { FieldMirrorWithInheritance } from '../model/inheritance';
|
|
2
|
-
import { FieldSource } from '../templating/types';
|
|
3
|
-
import { adaptDocumentable } from './documentables';
|
|
4
|
-
import { linkFromTypeNameGenerator } from './references';
|
|
5
|
-
|
|
6
|
-
export function adaptField(field: FieldMirrorWithInheritance): FieldSource {
|
|
7
|
-
return {
|
|
8
|
-
...adaptDocumentable(field),
|
|
9
|
-
name: field.name,
|
|
10
|
-
type: linkFromTypeNameGenerator(field.typeReference.rawDeclaration),
|
|
11
|
-
inherited: field.inherited,
|
|
12
|
-
accessModifier: field.access_modifier,
|
|
13
|
-
};
|
|
14
|
-
}
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
import { ConstructorMirror, MethodMirror, ParameterMirror, ThrowsAnnotation } from '@cparra/apex-reflection';
|
|
2
|
-
import { ConstructorSource, MethodSource } from '../templating/types';
|
|
3
|
-
import { MethodMirrorWithInheritance } from '../model/inheritance';
|
|
4
|
-
import { adaptDescribable, adaptDocumentable } from './documentables';
|
|
5
|
-
import { linkFromTypeNameGenerator } from './references';
|
|
6
|
-
import { Documentable } from './types';
|
|
7
|
-
|
|
8
|
-
export function adaptMethod(method: MethodMirror): MethodSource {
|
|
9
|
-
function buildTitle(method: MethodMirrorWithInheritance): string {
|
|
10
|
-
const { name, parameters } = method;
|
|
11
|
-
const parametersString = parameters.map((param) => param.name).join(', ');
|
|
12
|
-
return `${name}(${parametersString})`;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
function buildSignature(method: MethodMirrorWithInheritance): string {
|
|
16
|
-
const { access_modifier, typeReference, name, memberModifiers } = method;
|
|
17
|
-
const parameters = method.parameters
|
|
18
|
-
.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`)
|
|
19
|
-
.join(', ');
|
|
20
|
-
const members = memberModifiers.length > 0 ? `${memberModifiers.join(' ')} ` : '';
|
|
21
|
-
return `${access_modifier} ${members}${typeReference.rawDeclaration} ${name}(${parameters})`;
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
return {
|
|
25
|
-
...adaptDocumentable(method),
|
|
26
|
-
title: buildTitle(method as MethodMirrorWithInheritance),
|
|
27
|
-
signature: buildSignature(method as MethodMirrorWithInheritance),
|
|
28
|
-
returnType: {
|
|
29
|
-
...adaptDescribable(method.docComment?.returnAnnotation?.bodyLines),
|
|
30
|
-
type: linkFromTypeNameGenerator(method.typeReference.rawDeclaration),
|
|
31
|
-
},
|
|
32
|
-
throws: method.docComment?.throwsAnnotations.map((thrown) => mapThrows(thrown)),
|
|
33
|
-
parameters: method.parameters.map((param) => mapParameters(method, param)),
|
|
34
|
-
inherited: (method as MethodMirrorWithInheritance).inherited,
|
|
35
|
-
};
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
export function adaptConstructor(typeName: string, constructor: ConstructorMirror): ConstructorSource {
|
|
39
|
-
function buildTitle(name: string, constructor: ConstructorMirror): string {
|
|
40
|
-
const { parameters } = constructor;
|
|
41
|
-
const parametersString = parameters.map((param) => param.name).join(', ');
|
|
42
|
-
return `${name}(${parametersString})`;
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
function buildSignature(name: string, constructor: ConstructorMirror): string {
|
|
46
|
-
const { access_modifier } = constructor;
|
|
47
|
-
const parameters = constructor.parameters
|
|
48
|
-
.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`)
|
|
49
|
-
.join(', ');
|
|
50
|
-
return `${access_modifier} ${name}(${parameters})`;
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
return {
|
|
54
|
-
...adaptDocumentable(constructor),
|
|
55
|
-
title: buildTitle(typeName, constructor),
|
|
56
|
-
signature: buildSignature(typeName, constructor),
|
|
57
|
-
parameters: constructor.parameters.map((param) => mapParameters(constructor, param)),
|
|
58
|
-
throws: constructor.docComment?.throwsAnnotations.map((thrown) => mapThrows(thrown)),
|
|
59
|
-
};
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
function mapParameters(documentable: Documentable, param: ParameterMirror) {
|
|
63
|
-
const paramAnnotation = documentable.docComment?.paramAnnotations.find(
|
|
64
|
-
(pa) => pa.paramName.toLowerCase() === param.name.toLowerCase(),
|
|
65
|
-
);
|
|
66
|
-
return {
|
|
67
|
-
...adaptDescribable(paramAnnotation?.bodyLines),
|
|
68
|
-
name: param.name,
|
|
69
|
-
type: linkFromTypeNameGenerator(param.typeReference.rawDeclaration),
|
|
70
|
-
};
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
function mapThrows(thrown: ThrowsAnnotation) {
|
|
74
|
-
return {
|
|
75
|
-
...adaptDescribable(thrown.bodyLines),
|
|
76
|
-
type: linkFromTypeNameGenerator(thrown.exceptionName),
|
|
77
|
-
};
|
|
78
|
-
}
|
package/src/adapters/types.d.ts
DELETED
package/src/model/apex-bundle.ts
DELETED
package/src/model/inheritance.ts
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { FieldMirror, MethodMirror, PropertyMirror } from '@cparra/apex-reflection';
|
|
2
|
-
|
|
3
|
-
export type InheritanceSupport = { inherited: boolean };
|
|
4
|
-
export type FieldMirrorWithInheritance = FieldMirror & InheritanceSupport;
|
|
5
|
-
export type PropertyMirrorWithInheritance = PropertyMirror & InheritanceSupport;
|
|
6
|
-
export type MethodMirrorWithInheritance = MethodMirror & InheritanceSupport;
|
|
7
|
-
export type FieldOrProperty = FieldMirrorWithInheritance | PropertyMirrorWithInheritance;
|
package/src/model/manifest.ts
DELETED
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
ClassMirror,
|
|
3
|
-
EnumMirror,
|
|
4
|
-
InterfaceMirror,
|
|
5
|
-
Type,
|
|
6
|
-
Annotation,
|
|
7
|
-
DocComment,
|
|
8
|
-
DocCommentAnnotation,
|
|
9
|
-
} from '@cparra/apex-reflection';
|
|
10
|
-
|
|
11
|
-
type AccessAndDocAware = { access_modifier: string; annotations: Annotation[]; docComment?: DocComment };
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
* Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
|
|
15
|
-
*/
|
|
16
|
-
export default class Manifest {
|
|
17
|
-
/**
|
|
18
|
-
* Constructs a new Manifest object.
|
|
19
|
-
* @param types List of types to be wrapped by this object.
|
|
20
|
-
* @param isForInnerTypes Whether this manifest represent an inner type or not.
|
|
21
|
-
*/
|
|
22
|
-
constructor(public types: Type[], public isForInnerTypes: boolean = false) {}
|
|
23
|
-
|
|
24
|
-
filteredByAccessModifierAndAnnotations(modifiers: string[]): Type[] {
|
|
25
|
-
const filteredTypes = this.filterAccessibleModifier(this.types, modifiers);
|
|
26
|
-
const typesToReturn: Type[] = [];
|
|
27
|
-
for (const filteredType of filteredTypes) {
|
|
28
|
-
const currentType = filteredType as Type;
|
|
29
|
-
if (currentType.type_name !== 'class') {
|
|
30
|
-
typesToReturn.push(currentType);
|
|
31
|
-
continue;
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
const currentClass = currentType as ClassMirror;
|
|
35
|
-
let filteredClass = {
|
|
36
|
-
...currentType,
|
|
37
|
-
methods: this.filterAccessibleModifier(currentClass.methods, modifiers),
|
|
38
|
-
properties: this.filterAccessibleModifier(currentClass.properties, modifiers),
|
|
39
|
-
fields: this.filterAccessibleModifier(currentClass.fields, modifiers),
|
|
40
|
-
constructors: this.filterAccessibleModifier(currentClass.constructors, modifiers),
|
|
41
|
-
} as ClassMirror;
|
|
42
|
-
|
|
43
|
-
if (!this.isForInnerTypes) {
|
|
44
|
-
filteredClass = {
|
|
45
|
-
...filteredClass,
|
|
46
|
-
enums: this.filterAccessibleModifier(currentClass.enums, modifiers) as EnumMirror[],
|
|
47
|
-
interfaces: this.filterAccessibleModifier(currentClass.interfaces, modifiers) as InterfaceMirror[],
|
|
48
|
-
classes: new Manifest(currentClass.classes, true).filteredByAccessModifierAndAnnotations(
|
|
49
|
-
modifiers,
|
|
50
|
-
) as ClassMirror[],
|
|
51
|
-
};
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
typesToReturn.push(filteredClass);
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
return typesToReturn;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
filterAccessibleModifier(accessAndDocAware: AccessAndDocAware[], modifiers: string[]) {
|
|
61
|
-
return accessAndDocAware.filter((currentType) => {
|
|
62
|
-
const hasIgnoreDocAnnotation = currentType.docComment?.annotations.some(
|
|
63
|
-
(annotation: DocCommentAnnotation) => annotation.name === 'ignore',
|
|
64
|
-
);
|
|
65
|
-
if (hasIgnoreDocAnnotation) {
|
|
66
|
-
return false;
|
|
67
|
-
}
|
|
68
|
-
return (
|
|
69
|
-
modifiers.includes(currentType.access_modifier) ||
|
|
70
|
-
currentType.annotations.some((annotation: Annotation) => modifiers.includes(annotation.type.toLowerCase()))
|
|
71
|
-
);
|
|
72
|
-
});
|
|
73
|
-
}
|
|
74
|
-
}
|
|
@@ -1,121 +0,0 @@
|
|
|
1
|
-
import { OutputFile } from './outputFile';
|
|
2
|
-
import ClassFileGeneratorHelper from '../transpiler/markdown/class-file-generatorHelper';
|
|
3
|
-
|
|
4
|
-
export class MarkdownFile extends OutputFile {
|
|
5
|
-
fileExtension(): string {
|
|
6
|
-
return '.md';
|
|
7
|
-
}
|
|
8
|
-
|
|
9
|
-
addTitle(text: string, level = 1) {
|
|
10
|
-
let title = '';
|
|
11
|
-
for (let i = 0; i < level; i++) {
|
|
12
|
-
title += '#';
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
title += ' ';
|
|
16
|
-
title += text;
|
|
17
|
-
this._contents += title;
|
|
18
|
-
this.addBlankLine();
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
public addText(text: string, encodeHtml = true) {
|
|
22
|
-
super.addText(this._replaceInlineReferences(text), encodeHtml);
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
public addLink(text: string, encodeHtml = true) {
|
|
26
|
-
this.addText(`\{@link ${text}\}`, encodeHtml);
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
startCodeBlock(language = 'apex') {
|
|
30
|
-
this.addText(`\`\`\`${language}`);
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
endCodeBlock() {
|
|
34
|
-
this.addText('```');
|
|
35
|
-
this.addBlankLine();
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
addHorizontalRule() {
|
|
39
|
-
this._contents += '---';
|
|
40
|
-
this.addBlankLine();
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
initializeTable(...headers: string[]) {
|
|
44
|
-
this.addBlankLine();
|
|
45
|
-
this._contents += '|';
|
|
46
|
-
headers.forEach((header) => {
|
|
47
|
-
this._contents += header + '|';
|
|
48
|
-
});
|
|
49
|
-
this.addBlankLine();
|
|
50
|
-
this._contents += '|';
|
|
51
|
-
headers.forEach(() => {
|
|
52
|
-
this._contents += '---' + '|';
|
|
53
|
-
});
|
|
54
|
-
this.addBlankLine();
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
addTableRow(...columns: string[]) {
|
|
58
|
-
this._contents += '|';
|
|
59
|
-
columns.forEach((column) => {
|
|
60
|
-
this._contents += this._replaceInlineReferences(column) + '|';
|
|
61
|
-
});
|
|
62
|
-
this.addBlankLine();
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
addListItem(text: string) {
|
|
66
|
-
this._contents += `* ${text}`;
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
protected static replaceInlineLinks(text: string) {
|
|
70
|
-
// Parsing text to extract possible linking classes.
|
|
71
|
-
const possibleLinks = text.match(/<<.*?>>/g);
|
|
72
|
-
possibleLinks?.forEach((currentMatch) => {
|
|
73
|
-
const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
|
|
74
|
-
text = text.replace(currentMatch, ClassFileGeneratorHelper.getFileLinkByTypeName(classNameForMatch));
|
|
75
|
-
});
|
|
76
|
-
|
|
77
|
-
// Parsing links using {@link ClassName} format
|
|
78
|
-
const linkFormatRegEx = '{@link (.*?)}';
|
|
79
|
-
const expression = new RegExp(linkFormatRegEx, 'gi');
|
|
80
|
-
let match;
|
|
81
|
-
const matches = [];
|
|
82
|
-
|
|
83
|
-
do {
|
|
84
|
-
match = expression.exec(text);
|
|
85
|
-
if (match) {
|
|
86
|
-
matches.push(match);
|
|
87
|
-
}
|
|
88
|
-
} while (match);
|
|
89
|
-
|
|
90
|
-
for (const currentMatch of matches) {
|
|
91
|
-
text = text.replace(currentMatch[0], ClassFileGeneratorHelper.getFileLinkByTypeName(currentMatch[1]));
|
|
92
|
-
}
|
|
93
|
-
return text;
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
protected static replaceInlineEmails(text: string) {
|
|
97
|
-
// Parsing links using {@link ClassName} format
|
|
98
|
-
const linkFormatRegEx = '{@email (.*?)}';
|
|
99
|
-
const expression = new RegExp(linkFormatRegEx, 'gi');
|
|
100
|
-
let match;
|
|
101
|
-
const matches = [];
|
|
102
|
-
|
|
103
|
-
do {
|
|
104
|
-
match = expression.exec(text);
|
|
105
|
-
if (match) {
|
|
106
|
-
matches.push(match);
|
|
107
|
-
}
|
|
108
|
-
} while (match);
|
|
109
|
-
|
|
110
|
-
for (const currentMatch of matches) {
|
|
111
|
-
text = text.replace(currentMatch[0], `[${currentMatch[1]}](mailto:${currentMatch[1]})`);
|
|
112
|
-
}
|
|
113
|
-
return text;
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
private _replaceInlineReferences(text: string): string {
|
|
117
|
-
text = MarkdownFile.replaceInlineLinks(text);
|
|
118
|
-
text = MarkdownFile.replaceInlineEmails(text);
|
|
119
|
-
return text;
|
|
120
|
-
}
|
|
121
|
-
}
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
import { DocComment, DocCommentAnnotation } from '@cparra/apex-reflection';
|
|
2
|
-
import ClassFileGeneratorHelper from '../../transpiler/markdown/class-file-generatorHelper';
|
|
3
|
-
import { MarkdownFile } from '../markdown-file';
|
|
4
|
-
|
|
5
|
-
interface DocCommentAware {
|
|
6
|
-
docComment?: DocComment;
|
|
7
|
-
}
|
|
8
|
-
|
|
9
|
-
export function addMermaid(markdownFile: MarkdownFile, docCommentAware: DocCommentAware) {
|
|
10
|
-
const mermaid = docCommentAware.docComment?.annotations.find((annotation) => annotation.name === 'mermaid');
|
|
11
|
-
if (!mermaid) {
|
|
12
|
-
return;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
markdownFile.addBlankLine();
|
|
16
|
-
markdownFile.startCodeBlock('mermaid');
|
|
17
|
-
mermaid.bodyLines.forEach((line) => {
|
|
18
|
-
markdownFile.addText(line, false);
|
|
19
|
-
});
|
|
20
|
-
markdownFile.endCodeBlock();
|
|
21
|
-
markdownFile.addBlankLine();
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
export function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCommentAware: DocCommentAware) {
|
|
25
|
-
docCommentAware.docComment?.annotations
|
|
26
|
-
.filter((currentAnnotation: DocCommentAnnotation) => currentAnnotation.name !== 'description')
|
|
27
|
-
.filter((currentAnnotation: DocCommentAnnotation) => currentAnnotation.name !== 'mermaid')
|
|
28
|
-
.forEach((currentAnnotation: DocCommentAnnotation) => {
|
|
29
|
-
markdownFile.addBlankLine();
|
|
30
|
-
markdownFile.addText(buildDocAnnotationText(currentAnnotation));
|
|
31
|
-
markdownFile.addBlankLine();
|
|
32
|
-
});
|
|
33
|
-
|
|
34
|
-
function splitAndCapitalize(text: string) {
|
|
35
|
-
const words = text.split(/[-_]+/);
|
|
36
|
-
const capitalizedWords = [];
|
|
37
|
-
for (const word of words) {
|
|
38
|
-
capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
|
|
39
|
-
}
|
|
40
|
-
return capitalizedWords.join(' ');
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
function buildDocAnnotationText(annotation: DocCommentAnnotation) {
|
|
44
|
-
let annotationBodyText = annotation.body;
|
|
45
|
-
if (annotation.name.toLowerCase() === 'see') {
|
|
46
|
-
annotationBodyText = ClassFileGeneratorHelper.getFileLinkByTypeName(annotation.body);
|
|
47
|
-
}
|
|
48
|
-
return `**${splitAndCapitalize(annotation.name)}** ${annotationBodyText}`;
|
|
49
|
-
}
|
|
50
|
-
}
|
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
import { MarkdownFile } from '../markdown-file';
|
|
2
|
-
import { FieldMirrorWithInheritance, FieldOrProperty, PropertyMirrorWithInheritance } from '../inheritance';
|
|
3
|
-
|
|
4
|
-
export function declareField(
|
|
5
|
-
markdownFile: MarkdownFile,
|
|
6
|
-
fields: FieldMirrorWithInheritance[] | PropertyMirrorWithInheritance[],
|
|
7
|
-
startingHeadingLevel: number,
|
|
8
|
-
grouped = false,
|
|
9
|
-
) {
|
|
10
|
-
markdownFile.addBlankLine();
|
|
11
|
-
fields.forEach((propertyModel) => {
|
|
12
|
-
addFieldSection(markdownFile, propertyModel, startingHeadingLevel, grouped);
|
|
13
|
-
});
|
|
14
|
-
|
|
15
|
-
markdownFile.addHorizontalRule();
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
function addFieldSection(
|
|
19
|
-
markdownFile: MarkdownFile,
|
|
20
|
-
mirrorModel: FieldOrProperty,
|
|
21
|
-
startingHeadingLevel: number,
|
|
22
|
-
grouped: boolean,
|
|
23
|
-
) {
|
|
24
|
-
if (!grouped) {
|
|
25
|
-
markdownFile.addTitle(
|
|
26
|
-
`\`${mirrorModel.access_modifier} ${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\``,
|
|
27
|
-
startingHeadingLevel + 2,
|
|
28
|
-
);
|
|
29
|
-
markdownFile.addBlankLine();
|
|
30
|
-
if (mirrorModel.inherited) {
|
|
31
|
-
markdownFile.addText('*Inherited*');
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
mirrorModel.annotations.forEach((annotation) => {
|
|
35
|
-
markdownFile.addText(`\`${annotation.type.toUpperCase()}\` `);
|
|
36
|
-
});
|
|
37
|
-
|
|
38
|
-
if (mirrorModel.docComment?.description) {
|
|
39
|
-
markdownFile.addBlankLine();
|
|
40
|
-
markdownFile.addText(mirrorModel.docComment.description);
|
|
41
|
-
}
|
|
42
|
-
markdownFile.addBlankLine();
|
|
43
|
-
} else {
|
|
44
|
-
let annotations = '';
|
|
45
|
-
const hasAnnotations = !!mirrorModel.annotations.length;
|
|
46
|
-
if (hasAnnotations) {
|
|
47
|
-
annotations += ' [';
|
|
48
|
-
}
|
|
49
|
-
mirrorModel.annotations.forEach((annotation) => {
|
|
50
|
-
annotations += `\`${annotation.type.toUpperCase()}\` `;
|
|
51
|
-
});
|
|
52
|
-
if (hasAnnotations) {
|
|
53
|
-
annotations += ']';
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
// If grouped we want to display these as a list
|
|
57
|
-
let description = '';
|
|
58
|
-
if (mirrorModel.docComment?.description) {
|
|
59
|
-
description = ` - ${mirrorModel.docComment?.description}`;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
let listItemText = `\`${mirrorModel.access_modifier} ${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\``;
|
|
63
|
-
if (mirrorModel.inherited) {
|
|
64
|
-
listItemText += '(*Inherited*)';
|
|
65
|
-
}
|
|
66
|
-
listItemText += `${annotations} ${description}`;
|
|
67
|
-
|
|
68
|
-
markdownFile.addListItem(listItemText);
|
|
69
|
-
markdownFile.addBlankLine();
|
|
70
|
-
}
|
|
71
|
-
}
|