diff --git a/change/@minecraft-markup-generators-plugin-ca3ef469-7929-4e41-aa98-cb340c1e19d2.json b/change/@minecraft-markup-generators-plugin-ca3ef469-7929-4e41-aa98-cb340c1e19d2.json new file mode 100644 index 0000000..a279132 --- /dev/null +++ b/change/@minecraft-markup-generators-plugin-ca3ef469-7929-4e41-aa98-cb340c1e19d2.json @@ -0,0 +1,7 @@ +{ + "type": "patch", + "comment": "Add Type Alias to TOC", + "packageName": "@minecraft/markup-generators-plugin", + "email": "mike.demone@skyboxlabs.com", + "dependentChangeType": "patch" +} diff --git a/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap index 60aaf30..8b8c3b2 100644 --- a/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap @@ -2107,6 +2107,12 @@ exports[`Changelog Diffing > Generates correct output for changelog diffs > msdo href: test-module1-1xx/ExampleInterface.md - name: RemovedInterface href: test-module1-1xx/RemovedInterface.md + - name: ChangedType + href: test-module1-1xx/ChangedType.md + - name: ChangedTypeMap + href: test-module1-1xx/ChangedTypeMap.md + - name: RemovedType + href: test-module1-1xx/RemovedType.md " `; @@ -2955,6 +2961,8 @@ exports[`Changelog Diffing > Generates correct output for changelog diffs > msdo href: peer-module/peer-module.md - name: peer-module Changelog href: peer-module/changelog.md + - name: TypeAliasFromPeerDependency + href: peer-module/TypeAliasFromPeerDependency.md - name: test-module1 items: - name: test-module1 @@ -2981,6 +2989,12 @@ exports[`Changelog Diffing > Generates correct output for changelog diffs > msdo href: test-module1/AddedInterface.md - name: ExampleInterface href: test-module1/ExampleInterface.md + - name: AddedType + href: test-module1/AddedType.md + - name: ChangedType + href: test-module1/ChangedType.md + - name: ChangedTypeMap + href: test-module1/ChangedTypeMap.md " `; diff --git a/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap index 4c8d38d..34a8276 100644 --- a/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap @@ -7,6 +7,8 @@ exports[`Hybrid Script and Native Module > Generates documentation for both the items: - name: hybrid-module 0.x.x href: hybrid-module-0xx/hybrid-module.md + - name: TypeAliasWithTSDocComments + href: hybrid-module-0xx/TypeAliasWithTSDocComments.md - name: hybrid-module-native 0.x.x items: - name: hybrid-module-native 0.x.x @@ -126,6 +128,10 @@ exports[`Hybrid Script and Native Module > Generates documentation for both the href: hybrid-module/ScriptGeneratedEnum.md - name: ScriptGeneratedClass href: hybrid-module/ScriptGeneratedClass.md + - name: TypeAliasWithInfoJsonComments + href: hybrid-module/TypeAliasWithInfoJsonComments.md + - name: TypeAliasWithTSDocComments + href: hybrid-module/TypeAliasWithTSDocComments.md - name: hybrid-module-native items: - name: hybrid-module-native @@ -1298,6 +1304,8 @@ exports[`Hybrid Script and Native Module > Properly generates documentation for items: - name: hybrid-module 0.x.x href: hybrid-module-0xx/hybrid-module.md + - name: TypeAliasWithTSDocComments + href: hybrid-module-0xx/TypeAliasWithTSDocComments.md " `; @@ -1376,6 +1384,10 @@ exports[`Hybrid Script and Native Module > Properly generates documentation for href: hybrid-module/ScriptGeneratedEnum.md - name: ScriptGeneratedClass href: hybrid-module/ScriptGeneratedClass.md + - name: TypeAliasWithInfoJsonComments + href: hybrid-module/TypeAliasWithInfoJsonComments.md + - name: TypeAliasWithTSDocComments + href: hybrid-module/TypeAliasWithTSDocComments.md - name: hybrid-module-native items: - name: hybrid-module-native diff --git a/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap index acffd93..3013540 100644 --- a/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap @@ -13,6 +13,10 @@ exports[`Script Generated Modules > Properly generates documentation for modules href: generated-module/ScriptGeneratedEnum.md - name: ScriptGeneratedClass href: generated-module/ScriptGeneratedClass.md + - name: TypeAliasWithInfoJsonComments + href: generated-module/TypeAliasWithInfoJsonComments.md + - name: TypeAliasWithTSDocComments + href: generated-module/TypeAliasWithTSDocComments.md " `; diff --git a/tools/api-docs-generator-test-snapshots/test/type_maps/__snapshots__/typeMaps.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/type_maps/__snapshots__/typeMaps.spec.ts.snap index ca14b84..707eea7 100644 --- a/tools/api-docs-generator-test-snapshots/test/type_maps/__snapshots__/typeMaps.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/type_maps/__snapshots__/typeMaps.spec.ts.snap @@ -7,6 +7,10 @@ exports[`Optionals > Properly generates documentation for modules which contain items: - name: type-maps-and-script-aliases-module href: type-maps-and-script-aliases-module/type-maps-and-script-aliases-module.md + - name: TestTypeMap + href: type-maps-and-script-aliases-module/TestTypeMap.md + - name: TestTypeMapUnion + href: type-maps-and-script-aliases-module/TestTypeMapUnion.md - name: type-maps-module items: - name: type-maps-module @@ -17,6 +21,8 @@ exports[`Optionals > Properly generates documentation for modules which contain href: type-maps-module/FakeComponent.md - name: TestComponent href: type-maps-module/TestComponent.md + - name: TestComponentTypeMap + href: type-maps-module/TestComponentTypeMap.md " `; diff --git a/tools/markup-generators-plugin/templates/msdocs/script/toc.mustache b/tools/markup-generators-plugin/templates/msdocs/script/toc.mustache index 9656438..41a7f61 100644 --- a/tools/markup-generators-plugin/templates/msdocs/script/toc.mustache +++ b/tools/markup-generators-plugin/templates/msdocs/script/toc.mustache @@ -21,4 +21,8 @@ - name: {{{name}}} href: {{{from_module.filepath_name}}}/{{{name}}}.md {{/interfaces}} +{{#type_aliases}} + - name: {{{name}}} + href: {{{from_module.filepath_name}}}/{{{name}}}.md +{{/type_aliases}} {{/script_modules}}