Skip to content

Fix type linking for msdocs and NPM packages #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SBLMikeDemone merged 3 commits into from
Sep 4, 2025
Merged

Fix type linking for msdocs and NPM packages #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d59dca
Fix type linking
SBLMikeDemone Sep 3, 2025
2a53e65
Update test name
SBLMikeDemone Sep 3, 2025
35ed81a
Change files
SBLMikeDemone Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@minecraft-api-docs-generator-8b44bd81-4557-4cbf-a802-d412a5008f2c.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Fix type linking",
"packageName": "@minecraft/api-docs-generator",
"email": "mike.demone@skyboxlabs.com",
"dependentChangeType": "patch"
}
1,588 changes: 1,588 additions & 0 deletions ...pi-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap
View file
Open in desktop

Large diffs are not rendered by default.

231 changes: 11 additions & 220 deletions ...s/api-docs-generator-test-snapshots/test/type_linking/input/test-script-module 1.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,221 +1,12 @@
{
"classes": [
{
"name": "BaseClassWithPrivateConstructor",
"type": {
"is_bind_type": true,
"is_errorable": false,
"name": "BaseClassWithPrivateConstructor"
}
},
{
"base_types": [
{
"is_bind_type": true,
"is_errorable": false,
"name": "BaseClassWithPrivateConstructor"
}
],
"name": "ChildClassOfPrivateConstructor",
"properties": [],
"type": {
"is_bind_type": true,
"is_errorable": false,
"name": "ChildClassOfPrivateConstructor"
}
},
{
"base_types": [
{
"is_bind_type": true,
"is_errorable": false,
"name": "BaseClassWithPrivateConstructor"
}
],
"name": "ChildClassOfPrivateConstructor2",
"properties": [],
"type": {
"is_bind_type": true,
"is_errorable": false,
"name": "ChildClassOfPrivateConstructor2"
}
},
{
"name": "ExampleClass",
"functions": [
{
"arguments": [
{
"details": null,
"name": "testArg",
"type": {
"is_bind_type": false,
"is_errorable": false,
"name": "string",
"valid_range": null
}
}
],
"is_constructor": false,
"is_static": false,
"name": "ExampleMethod",
"return_type": {
"is_bind_type": false,
"is_errorable": false,
"name": "boolean",
"valid_range": null
}
}
],
"properties": [
{
"is_read_only": false,
"name": "ExampleProperty",
"type": {
"is_bind_type": false,
"is_errorable": false,
"name": "int32"
}
}
],
"type": {
"is_bind_type": true,
"is_errorable": false,
"name": "ExampleClass",
"valid_range": null
}
},
{
"name": "ExampleClassWithCrossModuleInheritence",
"type": {
"is_bind_type": true,
"is_errorable": false,
"name": "ExampleClassWithCrossModuleInheritence",
"valid_range": null
}
}
],
"enums": [
{
"name": "ExampleEnum",
"constants": [
{
"is_read_only": true,
"is_static": true,
"name": "ExampleValue",
"type": {
"is_bind_type": false,
"is_errorable": false,
"name": "string",
"valid_range": null
},
"value": "foo"
}
]
}
],
"functions": [
{
"arguments": [
{
"details": null,
"name": "testArg",
"type": {
"is_bind_type": false,
"is_errorable": false,
"name": "string",
"valid_range": null
}
}
],
"is_constructor": false,
"is_static": false,
"name": "ExampleFunction",
"return_type": {
"is_bind_type": false,
"is_errorable": false,
"name": "boolean",
"valid_range": null
}
}
],
"interfaces": [
{
"name": "ExampleInterface",
"properties": [
{
"is_read_only": false,
"name": "ExampleProperty",
"type": {
"is_bind_type": false,
"is_errorable": false,
"name": "int32"
}
}
],
"type": {
"is_bind_type": true,
"is_errorable": false,
"name": "ExampleInterface"
}
}
],
"constants": [
{
"is_read_only": true,
"is_static": true,
"name": "ExampleConstant",
"type": {
"is_bind_type": false,
"is_errorable": false,
"name": "int32",
"valid_range": {
"max": 2147483647,
"min": -2147483648
}
},
"value": 25
}
],
"objects": [
{
"is_read_only": true,
"is_static": true,
"name": "ExampleObject",
"type": {
"is_bind_type": true,
"is_errorable": false,
"name": "ExampleClass",
"valid_range": null
}
},
{
"is_read_only": true,
"is_static": true,
"name": "ExampleObjectInModule3",
"type": {
"is_bind_type": true,
"is_errorable": false,
"name": "ExampleClassInModule3V1AndV2",
"from_module": {
"name": "@minecraft/example-module-3",
"uuid": "a61fb766-9364-476a-96fd-61cde5178761",
"version": "1.0.0"
},
"valid_range": null
}
}
],
"dependencies": [
{
"name": "@minecraft/example-module-3",
"uuid": "a61fb766-9364-476a-96fd-61cde5178761",
"version": "1.0.0"
}
],
"minecraft_version": "1.0.0",
"name": "@minecraft/example-module",
"uuid": "a61fb766-9364-476a-96fd-61cde517876e",
"version": "1.0.0",
"module_type": "script"
}
"parentModule": {
"name": "@minecraft/example-module-parent",
"uuid": "a61fb766-9364-476a-96fd-61cde517876f",
"version": "1.0.0"
},
"minecraft_version": "1.0.0",
"name": "@minecraft/example-module",
"uuid": "a61fb766-9364-476a-96fd-61cde517876e",
"version": "1.0.0",
"module_type": "script"
}
Loading