@cparra/apexdocs 2.25.0-alpha.2 → 2.25.0-alpha.3
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/{lib → dist}/__spec__/core/expect-extensions.js +3 -2
- package/dist/__spec__/core/expect-extensions.js.map +1 -0
- package/{lib → dist}/__spec__/core/generating-class-docs.spec.js +54 -37
- package/dist/__spec__/core/generating-class-docs.spec.js.map +1 -0
- package/{lib → dist}/__spec__/core/generating-enum-docs.spec.js +25 -22
- package/dist/__spec__/core/generating-enum-docs.spec.js.map +1 -0
- package/{lib → dist}/__spec__/core/generating-interface-docs.spec.js +33 -30
- package/dist/__spec__/core/generating-interface-docs.spec.js.map +1 -0
- package/{lib → dist}/__spec__/core/generating-reference-guide.spec.js +8 -7
- package/dist/__spec__/core/generating-reference-guide.spec.js.map +1 -0
- package/dist/__spec__/core/test-helpers.d.ts +2 -0
- package/dist/__spec__/core/test-helpers.js +12 -0
- package/dist/__spec__/core/test-helpers.js.map +1 -0
- package/{lib → dist}/application/Apexdocs.d.ts +4 -2
- package/{lib → dist}/application/Apexdocs.js +30 -3
- package/dist/application/Apexdocs.js.map +1 -0
- package/{lib/application/flows → dist/application/generators}/generate-markdown-files.d.ts +1 -1
- package/{lib/application/flows → dist/application/generators}/generate-markdown-files.js +9 -2
- package/dist/application/generators/generate-markdown-files.js.map +1 -0
- package/dist/cli/args.d.ts +39 -0
- package/{lib/cli/generate.js → dist/cli/args.js} +37 -40
- package/dist/cli/args.js.map +1 -0
- package/dist/cli/generate.js +291 -0
- package/dist/cli/generate.js.map +1 -0
- package/dist/core/adapters/apex-types.d.ts +6 -0
- package/{lib → dist/core}/adapters/apex-types.js +3 -3
- package/dist/core/adapters/apex-types.js.map +1 -0
- package/{lib → dist/core}/adapters/documentables.d.ts +1 -1
- package/dist/core/adapters/documentables.js +154 -0
- package/dist/core/adapters/documentables.js.map +1 -0
- package/{lib → dist/core}/adapters/fields-and-properties.d.ts +1 -2
- package/{lib → dist/core}/adapters/fields-and-properties.js +10 -4
- package/dist/core/adapters/fields-and-properties.js.map +1 -0
- package/{lib → dist/core}/adapters/methods-and-constructors.d.ts +1 -1
- package/{lib → dist/core}/adapters/methods-and-constructors.js +15 -6
- package/dist/core/adapters/methods-and-constructors.js.map +1 -0
- package/{lib → dist/core}/adapters/references.d.ts +2 -3
- package/{lib → dist/core}/adapters/references.js +5 -9
- package/dist/core/adapters/references.js.map +1 -0
- package/dist/core/adapters/type-utils.d.ts +3 -0
- package/dist/core/adapters/type-utils.js +12 -0
- package/dist/core/adapters/type-utils.js.map +1 -0
- package/dist/core/apex-bundle.js.map +1 -0
- package/{lib → dist}/core/generate-docs.d.ts +7 -3
- package/{lib → dist}/core/generate-docs.js +43 -14
- package/dist/core/generate-docs.js.map +1 -0
- package/{lib → dist}/core/inheritance-chain.js +2 -1
- package/dist/core/inheritance-chain.js.map +1 -0
- package/dist/core/manifest.js.map +1 -0
- package/{lib → dist}/core/template.js +12 -7
- package/{lib → dist}/core/template.js.map +1 -1
- package/{lib → dist}/core/templates/reference-guide.js +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1 -0
- package/{lib → dist}/model/markdown-generation-util/doc-comment-annotation-util.js +3 -2
- package/dist/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -0
- package/{lib → dist}/model/markdown-generation-util/field-declaration-util.d.ts +1 -1
- package/{lib → dist}/model/markdown-generation-util/field-declaration-util.js +2 -1
- package/dist/model/markdown-generation-util/field-declaration-util.js.map +1 -0
- package/{lib → dist}/model/markdown-generation-util/method-declaration-util.d.ts +1 -1
- package/{lib → dist}/model/markdown-generation-util/method-declaration-util.js +2 -1
- package/dist/model/markdown-generation-util/method-declaration-util.js.map +1 -0
- package/{lib → dist}/model/markdown-generation-util/type-declaration-util.js +2 -1
- package/dist/model/markdown-generation-util/type-declaration-util.js.map +1 -0
- package/{lib → dist}/model/markdown-type-file.d.ts +1 -1
- package/dist/model/markdown-type-file.js.map +1 -0
- package/{lib → dist}/service/apex-file-reader.d.ts +1 -1
- package/{lib → dist}/service/apex-file-reader.js +1 -1
- package/{lib → dist}/service/apex-file-reader.js.map +1 -1
- package/{lib → dist}/service/manifest-factory.d.ts +2 -2
- package/{lib → dist}/service/manifest-factory.js +3 -2
- package/dist/service/manifest-factory.js.map +1 -0
- package/{lib → dist}/service/parser.d.ts +1 -1
- package/{lib → dist}/settings.d.ts +3 -0
- package/{lib → dist}/settings.js +3 -0
- package/{lib → dist}/settings.js.map +1 -1
- package/{lib → dist}/test-helpers/SettingsBuilder.js +1 -0
- package/{lib → dist}/test-helpers/SettingsBuilder.js.map +1 -1
- package/{lib → dist}/transpiler/factory.js +2 -4
- package/dist/transpiler/factory.js.map +1 -0
- package/{lib → dist}/transpiler/markdown/class-file-generatorHelper.d.ts +0 -2
- package/{lib → dist}/transpiler/markdown/class-file-generatorHelper.js +1 -15
- package/dist/transpiler/markdown/class-file-generatorHelper.js.map +1 -0
- package/{lib → dist}/transpiler/markdown/plain-markdown/constructors-partial-template.js +1 -1
- package/{lib → dist}/transpiler/markdown/plain-markdown/documentable-partial-template.js +6 -4
- package/{lib → dist}/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +1 -1
- package/{lib → dist}/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +1 -1
- package/{lib → dist}/transpiler/markdown/plain-markdown/methods-partial-template.js +2 -2
- package/{lib → dist}/util/string-utils.js +2 -2
- package/{lib → dist}/util/string-utils.js.map +1 -1
- package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +18 -0
- package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +6 -2
- package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +3 -1
- package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +1 -1
- package/examples/plain-markdown/docs/index.md +2 -0
- package/examples/plain-markdown/force-app/classes/SampleException.cls +16 -0
- package/jest.config.js +1 -1
- package/package.json +11 -13
- package/src/__spec__/core/generating-class-docs.spec.ts +57 -37
- package/src/__spec__/core/generating-enum-docs.spec.ts +25 -22
- package/src/__spec__/core/generating-interface-docs.spec.ts +33 -30
- package/src/__spec__/core/generating-reference-guide.spec.ts +8 -7
- package/src/__spec__/core/test-helpers.ts +9 -0
- package/src/application/Apexdocs.ts +36 -5
- package/src/application/{flows → generators}/generate-markdown-files.ts +19 -13
- package/src/cli/args.ts +136 -0
- package/src/cli/generate.ts +11 -135
- package/src/{adapters → core/adapters}/__tests__/interface-adapter.spec.ts +13 -11
- package/src/{adapters → core/adapters}/__tests__/references.spec.ts +11 -1
- package/src/{adapters → core/adapters}/apex-types.ts +18 -15
- package/src/core/adapters/documentables.ts +195 -0
- package/src/{adapters → core/adapters}/fields-and-properties.ts +11 -9
- package/src/{adapters → core/adapters}/methods-and-constructors.ts +15 -8
- package/src/{adapters → core/adapters}/references.ts +3 -6
- package/src/core/adapters/type-utils.ts +9 -0
- package/src/core/{renderable → adapters}/types.d.ts +35 -4
- package/src/core/generate-docs.ts +55 -19
- package/src/core/template.ts +12 -9
- package/src/core/templates/reference-guide.ts +1 -1
- package/src/model/__tests__/manifest.spec.ts +1 -1
- package/src/model/markdown-generation-util/field-declaration-util.ts +1 -1
- package/src/model/markdown-generation-util/method-declaration-util.ts +1 -1
- package/src/model/markdown-type-file.ts +5 -1
- package/src/service/__tests__/apex-file-reader.spec.ts +1 -0
- package/src/service/apex-file-reader.ts +1 -1
- package/src/service/manifest-factory.ts +2 -2
- package/src/service/parser.ts +1 -1
- package/src/settings.ts +6 -0
- package/src/test-helpers/SettingsBuilder.ts +1 -0
- package/src/transpiler/factory.ts +2 -4
- package/src/transpiler/markdown/class-file-generatorHelper.ts +1 -18
- package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +1 -1
- package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +6 -4
- package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +1 -1
- package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +2 -2
- package/tsconfig.json +1 -1
- package/docs/.nojekyll +0 -0
- package/docs/__old/README.md +0 -1
- package/docs/__old/index.html +0 -22
- package/docs/__old/restapi.json +0 -589
- package/docs/__old/types/Classes/nspc.AnotherInterface.md +0 -22
- package/docs/__old/types/Classes/nspc.ChildClass.md +0 -97
- package/docs/__old/types/Main/nspc.GroupedClass.md +0 -10
- package/docs/__old/types/Main/nspc.SampleClass.md +0 -189
- package/docs/__old/types/Misc-Group/nspc.EscapedAnnotations.md +0 -4
- package/docs/__old/types/Misc-Group/nspc.GrandparentClass.md +0 -13
- package/docs/__old/types/Misc-Group/nspc.InterfaceWithInheritance.md +0 -29
- package/docs/__old/types/Misc-Group/nspc.MemberGrouping.md +0 -13
- package/docs/__old/types/Misc-Group/nspc.ParentClass.md +0 -37
- package/docs/__old/types/Misc-Group/nspc.Reference1.md +0 -18
- package/docs/__old/types/Misc-Group/nspc.Reference2.md +0 -12
- package/docs/__old/types/Misc-Group/nspc.Reference3.md +0 -7
- package/docs/__old/types/Misc-Group/nspc.Reference4.md +0 -7
- package/docs/__old/types/Misc-Group/nspc.Reference5.md +0 -7
- package/docs/__old/types/Misc-Group/nspc.Reference6.md +0 -9
- package/docs/__old/types/Misc-Group/nspc.Reference7.md +0 -7
- package/docs/__old/types/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -11
- package/docs/__old/types/Misc-Group/nspc.SampleRestResource.md +0 -104
- package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -33
- package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -14
- package/docs/__old/types/README.md +0 -97
- package/docs/__old/types/Sample-Interfaces/nspc.SampleInterface.md +0 -23
- package/examples/includes/header.md +0 -3
- package/lib/__spec__/core/expect-extensions.js.map +0 -1
- package/lib/__spec__/core/generating-class-docs.spec.js.map +0 -1
- package/lib/__spec__/core/generating-enum-docs.spec.js.map +0 -1
- package/lib/__spec__/core/generating-interface-docs.spec.js.map +0 -1
- package/lib/__spec__/core/generating-reference-guide.spec.js.map +0 -1
- package/lib/adapters/apex-types.d.ts +0 -5
- package/lib/adapters/apex-types.js.map +0 -1
- package/lib/adapters/documentables.js +0 -56
- package/lib/adapters/documentables.js.map +0 -1
- package/lib/adapters/fields-and-properties.js.map +0 -1
- package/lib/adapters/methods-and-constructors.js.map +0 -1
- package/lib/adapters/references.js.map +0 -1
- package/lib/adapters/type-utils.d.ts +0 -2
- package/lib/adapters/type-utils.js +0 -7
- package/lib/adapters/type-utils.js.map +0 -1
- package/lib/application/Apexdocs.js.map +0 -1
- package/lib/application/flows/generate-markdown-files.js.map +0 -1
- package/lib/cli/generate.js.map +0 -1
- package/lib/core/generate-docs.js.map +0 -1
- package/lib/core/inheritance-chain.js.map +0 -1
- package/lib/index.d.ts +0 -2
- package/lib/index.js +0 -29
- package/lib/model/apex-bundle.js.map +0 -1
- package/lib/model/inheritance.d.ts +0 -11
- package/lib/model/inheritance.js +0 -3
- package/lib/model/inheritance.js.map +0 -1
- package/lib/model/manifest.js.map +0 -1
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +0 -1
- package/lib/model/markdown-generation-util/field-declaration-util.js.map +0 -1
- package/lib/model/markdown-generation-util/method-declaration-util.js.map +0 -1
- package/lib/model/markdown-generation-util/type-declaration-util.js.map +0 -1
- package/lib/model/markdown-type-file.js.map +0 -1
- package/lib/service/manifest-factory.js.map +0 -1
- package/lib/transpiler/factory.js.map +0 -1
- package/lib/transpiler/markdown/class-file-generatorHelper.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +0 -9
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +0 -42
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +0 -1
- package/src/adapters/documentables.ts +0 -93
- package/src/adapters/type-utils.ts +0 -5
- package/src/adapters/types.d.ts +0 -8
- package/src/model/inheritance.ts +0 -8
- package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +0 -42
- /package/{lib → dist}/__spec__/core/expect-extensions.d.ts +0 -0
- /package/{lib → dist}/__spec__/core/generating-class-docs.spec.d.ts +0 -0
- /package/{lib → dist}/__spec__/core/generating-enum-docs.spec.d.ts +0 -0
- /package/{lib → dist}/__spec__/core/generating-interface-docs.spec.d.ts +0 -0
- /package/{lib → dist}/__spec__/core/generating-reference-guide.spec.d.ts +0 -0
- /package/{lib → dist}/cli/generate.d.ts +0 -0
- /package/{lib → dist}/core/__test__/inheritance-chain.test.d.ts +0 -0
- /package/{lib → dist}/core/__test__/inheritance-chain.test.js +0 -0
- /package/{lib → dist}/core/__test__/inheritance-chain.test.js.map +0 -0
- /package/{lib/model → dist/core}/apex-bundle.d.ts +0 -0
- /package/{lib/model → dist/core}/apex-bundle.js +0 -0
- /package/{lib → dist}/core/inheritance-chain.d.ts +0 -0
- /package/{lib/model → dist/core}/manifest.d.ts +0 -0
- /package/{lib/model → dist/core}/manifest.js +0 -0
- /package/{lib → dist}/core/template.d.ts +0 -0
- /package/{lib → dist}/core/templates/reference-guide.d.ts +0 -0
- /package/{lib → dist}/core/templates/reference-guide.js.map +0 -0
- /package/{lib → dist}/index.js.map +0 -0
- /package/{lib → dist}/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +0 -0
- /package/{lib → dist}/model/apex-type-wrappers/ClassMirrorWrapper.js +0 -0
- /package/{lib → dist}/model/apex-type-wrappers/ClassMirrorWrapper.js.map +0 -0
- /package/{lib → dist}/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +0 -0
- /package/{lib → dist}/model/apex-type-wrappers/MethodMirrorWrapper.js +0 -0
- /package/{lib → dist}/model/apex-type-wrappers/MethodMirrorWrapper.js.map +0 -0
- /package/{lib → dist}/model/markdown-file.d.ts +0 -0
- /package/{lib → dist}/model/markdown-file.js +0 -0
- /package/{lib → dist}/model/markdown-file.js.map +0 -0
- /package/{lib → dist}/model/markdown-generation-util/doc-comment-annotation-util.d.ts +0 -0
- /package/{lib → dist}/model/markdown-generation-util/index.d.ts +0 -0
- /package/{lib → dist}/model/markdown-generation-util/index.js +0 -0
- /package/{lib → dist}/model/markdown-generation-util/index.js.map +0 -0
- /package/{lib → dist}/model/markdown-generation-util/type-declaration-util.d.ts +0 -0
- /package/{lib → dist}/model/markdown-home-file.d.ts +0 -0
- /package/{lib → dist}/model/markdown-home-file.js +0 -0
- /package/{lib → dist}/model/markdown-home-file.js.map +0 -0
- /package/{lib → dist}/model/markdown-type-file.js +0 -0
- /package/{lib → dist}/model/openapi/apex-doc-types.d.ts +0 -0
- /package/{lib → dist}/model/openapi/apex-doc-types.js +0 -0
- /package/{lib → dist}/model/openapi/apex-doc-types.js.map +0 -0
- /package/{lib → dist}/model/openapi/open-api-types.d.ts +0 -0
- /package/{lib → dist}/model/openapi/open-api-types.js +0 -0
- /package/{lib → dist}/model/openapi/open-api-types.js.map +0 -0
- /package/{lib → dist}/model/openapi/open-api.d.ts +0 -0
- /package/{lib → dist}/model/openapi/open-api.js +0 -0
- /package/{lib → dist}/model/openapi/open-api.js.map +0 -0
- /package/{lib → dist}/model/openapi/openapi-type-file.d.ts +0 -0
- /package/{lib → dist}/model/openapi/openapi-type-file.js +0 -0
- /package/{lib → dist}/model/openapi/openapi-type-file.js.map +0 -0
- /package/{lib → dist}/model/outputFile.d.ts +0 -0
- /package/{lib → dist}/model/outputFile.js +0 -0
- /package/{lib → dist}/model/outputFile.js.map +0 -0
- /package/{lib → dist}/model/types-repository.d.ts +0 -0
- /package/{lib → dist}/model/types-repository.js +0 -0
- /package/{lib → dist}/model/types-repository.js.map +0 -0
- /package/{lib → dist}/service/file-system.d.ts +0 -0
- /package/{lib → dist}/service/file-system.js +0 -0
- /package/{lib → dist}/service/file-system.js.map +0 -0
- /package/{lib → dist}/service/file-writer.d.ts +0 -0
- /package/{lib → dist}/service/file-writer.js +0 -0
- /package/{lib → dist}/service/file-writer.js.map +0 -0
- /package/{lib → dist}/service/metadata-processor.d.ts +0 -0
- /package/{lib → dist}/service/metadata-processor.js +0 -0
- /package/{lib → dist}/service/metadata-processor.js.map +0 -0
- /package/{lib → dist}/service/parser.js +0 -0
- /package/{lib → dist}/service/parser.js.map +0 -0
- /package/{lib → dist}/service/state.d.ts +0 -0
- /package/{lib → dist}/service/state.js +0 -0
- /package/{lib → dist}/service/state.js.map +0 -0
- /package/{lib → dist}/service/walkers/class-walker.d.ts +0 -0
- /package/{lib → dist}/service/walkers/class-walker.js +0 -0
- /package/{lib → dist}/service/walkers/class-walker.js.map +0 -0
- /package/{lib → dist}/service/walkers/enum-walker.d.ts +0 -0
- /package/{lib → dist}/service/walkers/enum-walker.js +0 -0
- /package/{lib → dist}/service/walkers/enum-walker.js.map +0 -0
- /package/{lib → dist}/service/walkers/interface-walker.d.ts +0 -0
- /package/{lib → dist}/service/walkers/interface-walker.js +0 -0
- /package/{lib → dist}/service/walkers/interface-walker.js.map +0 -0
- /package/{lib → dist}/service/walkers/walker-factory.d.ts +0 -0
- /package/{lib → dist}/service/walkers/walker-factory.js +0 -0
- /package/{lib → dist}/service/walkers/walker-factory.js.map +0 -0
- /package/{lib → dist}/service/walkers/walker.d.ts +0 -0
- /package/{lib → dist}/service/walkers/walker.js +0 -0
- /package/{lib → dist}/service/walkers/walker.js.map +0 -0
- /package/{lib → dist}/test-helpers/AnnotationBuilder.d.ts +0 -0
- /package/{lib → dist}/test-helpers/AnnotationBuilder.js +0 -0
- /package/{lib → dist}/test-helpers/AnnotationBuilder.js.map +0 -0
- /package/{lib → dist}/test-helpers/ClassMirrorBuilder.d.ts +0 -0
- /package/{lib → dist}/test-helpers/ClassMirrorBuilder.js +0 -0
- /package/{lib → dist}/test-helpers/ClassMirrorBuilder.js.map +0 -0
- /package/{lib → dist}/test-helpers/DocCommentAnnotationBuilder.d.ts +0 -0
- /package/{lib → dist}/test-helpers/DocCommentAnnotationBuilder.js +0 -0
- /package/{lib → dist}/test-helpers/DocCommentAnnotationBuilder.js.map +0 -0
- /package/{lib → dist}/test-helpers/DocCommentBuilder.d.ts +0 -0
- /package/{lib → dist}/test-helpers/DocCommentBuilder.js +0 -0
- /package/{lib → dist}/test-helpers/DocCommentBuilder.js.map +0 -0
- /package/{lib → dist}/test-helpers/FieldMirrorBuilder.d.ts +0 -0
- /package/{lib → dist}/test-helpers/FieldMirrorBuilder.js +0 -0
- /package/{lib → dist}/test-helpers/FieldMirrorBuilder.js.map +0 -0
- /package/{lib → dist}/test-helpers/InterfaceMirrorBuilder.d.ts +0 -0
- /package/{lib → dist}/test-helpers/InterfaceMirrorBuilder.js +0 -0
- /package/{lib → dist}/test-helpers/InterfaceMirrorBuilder.js.map +0 -0
- /package/{lib → dist}/test-helpers/MethodMirrorBuilder.d.ts +0 -0
- /package/{lib → dist}/test-helpers/MethodMirrorBuilder.js +0 -0
- /package/{lib → dist}/test-helpers/MethodMirrorBuilder.js.map +0 -0
- /package/{lib → dist}/test-helpers/SettingsBuilder.d.ts +0 -0
- /package/{lib → dist}/transpiler/factory.d.ts +0 -0
- /package/{lib → dist}/transpiler/file-container.d.ts +0 -0
- /package/{lib → dist}/transpiler/file-container.js +0 -0
- /package/{lib → dist}/transpiler/file-container.js.map +0 -0
- /package/{lib → dist}/transpiler/generator-choices.d.ts +0 -0
- /package/{lib → dist}/transpiler/generator-choices.js +0 -0
- /package/{lib → dist}/transpiler/generator-choices.js.map +0 -0
- /package/{lib → dist}/transpiler/markdown/docsify/docsify-docs-processor.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/docsify/docsify-docs-processor.js +0 -0
- /package/{lib → dist}/transpiler/markdown/docsify/docsify-docs-processor.js.map +0 -0
- /package/{lib → dist}/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/jekyll/jekyll-docsProcessor.js +0 -0
- /package/{lib → dist}/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +0 -0
- /package/{lib → dist}/transpiler/markdown/markdown-transpiler-base.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/markdown-transpiler-base.js +0 -0
- /package/{lib → dist}/transpiler/markdown/markdown-transpiler-base.js.map +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/class-template.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/class-template.js +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/class-template.js.map +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/enum-template.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/enum-template.js +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/enum-template.js.map +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/interface-template.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/interface-template.js +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/interface-template.js.map +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/methods-partial-template.js.map +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/type-doc-partial.js +0 -0
- /package/{lib → dist}/transpiler/markdown/plain-markdown/type-doc-partial.js.map +0 -0
- /package/{lib → dist}/transpiler/openapi/open-api-docs-processor.d.ts +0 -0
- /package/{lib → dist}/transpiler/openapi/open-api-docs-processor.js +0 -0
- /package/{lib → dist}/transpiler/openapi/open-api-docs-processor.js.map +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/Builder.d.ts +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/Builder.js +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/Builder.js.map +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/MethodParser.d.ts +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/MethodParser.js +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/MethodParser.js.map +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/ParameterObjectBuilder.js +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/ReferenceBuilder.d.ts +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/ReferenceBuilder.js +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/ResponsesBuilder.js +0 -0
- /package/{lib → dist}/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -0
- /package/{lib → dist}/transpiler/processor-type-transpiler.d.ts +0 -0
- /package/{lib → dist}/transpiler/processor-type-transpiler.js +0 -0
- /package/{lib → dist}/transpiler/processor-type-transpiler.js.map +0 -0
- /package/{lib → dist}/transpiler/transpiler.d.ts +0 -0
- /package/{lib → dist}/transpiler/transpiler.js +0 -0
- /package/{lib → dist}/transpiler/transpiler.js.map +0 -0
- /package/{lib → dist}/util/error-logger.d.ts +0 -0
- /package/{lib → dist}/util/error-logger.js +0 -0
- /package/{lib → dist}/util/error-logger.js.map +0 -0
- /package/{lib → dist}/util/logger.d.ts +0 -0
- /package/{lib → dist}/util/logger.js +0 -0
- /package/{lib → dist}/util/logger.js.map +0 -0
- /package/{lib → dist}/util/string-utils.d.ts +0 -0
- /package/src/{model → core}/apex-bundle.ts +0 -0
- /package/src/{model → core}/manifest.ts +0 -0
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
const generate_docs_1 = require("../../core/generate-docs");
|
|
4
4
|
const expect_extensions_1 = require("./expect-extensions");
|
|
5
|
+
const test_helpers_1 = require("./test-helpers");
|
|
5
6
|
describe('Generates enum documentation', () => {
|
|
6
7
|
beforeAll(() => {
|
|
7
8
|
(0, expect_extensions_1.extendExpect)();
|
|
@@ -14,7 +15,7 @@ describe('Generates enum documentation', () => {
|
|
|
14
15
|
VALUE2
|
|
15
16
|
}
|
|
16
17
|
`;
|
|
17
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
18
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
18
19
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.format).toBe('markdown'));
|
|
19
20
|
});
|
|
20
21
|
it('returns the name of the enum', () => {
|
|
@@ -24,7 +25,7 @@ describe('Generates enum documentation', () => {
|
|
|
24
25
|
VALUE2
|
|
25
26
|
}
|
|
26
27
|
`;
|
|
27
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
28
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
28
29
|
expect(result).documentationBundleHasLength(1);
|
|
29
30
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.docs[0].typeName).toBe('MyEnum'));
|
|
30
31
|
});
|
|
@@ -35,7 +36,7 @@ describe('Generates enum documentation', () => {
|
|
|
35
36
|
VALUE2
|
|
36
37
|
}
|
|
37
38
|
`;
|
|
38
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
39
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
39
40
|
expect(result).documentationBundleHasLength(1);
|
|
40
41
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.docs[0].type).toBe('enum'));
|
|
41
42
|
});
|
|
@@ -52,7 +53,9 @@ describe('Generates enum documentation', () => {
|
|
|
52
53
|
VALUE2
|
|
53
54
|
}
|
|
54
55
|
`;
|
|
55
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2], {
|
|
56
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)], {
|
|
57
|
+
scope: ['global'],
|
|
58
|
+
});
|
|
56
59
|
expect(result).documentationBundleHasLength(1);
|
|
57
60
|
});
|
|
58
61
|
it('does not return enums that have an @ignore in the docs', () => {
|
|
@@ -65,7 +68,7 @@ describe('Generates enum documentation', () => {
|
|
|
65
68
|
VALUE2
|
|
66
69
|
}
|
|
67
70
|
`;
|
|
68
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
71
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
69
72
|
expect(result).documentationBundleHasLength(0);
|
|
70
73
|
});
|
|
71
74
|
});
|
|
@@ -78,7 +81,7 @@ describe('Generates enum documentation', () => {
|
|
|
78
81
|
}
|
|
79
82
|
`;
|
|
80
83
|
const output = `# MyEnum Enum`;
|
|
81
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
84
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
82
85
|
expect(result).documentationBundleHasLength(1);
|
|
83
86
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains(output));
|
|
84
87
|
});
|
|
@@ -90,7 +93,7 @@ describe('Generates enum documentation', () => {
|
|
|
90
93
|
VALUE2
|
|
91
94
|
}
|
|
92
95
|
`;
|
|
93
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
96
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
94
97
|
expect(result).documentationBundleHasLength(1);
|
|
95
98
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('NAMESPACEACCESSIBLE'));
|
|
96
99
|
});
|
|
@@ -104,7 +107,7 @@ describe('Generates enum documentation', () => {
|
|
|
104
107
|
VALUE2
|
|
105
108
|
}
|
|
106
109
|
`;
|
|
107
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
110
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
108
111
|
expect(result).documentationBundleHasLength(1);
|
|
109
112
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description'));
|
|
110
113
|
});
|
|
@@ -118,7 +121,7 @@ describe('Generates enum documentation', () => {
|
|
|
118
121
|
VALUE2
|
|
119
122
|
}
|
|
120
123
|
`;
|
|
121
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
124
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
122
125
|
expect(result).documentationBundleHasLength(1);
|
|
123
126
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Custom Tag'));
|
|
124
127
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('My Value'));
|
|
@@ -133,7 +136,7 @@ describe('Generates enum documentation', () => {
|
|
|
133
136
|
VALUE2
|
|
134
137
|
}
|
|
135
138
|
`;
|
|
136
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
139
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
137
140
|
expect(result).documentationBundleHasLength(1);
|
|
138
141
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Group'));
|
|
139
142
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('MyGroup'));
|
|
@@ -148,7 +151,7 @@ describe('Generates enum documentation', () => {
|
|
|
148
151
|
VALUE2
|
|
149
152
|
}
|
|
150
153
|
`;
|
|
151
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
154
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
152
155
|
expect(result).documentationBundleHasLength(1);
|
|
153
156
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Author'));
|
|
154
157
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('John Doe'));
|
|
@@ -163,7 +166,7 @@ describe('Generates enum documentation', () => {
|
|
|
163
166
|
VALUE2
|
|
164
167
|
}
|
|
165
168
|
`;
|
|
166
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
169
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
167
170
|
expect(result).documentationBundleHasLength(1);
|
|
168
171
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Date'));
|
|
169
172
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('2021-01-01'));
|
|
@@ -175,7 +178,7 @@ describe('Generates enum documentation', () => {
|
|
|
175
178
|
*/
|
|
176
179
|
public enum MyEnum {}
|
|
177
180
|
`;
|
|
178
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
181
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
179
182
|
expect(result).documentationBundleHasLength(1);
|
|
180
183
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description'));
|
|
181
184
|
});
|
|
@@ -187,7 +190,7 @@ describe('Generates enum documentation', () => {
|
|
|
187
190
|
public enum MyEnum {}
|
|
188
191
|
`;
|
|
189
192
|
const input2 = 'public enum EnumRef {}';
|
|
190
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2]);
|
|
193
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)]);
|
|
191
194
|
expect(result).documentationBundleHasLength(2);
|
|
192
195
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Description'));
|
|
193
196
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description with a [EnumRef](./EnumRef.md) reference'));
|
|
@@ -199,7 +202,7 @@ describe('Generates enum documentation', () => {
|
|
|
199
202
|
*/
|
|
200
203
|
public enum MyEnum {}
|
|
201
204
|
`;
|
|
202
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
205
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
203
206
|
expect(result).documentationBundleHasLength(1);
|
|
204
207
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description with an [test@testerson.com](mailto:test@testerson.com) email'));
|
|
205
208
|
});
|
|
@@ -211,7 +214,7 @@ describe('Generates enum documentation', () => {
|
|
|
211
214
|
public enum MyEnum {}
|
|
212
215
|
`;
|
|
213
216
|
const input2 = 'public enum EnumRef {}';
|
|
214
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2]);
|
|
217
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)]);
|
|
215
218
|
expect(result).documentationBundleHasLength(2);
|
|
216
219
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('See'));
|
|
217
220
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('[EnumRef](./EnumRef.md)'));
|
|
@@ -223,7 +226,7 @@ describe('Generates enum documentation', () => {
|
|
|
223
226
|
*/
|
|
224
227
|
public enum MyEnum {}
|
|
225
228
|
`;
|
|
226
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
229
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
227
230
|
expect(result).documentationBundleHasLength(1);
|
|
228
231
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('See'));
|
|
229
232
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('EnumRef'));
|
|
@@ -232,7 +235,7 @@ describe('Generates enum documentation', () => {
|
|
|
232
235
|
const input = `
|
|
233
236
|
public enum MyEnum {}
|
|
234
237
|
`;
|
|
235
|
-
const result = (0, generate_docs_1.generateDocs)([input], { namespace: 'MyNamespace' });
|
|
238
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)], { namespace: 'MyNamespace' });
|
|
236
239
|
expect(result).documentationBundleHasLength(1);
|
|
237
240
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('## Namespace'));
|
|
238
241
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('MyNamespace'));
|
|
@@ -241,7 +244,7 @@ describe('Generates enum documentation', () => {
|
|
|
241
244
|
const input = `
|
|
242
245
|
public enum MyEnum {}
|
|
243
246
|
`;
|
|
244
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
247
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
245
248
|
expect(result).documentationBundleHasLength(1);
|
|
246
249
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContainsNot('## Namespace'));
|
|
247
250
|
});
|
|
@@ -260,7 +263,7 @@ describe('Generates enum documentation', () => {
|
|
|
260
263
|
VALUE2
|
|
261
264
|
}
|
|
262
265
|
`;
|
|
263
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
266
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
264
267
|
expect(result).documentationBundleHasLength(1);
|
|
265
268
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('```mermaid'));
|
|
266
269
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('graph TD'));
|
|
@@ -280,7 +283,7 @@ describe('Generates enum documentation', () => {
|
|
|
280
283
|
VALUE2
|
|
281
284
|
}
|
|
282
285
|
`;
|
|
283
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
286
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
284
287
|
expect(result).documentationBundleHasLength(1);
|
|
285
288
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('```apex'));
|
|
286
289
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('public class MyClass'));
|
|
@@ -292,7 +295,7 @@ describe('Generates enum documentation', () => {
|
|
|
292
295
|
VALUE2
|
|
293
296
|
}
|
|
294
297
|
`;
|
|
295
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
298
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
296
299
|
expect(result).documentationBundleHasLength(1);
|
|
297
300
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('## Values'));
|
|
298
301
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('VALUE1'));
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generating-enum-docs.spec.js","sourceRoot":"","sources":["../../../src/__spec__/core/generating-enum-docs.spec.ts"],"names":[],"mappings":";;AAAA,4DAAwD;AACxD,2DAAiE;AACjE,iDAAyD;AAEzD,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,SAAS,CAAC,GAAG,EAAE;QACb,IAAA,gCAAY,GAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,KAAK,GAAG;;;;;KAKf,CAAC;YAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,MAAM,KAAK,GAAG;;;;;KAKf,CAAC;YAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAClC,MAAM,KAAK,GAAG;;;;;KAKf,CAAC;YAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,MAAM,MAAM,GAAG;;;;;KAKhB,CAAC;YAEA,MAAM,MAAM,GAAG;;;;;OAKd,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,EAAE;gBAC9F,KAAK,EAAE,CAAC,QAAQ,CAAC;aAClB,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;YAChE,MAAM,KAAK,GAAG;;;;;;;;OAQb,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,KAAK,GAAG;;;;;KAKf,CAAC;YAEA,MAAM,MAAM,GAAG,eAAe,CAAC;YAE/B,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;YACzC,MAAM,KAAK,GAAG;;;;;;QAMZ,CAAC;YAEH,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAClC,MAAM,KAAK,GAAG;;;;;;;;KAQf,CAAC;YAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,MAAM,KAAK,GAAG;;;;;;;;KAQf,CAAC;YAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC5E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAC5B,MAAM,KAAK,GAAG;;;;;;;;KAQf,CAAC;YAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;YACvE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;YAC7B,MAAM,KAAK,GAAG;;;;;;;;KAQf,CAAC;YAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;YACxE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;YAC3B,MAAM,KAAK,GAAG;;;;;;;;KAQf,CAAC;YAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YACtE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;YAC/B,MAAM,KAAK,GAAG;;;;;OAKb,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,MAAM,MAAM,GAAG;;;;;OAKd,CAAC;YAEF,MAAM,MAAM,GAAG,wBAAwB,CAAC;YAExC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAChG,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC;YAC7E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAC5B,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,gEAAgE,CAAC,CAChG,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,MAAM,KAAK,GAAG;;;;;OAKb,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAC5B,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAC3B,qFAAqF,CACtF,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,MAAM,GAAG;;;;;OAKd,CAAC;YAEF,MAAM,MAAM,GAAG,wBAAwB,CAAC;YAExC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAChG,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;YACrE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,KAAK,GAAG;;;;;OAKb,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;YACrE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,KAAK,GAAG;;OAEb,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;YAC5F,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC;YAC9E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,KAAK,GAAG;;OAEb,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,KAAK,GAAG;;;;;;;;;;;;;OAab,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC5E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,KAAK,GAAG;;;;;;;;;;;;;OAab,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;YACzE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;YACzB,MAAM,KAAK,GAAG;;;;;OAKb,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAAC;YAC3E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;YACxE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
const expect_extensions_1 = require("./expect-extensions");
|
|
4
4
|
const generate_docs_1 = require("../../core/generate-docs");
|
|
5
|
+
const test_helpers_1 = require("./test-helpers");
|
|
5
6
|
describe('Generates interface documentation', () => {
|
|
6
7
|
beforeAll(() => {
|
|
7
8
|
(0, expect_extensions_1.extendExpect)();
|
|
@@ -12,7 +13,7 @@ describe('Generates interface documentation', () => {
|
|
|
12
13
|
public interface MyInterface {
|
|
13
14
|
}
|
|
14
15
|
`;
|
|
15
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
16
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
16
17
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.format).toBe('markdown'));
|
|
17
18
|
});
|
|
18
19
|
it('returns the name of the interface', () => {
|
|
@@ -20,7 +21,7 @@ describe('Generates interface documentation', () => {
|
|
|
20
21
|
public interface MyInterface {
|
|
21
22
|
}
|
|
22
23
|
`;
|
|
23
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
24
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
24
25
|
expect(result).documentationBundleHasLength(1);
|
|
25
26
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.docs[0].typeName).toBe('MyInterface'));
|
|
26
27
|
});
|
|
@@ -29,7 +30,7 @@ describe('Generates interface documentation', () => {
|
|
|
29
30
|
public interface MyInterface {
|
|
30
31
|
}
|
|
31
32
|
`;
|
|
32
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
33
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
33
34
|
expect(result).documentationBundleHasLength(1);
|
|
34
35
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.docs[0].type).toBe('interface'));
|
|
35
36
|
});
|
|
@@ -40,7 +41,9 @@ describe('Generates interface documentation', () => {
|
|
|
40
41
|
const input2 = `
|
|
41
42
|
public interface AnotherInterface {}
|
|
42
43
|
`;
|
|
43
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2], {
|
|
44
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)], {
|
|
45
|
+
scope: ['global'],
|
|
46
|
+
});
|
|
44
47
|
expect(result).documentationBundleHasLength(1);
|
|
45
48
|
});
|
|
46
49
|
it('does not return interfaces that have an @ignore in the docs', () => {
|
|
@@ -49,7 +52,7 @@ describe('Generates interface documentation', () => {
|
|
|
49
52
|
* @ignore
|
|
50
53
|
*/
|
|
51
54
|
public interface MyInterface {}`;
|
|
52
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
55
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
53
56
|
expect(result).documentationBundleHasLength(0);
|
|
54
57
|
});
|
|
55
58
|
it('does not return interface methods that have @ignore in the docs', () => {
|
|
@@ -60,7 +63,7 @@ describe('Generates interface documentation', () => {
|
|
|
60
63
|
*/
|
|
61
64
|
void myMethod();
|
|
62
65
|
}`;
|
|
63
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
66
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
64
67
|
expect(result).documentationBundleHasLength(1);
|
|
65
68
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.docs[0].docContents).not.toContain('myMethod'));
|
|
66
69
|
});
|
|
@@ -72,7 +75,7 @@ describe('Generates interface documentation', () => {
|
|
|
72
75
|
public interface MyInterface {}
|
|
73
76
|
`;
|
|
74
77
|
const output = `# MyInterface Interface`;
|
|
75
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
78
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
76
79
|
expect(result).documentationBundleHasLength(1);
|
|
77
80
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains(output));
|
|
78
81
|
});
|
|
@@ -84,7 +87,7 @@ describe('Generates interface documentation', () => {
|
|
|
84
87
|
void myMethod();
|
|
85
88
|
}
|
|
86
89
|
`;
|
|
87
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
90
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
88
91
|
expect(result).documentationBundleHasLength(1);
|
|
89
92
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('NAMESPACEACCESSIBLE'));
|
|
90
93
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('DEPRECATED'));
|
|
@@ -96,7 +99,7 @@ describe('Generates interface documentation', () => {
|
|
|
96
99
|
*/
|
|
97
100
|
public interface MyInterface {}
|
|
98
101
|
`;
|
|
99
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
102
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
100
103
|
expect(result).documentationBundleHasLength(1);
|
|
101
104
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description'));
|
|
102
105
|
});
|
|
@@ -107,7 +110,7 @@ describe('Generates interface documentation', () => {
|
|
|
107
110
|
*/
|
|
108
111
|
public interface MyInterface {}
|
|
109
112
|
`;
|
|
110
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
113
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
111
114
|
expect(result).documentationBundleHasLength(1);
|
|
112
115
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Custom Tag'));
|
|
113
116
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('My Value'));
|
|
@@ -118,7 +121,7 @@ describe('Generates interface documentation', () => {
|
|
|
118
121
|
* @group MyGroup
|
|
119
122
|
*/
|
|
120
123
|
public interface MyInterface {}`;
|
|
121
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
124
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
122
125
|
expect(result).documentationBundleHasLength(1);
|
|
123
126
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Group'));
|
|
124
127
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('MyGroup'));
|
|
@@ -129,7 +132,7 @@ describe('Generates interface documentation', () => {
|
|
|
129
132
|
* @author John Doe
|
|
130
133
|
*/
|
|
131
134
|
public interface MyInterface {}`;
|
|
132
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
135
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
133
136
|
expect(result).documentationBundleHasLength(1);
|
|
134
137
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Author'));
|
|
135
138
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('John Doe'));
|
|
@@ -140,7 +143,7 @@ describe('Generates interface documentation', () => {
|
|
|
140
143
|
* @date 2021-01-01
|
|
141
144
|
*/
|
|
142
145
|
public interface MyInterface {}`;
|
|
143
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
146
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
144
147
|
expect(result).documentationBundleHasLength(1);
|
|
145
148
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Date'));
|
|
146
149
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('2021-01-01'));
|
|
@@ -151,7 +154,7 @@ describe('Generates interface documentation', () => {
|
|
|
151
154
|
* @description This is a description
|
|
152
155
|
*/
|
|
153
156
|
public interface MyInterface {}`;
|
|
154
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
157
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
155
158
|
expect(result).documentationBundleHasLength(1);
|
|
156
159
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description'));
|
|
157
160
|
});
|
|
@@ -163,7 +166,7 @@ describe('Generates interface documentation', () => {
|
|
|
163
166
|
public enum MyInterface {}
|
|
164
167
|
`;
|
|
165
168
|
const input2 = 'public interface InterfaceRef {}';
|
|
166
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2]);
|
|
169
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)]);
|
|
167
170
|
expect(result).documentationBundleHasLength(2);
|
|
168
171
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description with a [InterfaceRef](./InterfaceRef.md) reference'));
|
|
169
172
|
});
|
|
@@ -174,7 +177,7 @@ describe('Generates interface documentation', () => {
|
|
|
174
177
|
*/
|
|
175
178
|
public interface MyInterface {}
|
|
176
179
|
`;
|
|
177
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
180
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
178
181
|
expect(result).documentationBundleHasLength(1);
|
|
179
182
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description with an [test@testerson.com](mailto:test@testerson.com) email'));
|
|
180
183
|
});
|
|
@@ -186,7 +189,7 @@ describe('Generates interface documentation', () => {
|
|
|
186
189
|
public interface MyInterface {}
|
|
187
190
|
`;
|
|
188
191
|
const input2 = 'public interface InterfaceRef {}';
|
|
189
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2]);
|
|
192
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)]);
|
|
190
193
|
expect(result).documentationBundleHasLength(2);
|
|
191
194
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('See'));
|
|
192
195
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('[InterfaceRef](./InterfaceRef.md)'));
|
|
@@ -198,21 +201,21 @@ describe('Generates interface documentation', () => {
|
|
|
198
201
|
*/
|
|
199
202
|
public interface MyInterface {}
|
|
200
203
|
`;
|
|
201
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
204
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
202
205
|
expect(result).documentationBundleHasLength(1);
|
|
203
206
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('See'));
|
|
204
207
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('InterfaceRef'));
|
|
205
208
|
});
|
|
206
209
|
it('displays the namespace if present in the config', () => {
|
|
207
210
|
const input = 'public interface MyInterface {}';
|
|
208
|
-
const result = (0, generate_docs_1.generateDocs)([input], { namespace: 'MyNamespace' });
|
|
211
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)], { namespace: 'MyNamespace' });
|
|
209
212
|
expect(result).documentationBundleHasLength(1);
|
|
210
213
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('## Namespace'));
|
|
211
214
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('MyNamespace'));
|
|
212
215
|
});
|
|
213
216
|
it('does not display the namespace if not present in the config', () => {
|
|
214
217
|
const input = 'public interface MyInterface {}';
|
|
215
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
218
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
216
219
|
expect(result).documentationBundleHasLength(1);
|
|
217
220
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContainsNot('## Namespace'));
|
|
218
221
|
});
|
|
@@ -228,7 +231,7 @@ describe('Generates interface documentation', () => {
|
|
|
228
231
|
*/
|
|
229
232
|
public interface MyInterface {}
|
|
230
233
|
`;
|
|
231
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
234
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
232
235
|
expect(result).documentationBundleHasLength(1);
|
|
233
236
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('```mermaid'));
|
|
234
237
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('graph TD'));
|
|
@@ -244,7 +247,7 @@ describe('Generates interface documentation', () => {
|
|
|
244
247
|
* }
|
|
245
248
|
*/
|
|
246
249
|
public interface MyInterface {}`;
|
|
247
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
250
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
248
251
|
expect(result).documentationBundleHasLength(1);
|
|
249
252
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('```apex'));
|
|
250
253
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('public class MyClass'));
|
|
@@ -257,7 +260,7 @@ describe('Generates interface documentation', () => {
|
|
|
257
260
|
void myMethod();
|
|
258
261
|
}
|
|
259
262
|
`;
|
|
260
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
263
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
261
264
|
expect(result).documentationBundleHasLength(1);
|
|
262
265
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('## Methods'));
|
|
263
266
|
});
|
|
@@ -275,7 +278,7 @@ describe('Generates interface documentation', () => {
|
|
|
275
278
|
void myMethod();
|
|
276
279
|
}
|
|
277
280
|
`;
|
|
278
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
281
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
279
282
|
expect(result).documentationBundleHasLength(1);
|
|
280
283
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('```mermaid'));
|
|
281
284
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('graph TD'));
|
|
@@ -294,7 +297,7 @@ describe('Generates interface documentation', () => {
|
|
|
294
297
|
void myMethod();
|
|
295
298
|
}
|
|
296
299
|
`;
|
|
297
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
300
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
298
301
|
expect(result).documentationBundleHasLength(1);
|
|
299
302
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('```apex'));
|
|
300
303
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('public class MyClass'));
|
|
@@ -305,7 +308,7 @@ describe('Generates interface documentation', () => {
|
|
|
305
308
|
void myMethod();
|
|
306
309
|
}
|
|
307
310
|
`;
|
|
308
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
311
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
309
312
|
expect(result).documentationBundleHasLength(1);
|
|
310
313
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('### Signature'));
|
|
311
314
|
});
|
|
@@ -315,7 +318,7 @@ describe('Generates interface documentation', () => {
|
|
|
315
318
|
void myMethod(String param1, Integer param2);
|
|
316
319
|
}
|
|
317
320
|
`;
|
|
318
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
321
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
319
322
|
expect(result).documentationBundleHasLength(1);
|
|
320
323
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('### Parameters'));
|
|
321
324
|
});
|
|
@@ -325,7 +328,7 @@ describe('Generates interface documentation', () => {
|
|
|
325
328
|
String myMethod();
|
|
326
329
|
}
|
|
327
330
|
`;
|
|
328
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
331
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
329
332
|
expect(result).documentationBundleHasLength(1);
|
|
330
333
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('### Return Type'));
|
|
331
334
|
});
|
|
@@ -338,7 +341,7 @@ describe('Generates interface documentation', () => {
|
|
|
338
341
|
void myMethod();
|
|
339
342
|
}
|
|
340
343
|
`;
|
|
341
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
344
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
342
345
|
expect(result).documentationBundleHasLength(1);
|
|
343
346
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('### Throws'));
|
|
344
347
|
});
|
|
@@ -351,7 +354,7 @@ describe('Generates interface documentation', () => {
|
|
|
351
354
|
const input2 = `
|
|
352
355
|
public interface AnotherInterface extends MyInterface {}
|
|
353
356
|
`;
|
|
354
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2]);
|
|
357
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)]);
|
|
355
358
|
expect(result).documentationBundleHasLength(2);
|
|
356
359
|
(0, expect_extensions_1.assertEither)(result, (data) => { var _a; return expect((_a = data.docs.find((doc) => doc.typeName === 'AnotherInterface')) === null || _a === void 0 ? void 0 : _a.docContents).toContain('Inherited'); });
|
|
357
360
|
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generating-interface-docs.spec.js","sourceRoot":"","sources":["../../../src/__spec__/core/generating-interface-docs.spec.ts"],"names":[],"mappings":";;AAAA,2DAAiE;AACjE,4DAAwD;AACxD,iDAAyD;AAEzD,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;IACjD,SAAS,CAAC,GAAG,EAAE;QACb,IAAA,gCAAY,GAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,KAAK,GAAG;;;MAGd,CAAC;YAED,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,MAAM,KAAK,GAAG;;;OAGb,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACvC,MAAM,KAAK,GAAG;;;OAGb,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,MAAM,GAAG;;OAEd,CAAC;YAEF,MAAM,MAAM,GAAG;;OAEd,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,EAAE;gBAC9F,KAAK,EAAE,CAAC,QAAQ,CAAC;aAClB,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,KAAK,GAAG;;;;sCAIkB,CAAC;YAEjC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YACzE,MAAM,KAAK,GAAG;;;;;;QAMZ,CAAC;YAEH,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;YACtC,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;gBACrD,MAAM,KAAK,GAAG;;OAEf,CAAC;gBAEA,MAAM,MAAM,GAAG,yBAAyB,CAAC;gBACzC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YACxE,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;gBACzC,MAAM,KAAK,GAAG;;;;;;QAMd,CAAC;gBAED,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC,CAAC;gBACrF,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;gBAClC,MAAM,KAAK,GAAG;;;;;UAKZ,CAAC;gBAEH,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC,CAAC;YACzF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;gBAC3C,MAAM,KAAK,GAAG;;;;;SAKb,CAAC;gBAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC5E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;gBAC5B,MAAM,KAAK,GAAG;;;;0CAIoB,CAAC;gBAEnC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;gBACvE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;YAC3E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;gBAC7B,MAAM,KAAK,GAAG;;;;0CAIoB,CAAC;gBAEnC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACxE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;gBAC3B,MAAM,KAAK,GAAG;;;;0CAIoB,CAAC;gBAEnC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;gBACtE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;gBAC/B,MAAM,KAAK,GAAG;;;;0CAIoB,CAAC;gBAEnC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC,CAAC;YACzF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;gBAC1C,MAAM,MAAM,GAAG;;;;;WAKZ,CAAC;gBAEJ,MAAM,MAAM,GAAG,kCAAkC,CAAC;gBAElD,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAChG,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAC5B,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,0EAA0E,CAAC,CAC1G,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;gBAC3C,MAAM,KAAK,GAAG;;;;;WAKX,CAAC;gBAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAC5B,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAC3B,qFAAqF,CACtF,CACF,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;gBACtD,MAAM,MAAM,GAAG;;;;;WAKZ,CAAC;gBAEJ,MAAM,MAAM,GAAG,kCAAkC,CAAC;gBAElD,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAChG,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,mCAAmC,CAAC,CAAC,CAAC;YACrG,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;gBACrE,MAAM,KAAK,GAAG;;;;;WAKX,CAAC;gBAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;gBACzD,MAAM,KAAK,GAAG,iCAAiC,CAAC;gBAEhD,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;gBAC5F,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC;gBAC9E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC;YAC/E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;gBACrE,MAAM,KAAK,GAAG,iCAAiC,CAAC;gBAEhD,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;YACnF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;gBACpC,MAAM,KAAK,GAAG;;;;;;;;;;WAUX,CAAC;gBAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC5E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;gBACxC,MAAM,KAAK,GAAG;;;;;;;;;0CASoB,CAAC;gBAEnC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;gBACzE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,CAAC;YACxF,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAClC,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;gBACrC,MAAM,KAAK,GAAG;;;;OAIf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;gBACjE,MAAM,KAAK,GAAG;;;;;;;;;;;;OAYf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC5E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;gBACpE,MAAM,KAAK,GAAG;;;;;;;;;;;;OAYf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;gBACzE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,CAAC;YACxF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;gBACjC,MAAM,KAAK,GAAG;;;;OAIf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC;YACjF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;gBAClC,MAAM,KAAK,GAAG;;;;OAIf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,CAAC;YAClF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;gBACnC,MAAM,KAAK,GAAG;;;;OAIf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;YACnF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;gBAC9B,MAAM,KAAK,GAAG;;;;;;;OAOf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;gBAC5F,MAAM,MAAM,GAAG;;;;OAIhB,CAAC;gBAEA,MAAM,MAAM,GAAG;;OAEhB,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAChG,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,WAC5B,OAAA,MAAM,CAAC,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,kBAAkB,CAAC,0CAAE,WAAW,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA,EAAA,CACzG,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -27,6 +27,7 @@ const expect_extensions_1 = require("./expect-extensions");
|
|
|
27
27
|
const generate_docs_1 = require("../../core/generate-docs");
|
|
28
28
|
const function_1 = require("fp-ts/function");
|
|
29
29
|
const E = __importStar(require("fp-ts/Either"));
|
|
30
|
+
const test_helpers_1 = require("./test-helpers");
|
|
30
31
|
describe('Generates a Reference Guide', () => {
|
|
31
32
|
beforeAll(() => {
|
|
32
33
|
(0, expect_extensions_1.extendExpect)();
|
|
@@ -41,7 +42,7 @@ describe('Generates a Reference Guide', () => {
|
|
|
41
42
|
const input2 = `
|
|
42
43
|
public class MyClass {}
|
|
43
44
|
`;
|
|
44
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2]);
|
|
45
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)]);
|
|
45
46
|
expect(result).documentationBundleHasLength(2);
|
|
46
47
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('[MyEnum](./Miscellaneous/MyEnum.md)'));
|
|
47
48
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('[MyClass](./Miscellaneous/MyClass.md)'));
|
|
@@ -53,7 +54,7 @@ describe('Generates a Reference Guide', () => {
|
|
|
53
54
|
VALUE2
|
|
54
55
|
}
|
|
55
56
|
`;
|
|
56
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
57
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
57
58
|
expect(result).documentationBundleHasLength(1);
|
|
58
59
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('## Miscellaneous'));
|
|
59
60
|
});
|
|
@@ -67,7 +68,7 @@ describe('Generates a Reference Guide', () => {
|
|
|
67
68
|
VALUE2
|
|
68
69
|
}
|
|
69
70
|
`;
|
|
70
|
-
const result = (0, generate_docs_1.generateDocs)([input]);
|
|
71
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input)]);
|
|
71
72
|
expect(result).documentationBundleHasLength(1);
|
|
72
73
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('## MyGroup'));
|
|
73
74
|
});
|
|
@@ -87,7 +88,7 @@ describe('Generates a Reference Guide', () => {
|
|
|
87
88
|
*/
|
|
88
89
|
public class MyClass {}
|
|
89
90
|
`;
|
|
90
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2]);
|
|
91
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)]);
|
|
91
92
|
expect(result).documentationBundleHasLength(2);
|
|
92
93
|
(0, function_1.pipe)(result, E.map((data) => ({
|
|
93
94
|
aGroupIndex: data.referenceGuide.indexOf('## AGroup'),
|
|
@@ -110,7 +111,7 @@ describe('Generates a Reference Guide', () => {
|
|
|
110
111
|
*/
|
|
111
112
|
public class MyClass {}
|
|
112
113
|
`;
|
|
113
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2]);
|
|
114
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)]);
|
|
114
115
|
expect(result).documentationBundleHasLength(2);
|
|
115
116
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('## Group1'));
|
|
116
117
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('MyClass'));
|
|
@@ -132,7 +133,7 @@ describe('Generates a Reference Guide', () => {
|
|
|
132
133
|
*/
|
|
133
134
|
public class MyClass {}
|
|
134
135
|
`;
|
|
135
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2]);
|
|
136
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)]);
|
|
136
137
|
expect(result).documentationBundleHasLength(2);
|
|
137
138
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('This is a description'));
|
|
138
139
|
});
|
|
@@ -153,7 +154,7 @@ describe('Generates a Reference Guide', () => {
|
|
|
153
154
|
*/
|
|
154
155
|
public class MyClass {}
|
|
155
156
|
`;
|
|
156
|
-
const result = (0, generate_docs_1.generateDocs)([input1, input2]);
|
|
157
|
+
const result = (0, generate_docs_1.generateDocs)([(0, test_helpers_1.apexBundleFromRawString)(input1), (0, test_helpers_1.apexBundleFromRawString)(input2)]);
|
|
157
158
|
expect(result).documentationBundleHasLength(2);
|
|
158
159
|
(0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('with a [MyClass](./Group2/MyClass.md)'));
|
|
159
160
|
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generating-reference-guide.spec.js","sourceRoot":"","sources":["../../../src/__spec__/core/generating-reference-guide.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAAiE;AACjE,4DAAwD;AACxD,6CAAsC;AACtC,gDAAkC;AAClC,iDAAyD;AAEzD,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IAC3C,SAAS,CAAC,GAAG,EAAE;QACb,IAAA,gCAAY,GAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,MAAM,GAAG;;;;;OAKZ,CAAC;QAEJ,MAAM,MAAM,GAAG;;OAEZ,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAChG,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAE/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAC,CAAC;QAC7G,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,uCAAuC,CAAC,CAAC,CAAC;IACjH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,KAAK,GAAG;;;;;OAKX,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,KAAK,GAAG;;;;;;;;OAQX,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,MAAM,GAAG;;;;;;;;OAQZ,CAAC;QAEJ,MAAM,MAAM,GAAG;;;;;OAKZ,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAChG,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,eAAI,EACF,MAAM,EACN,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACf,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC;YACrD,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC;SACtD,CAAC,CAAC,EACH,CAAC,CAAC,KAAK,CACL,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,EAC3B,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAClE,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,MAAM,GAAG;;;;;;;;OAQZ,CAAC;QAEJ,MAAM,MAAM,GAAG;;;;;OAKZ,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAChG,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;QACnF,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;QACjF,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,MAAM,GAAG;;;;;;;;OAQZ,CAAC;QAEJ,MAAM,MAAM,GAAG;;;;;OAKZ,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAChG,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC,CAAC;IACjG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACnF,MAAM,MAAM,GAAG;;;;;;;;;OASZ,CAAC;QAEJ,MAAM,MAAM,GAAG;;;;;OAKZ,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,IAAA,sCAAuB,EAAC,MAAM,CAAC,EAAE,IAAA,sCAAuB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAChG,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,uCAAuC,CAAC,CAAC,CAAC;IACjH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.apexBundleFromRawString = void 0;
|
|
4
|
+
function apexBundleFromRawString(raw, rawMetadata) {
|
|
5
|
+
return {
|
|
6
|
+
filePath: 'test.cls',
|
|
7
|
+
rawTypeContent: raw,
|
|
8
|
+
rawMetadataContent: rawMetadata !== null && rawMetadata !== void 0 ? rawMetadata : null,
|
|
9
|
+
};
|
|
10
|
+
}
|
|
11
|
+
exports.apexBundleFromRawString = apexBundleFromRawString;
|
|
12
|
+
//# sourceMappingURL=test-helpers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"test-helpers.js","sourceRoot":"","sources":["../../../src/__spec__/core/test-helpers.ts"],"names":[],"mappings":";;;AAEA,SAAgB,uBAAuB,CAAC,GAAW,EAAE,WAAoB;IACvE,OAAO;QACL,QAAQ,EAAE,UAAU;QACpB,cAAc,EAAE,GAAG;QACnB,kBAAkB,EAAE,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,IAAI;KACxC,CAAC;AACJ,CAAC;AAND,0DAMC"}
|