Skip to content

Commit f370c88

Browse files
Add Type Alias to Table of Contents for MSDocs (#91)
1 parent a18da6c commit f370c88

File tree

6 files changed

+47
-0
lines changed

6 files changed

+47
-0
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"type": "patch",
3+
"comment": "Add Type Alias to TOC",
4+
"packageName": "@minecraft/markup-generators-plugin",
5+
"email": "mike.demone@skyboxlabs.com",
6+
"dependentChangeType": "patch"
7+
}

tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2107,6 +2107,12 @@ exports[`Changelog Diffing > Generates correct output for changelog diffs > msdo
21072107
href: test-module1-1xx/ExampleInterface.md
21082108
- name: RemovedInterface
21092109
href: test-module1-1xx/RemovedInterface.md
2110+
- name: ChangedType
2111+
href: test-module1-1xx/ChangedType.md
2112+
- name: ChangedTypeMap
2113+
href: test-module1-1xx/ChangedTypeMap.md
2114+
- name: RemovedType
2115+
href: test-module1-1xx/RemovedType.md
21102116
"
21112117
`;
21122118

@@ -2955,6 +2961,8 @@ exports[`Changelog Diffing > Generates correct output for changelog diffs > msdo
29552961
href: peer-module/peer-module.md
29562962
- name: peer-module Changelog
29572963
href: peer-module/changelog.md
2964+
- name: TypeAliasFromPeerDependency
2965+
href: peer-module/TypeAliasFromPeerDependency.md
29582966
- name: test-module1
29592967
items:
29602968
- name: test-module1
@@ -2981,6 +2989,12 @@ exports[`Changelog Diffing > Generates correct output for changelog diffs > msdo
29812989
href: test-module1/AddedInterface.md
29822990
- name: ExampleInterface
29832991
href: test-module1/ExampleInterface.md
2992+
- name: AddedType
2993+
href: test-module1/AddedType.md
2994+
- name: ChangedType
2995+
href: test-module1/ChangedType.md
2996+
- name: ChangedTypeMap
2997+
href: test-module1/ChangedTypeMap.md
29842998
"
29852999
`;
29863000

tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ exports[`Hybrid Script and Native Module > Generates documentation for both the
77
items:
88
- name: hybrid-module 0.x.x
99
href: hybrid-module-0xx/hybrid-module.md
10+
- name: TypeAliasWithTSDocComments
11+
href: hybrid-module-0xx/TypeAliasWithTSDocComments.md
1012
- name: hybrid-module-native 0.x.x
1113
items:
1214
- name: hybrid-module-native 0.x.x
@@ -126,6 +128,10 @@ exports[`Hybrid Script and Native Module > Generates documentation for both the
126128
href: hybrid-module/ScriptGeneratedEnum.md
127129
- name: ScriptGeneratedClass
128130
href: hybrid-module/ScriptGeneratedClass.md
131+
- name: TypeAliasWithInfoJsonComments
132+
href: hybrid-module/TypeAliasWithInfoJsonComments.md
133+
- name: TypeAliasWithTSDocComments
134+
href: hybrid-module/TypeAliasWithTSDocComments.md
129135
- name: hybrid-module-native
130136
items:
131137
- name: hybrid-module-native
@@ -1298,6 +1304,8 @@ exports[`Hybrid Script and Native Module > Properly generates documentation for
12981304
items:
12991305
- name: hybrid-module 0.x.x
13001306
href: hybrid-module-0xx/hybrid-module.md
1307+
- name: TypeAliasWithTSDocComments
1308+
href: hybrid-module-0xx/TypeAliasWithTSDocComments.md
13011309
"
13021310
`;
13031311

@@ -1376,6 +1384,10 @@ exports[`Hybrid Script and Native Module > Properly generates documentation for
13761384
href: hybrid-module/ScriptGeneratedEnum.md
13771385
- name: ScriptGeneratedClass
13781386
href: hybrid-module/ScriptGeneratedClass.md
1387+
- name: TypeAliasWithInfoJsonComments
1388+
href: hybrid-module/TypeAliasWithInfoJsonComments.md
1389+
- name: TypeAliasWithTSDocComments
1390+
href: hybrid-module/TypeAliasWithTSDocComments.md
13791391
- name: hybrid-module-native
13801392
items:
13811393
- name: hybrid-module-native

tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ exports[`Script Generated Modules > Properly generates documentation for modules
1313
href: generated-module/ScriptGeneratedEnum.md
1414
- name: ScriptGeneratedClass
1515
href: generated-module/ScriptGeneratedClass.md
16+
- name: TypeAliasWithInfoJsonComments
17+
href: generated-module/TypeAliasWithInfoJsonComments.md
18+
- name: TypeAliasWithTSDocComments
19+
href: generated-module/TypeAliasWithTSDocComments.md
1620
"
1721
`;
1822

tools/api-docs-generator-test-snapshots/test/type_maps/__snapshots__/typeMaps.spec.ts.snap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ exports[`Optionals > Properly generates documentation for modules which contain
77
items:
88
- name: type-maps-and-script-aliases-module
99
href: type-maps-and-script-aliases-module/type-maps-and-script-aliases-module.md
10+
- name: TestTypeMap
11+
href: type-maps-and-script-aliases-module/TestTypeMap.md
12+
- name: TestTypeMapUnion
13+
href: type-maps-and-script-aliases-module/TestTypeMapUnion.md
1014
- name: type-maps-module
1115
items:
1216
- name: type-maps-module
@@ -17,6 +21,8 @@ exports[`Optionals > Properly generates documentation for modules which contain
1721
href: type-maps-module/FakeComponent.md
1822
- name: TestComponent
1923
href: type-maps-module/TestComponent.md
24+
- name: TestComponentTypeMap
25+
href: type-maps-module/TestComponentTypeMap.md
2026
"
2127
`;
2228

tools/markup-generators-plugin/templates/msdocs/script/toc.mustache

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,8 @@
2121
- name: {{{name}}}
2222
href: {{{from_module.filepath_name}}}/{{{name}}}.md
2323
{{/interfaces}}
24+
{{#type_aliases}}
25+
- name: {{{name}}}
26+
href: {{{from_module.filepath_name}}}/{{{name}}}.md
27+
{{/type_aliases}}
2428
{{/script_modules}}

0 commit comments

Comments
 (0)