Skip to content

Commit c4906fa

Browse files
SBLMikeDemoneSBLMikeDemone
authored
Fix type linking for msdocs and NPM packages (#96)
1 parent 0891e56 commit c4906fa

File tree

11 files changed

+2101
-459
lines changed

11 files changed

+2101
-459
lines changed

‎change/@minecraft-api-docs-generator-8b44bd81-4557-4cbf-a802-d412a5008f2c.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"type": "patch",
3+
"comment": "Fix type linking",
4+
"packageName": "@minecraft/api-docs-generator",
5+
"email": "[email protected]",
6+
"dependentChangeType": "patch"
7+
}

‎tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap‎

Lines changed: 1588 additions & 0 deletions
Large diffs are not rendered by default.

‎tools/api-docs-generator-test-snapshots/test/type_linking/input/test-script-module 1.0.0.json‎

Lines changed: 11 additions & 220 deletions
Original file line numberDiff line numberDiff line change
@@ -1,221 +1,12 @@
11
{
2-
"classes": [
3-
{
4-
"name": "BaseClassWithPrivateConstructor",
5-
"type": {
6-
"is_bind_type": true,
7-
"is_errorable": false,
8-
"name": "BaseClassWithPrivateConstructor"
9-
}
10-
},
11-
{
12-
"base_types": [
13-
{
14-
"is_bind_type": true,
15-
"is_errorable": false,
16-
"name": "BaseClassWithPrivateConstructor"
17-
}
18-
],
19-
"name": "ChildClassOfPrivateConstructor",
20-
"properties": [],
21-
"type": {
22-
"is_bind_type": true,
23-
"is_errorable": false,
24-
"name": "ChildClassOfPrivateConstructor"
25-
}
26-
},
27-
{
28-
"base_types": [
29-
{
30-
"is_bind_type": true,
31-
"is_errorable": false,
32-
"name": "BaseClassWithPrivateConstructor"
33-
}
34-
],
35-
"name": "ChildClassOfPrivateConstructor2",
36-
"properties": [],
37-
"type": {
38-
"is_bind_type": true,
39-
"is_errorable": false,
40-
"name": "ChildClassOfPrivateConstructor2"
41-
}
42-
},
43-
{
44-
"name": "ExampleClass",
45-
"functions": [
46-
{
47-
"arguments": [
48-
{
49-
"details": null,
50-
"name": "testArg",
51-
"type": {
52-
"is_bind_type": false,
53-
"is_errorable": false,
54-
"name": "string",
55-
"valid_range": null
56-
}
57-
}
58-
],
59-
"is_constructor": false,
60-
"is_static": false,
61-
"name": "ExampleMethod",
62-
"return_type": {
63-
"is_bind_type": false,
64-
"is_errorable": false,
65-
"name": "boolean",
66-
"valid_range": null
67-
}
68-
}
69-
],
70-
"properties": [
71-
{
72-
"is_read_only": false,
73-
"name": "ExampleProperty",
74-
"type": {
75-
"is_bind_type": false,
76-
"is_errorable": false,
77-
"name": "int32"
78-
}
79-
}
80-
],
81-
"type": {
82-
"is_bind_type": true,
83-
"is_errorable": false,
84-
"name": "ExampleClass",
85-
"valid_range": null
86-
}
87-
},
88-
{
89-
"name": "ExampleClassWithCrossModuleInheritence",
90-
"type": {
91-
"is_bind_type": true,
92-
"is_errorable": false,
93-
"name": "ExampleClassWithCrossModuleInheritence",
94-
"valid_range": null
95-
}
96-
}
97-
],
98-
"enums": [
99-
{
100-
"name": "ExampleEnum",
101-
"constants": [
102-
{
103-
"is_read_only": true,
104-
"is_static": true,
105-
"name": "ExampleValue",
106-
"type": {
107-
"is_bind_type": false,
108-
"is_errorable": false,
109-
"name": "string",
110-
"valid_range": null
111-
},
112-
"value": "foo"
113-
}
114-
]
115-
}
116-
],
117-
"functions": [
118-
{
119-
"arguments": [
120-
{
121-
"details": null,
122-
"name": "testArg",
123-
"type": {
124-
"is_bind_type": false,
125-
"is_errorable": false,
126-
"name": "string",
127-
"valid_range": null
128-
}
129-
}
130-
],
131-
"is_constructor": false,
132-
"is_static": false,
133-
"name": "ExampleFunction",
134-
"return_type": {
135-
"is_bind_type": false,
136-
"is_errorable": false,
137-
"name": "boolean",
138-
"valid_range": null
139-
}
140-
}
141-
],
142-
"interfaces": [
143-
{
144-
"name": "ExampleInterface",
145-
"properties": [
146-
{
147-
"is_read_only": false,
148-
"name": "ExampleProperty",
149-
"type": {
150-
"is_bind_type": false,
151-
"is_errorable": false,
152-
"name": "int32"
153-
}
154-
}
155-
],
156-
"type": {
157-
"is_bind_type": true,
158-
"is_errorable": false,
159-
"name": "ExampleInterface"
160-
}
161-
}
162-
],
163-
"constants": [
164-
{
165-
"is_read_only": true,
166-
"is_static": true,
167-
"name": "ExampleConstant",
168-
"type": {
169-
"is_bind_type": false,
170-
"is_errorable": false,
171-
"name": "int32",
172-
"valid_range": {
173-
"max": 2147483647,
174-
"min": -2147483648
175-
}
176-
},
177-
"value": 25
178-
}
179-
],
180-
"objects": [
181-
{
182-
"is_read_only": true,
183-
"is_static": true,
184-
"name": "ExampleObject",
185-
"type": {
186-
"is_bind_type": true,
187-
"is_errorable": false,
188-
"name": "ExampleClass",
189-
"valid_range": null
190-
}
191-
},
192-
{
193-
"is_read_only": true,
194-
"is_static": true,
195-
"name": "ExampleObjectInModule3",
196-
"type": {
197-
"is_bind_type": true,
198-
"is_errorable": false,
199-
"name": "ExampleClassInModule3V1AndV2",
200-
"from_module": {
201-
"name": "@minecraft/example-module-3",
202-
"uuid": "a61fb766-9364-476a-96fd-61cde5178761",
203-
"version": "1.0.0"
204-
},
205-
"valid_range": null
206-
}
207-
}
208-
],
209-
"dependencies": [
210-
{
211-
"name": "@minecraft/example-module-3",
212-
"uuid": "a61fb766-9364-476a-96fd-61cde5178761",
213-
"version": "1.0.0"
214-
}
215-
],
216-
"minecraft_version": "1.0.0",
217-
"name": "@minecraft/example-module",
218-
"uuid": "a61fb766-9364-476a-96fd-61cde517876e",
219-
"version": "1.0.0",
220-
"module_type": "script"
221-
}
2+
"parentModule": {
3+
"name": "@minecraft/example-module-parent",
4+
"uuid": "a61fb766-9364-476a-96fd-61cde517876f",
5+
"version": "1.0.0"
6+
},
7+
"minecraft_version": "1.0.0",
8+
"name": "@minecraft/example-module",
9+
"uuid": "a61fb766-9364-476a-96fd-61cde517876e",
10+
"version": "1.0.0",
11+
"module_type": "script"
12+
}

0 commit comments

Comments
 (0)