@progress/kendo-typescript-api-tasks 1.1.2-dev.3 → 1.1.2-dev.34
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/index.js +14 -5
- package/lib/class-page.js +2 -2
- package/lib/comment.js +16 -11
- package/lib/component-page.js +4 -4
- package/lib/generator.js +29 -21
- package/lib/is-constructor.js +2 -1
- package/lib/is-method.js +2 -1
- package/lib/map-constructors.js +9 -10
- package/lib/map-methods.js +4 -6
- package/lib/map-props.js +10 -9
- package/lib/plugins/decorators.js +43 -0
- package/lib/react/component-page.js +2 -2
- package/lib/return-type.js +11 -11
- package/lib/source.js +13 -0
- package/lib/type-utils.js +7 -6
- package/lib/warn.js +3 -8
- package/package.json +6 -5
- package/test/api.js +22 -15
- package/test/class.json +29 -9
- package/test/components-def.json +56 -16
- package/test/events-def.json +39 -8
- package/test/fields-def.json +62 -12
- package/test/fn-def.json +41 -10
- package/test/fn.json +62 -13
- package/test/inputs-def.json +27 -3
- package/test/interface-comments.json +84 -23
- package/test/intersection.json +1 -1
- package/test/package.json +7 -6
- package/test/warning.js +27 -9
package/test/fn.json
CHANGED
|
@@ -7,13 +7,34 @@
|
|
|
7
7
|
"isExported": true
|
|
8
8
|
},
|
|
9
9
|
"comment": {
|
|
10
|
-
"
|
|
11
|
-
"text": "ROOT_TEXT",
|
|
12
|
-
"returns": "ROOT_RETURN",
|
|
13
|
-
"tags": [
|
|
10
|
+
"summary": [
|
|
14
11
|
{
|
|
15
|
-
"
|
|
16
|
-
"text": "
|
|
12
|
+
"kind": "text",
|
|
13
|
+
"text": "ROOT_DESC"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"kind": "text",
|
|
17
|
+
"text": "ROOT_TEXT"
|
|
18
|
+
}
|
|
19
|
+
],
|
|
20
|
+
"blockTags": [
|
|
21
|
+
{
|
|
22
|
+
"tag": "@returns",
|
|
23
|
+
"content": [
|
|
24
|
+
{
|
|
25
|
+
"kind": "code",
|
|
26
|
+
"text": "ROOT_RETURN"
|
|
27
|
+
}
|
|
28
|
+
]
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"tag": "@example",
|
|
32
|
+
"content": [
|
|
33
|
+
{
|
|
34
|
+
"kind": "code",
|
|
35
|
+
"text": "ROOT_EXAMPLE"
|
|
36
|
+
}
|
|
37
|
+
]
|
|
17
38
|
}
|
|
18
39
|
]
|
|
19
40
|
},
|
|
@@ -25,9 +46,27 @@
|
|
|
25
46
|
"kindString": "Call signature",
|
|
26
47
|
"flags": {},
|
|
27
48
|
"comment": {
|
|
28
|
-
"
|
|
29
|
-
|
|
30
|
-
|
|
49
|
+
"summary": [
|
|
50
|
+
{
|
|
51
|
+
"kind": "text",
|
|
52
|
+
"text": "SIG_DESC"
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"kind": "text",
|
|
56
|
+
"text": "SIG_TEXT"
|
|
57
|
+
}
|
|
58
|
+
],
|
|
59
|
+
"blockTags": [
|
|
60
|
+
{
|
|
61
|
+
"tag": "@returns",
|
|
62
|
+
"content": [
|
|
63
|
+
{
|
|
64
|
+
"kind": "code",
|
|
65
|
+
"text": "SIG_RETURN"
|
|
66
|
+
}
|
|
67
|
+
]
|
|
68
|
+
}
|
|
69
|
+
]
|
|
31
70
|
},
|
|
32
71
|
"typeParameter": [
|
|
33
72
|
{
|
|
@@ -46,7 +85,12 @@
|
|
|
46
85
|
"kindString": "Parameter",
|
|
47
86
|
"flags": {},
|
|
48
87
|
"comment": {
|
|
49
|
-
"
|
|
88
|
+
"summary": [
|
|
89
|
+
{
|
|
90
|
+
"kind": "text",
|
|
91
|
+
"text": "PARAM1_DESC"
|
|
92
|
+
}
|
|
93
|
+
]
|
|
50
94
|
},
|
|
51
95
|
"type": {
|
|
52
96
|
"type": "typeParameter",
|
|
@@ -61,13 +105,18 @@
|
|
|
61
105
|
"kindString": "Parameter",
|
|
62
106
|
"flags": {},
|
|
63
107
|
"comment": {
|
|
64
|
-
"
|
|
108
|
+
"summary": [
|
|
109
|
+
{
|
|
110
|
+
"kind": "text",
|
|
111
|
+
"text": "PARAM2_DESC"
|
|
112
|
+
}
|
|
113
|
+
]
|
|
65
114
|
},
|
|
66
115
|
"type": {
|
|
67
116
|
"type": "reference",
|
|
68
117
|
"isArray": true,
|
|
69
118
|
"name": "RefType",
|
|
70
|
-
"
|
|
119
|
+
"target": 174
|
|
71
120
|
},
|
|
72
121
|
"defaultValue": " []"
|
|
73
122
|
}
|
|
@@ -75,7 +124,7 @@
|
|
|
75
124
|
"type": {
|
|
76
125
|
"type": "reference",
|
|
77
126
|
"name": "SIG_RETURN",
|
|
78
|
-
"
|
|
127
|
+
"target": 110
|
|
79
128
|
}
|
|
80
129
|
}
|
|
81
130
|
],
|
package/test/inputs-def.json
CHANGED
|
@@ -42,7 +42,19 @@
|
|
|
42
42
|
"type": "instrinct",
|
|
43
43
|
"name": "boolean"
|
|
44
44
|
},
|
|
45
|
-
"
|
|
45
|
+
"comment": {
|
|
46
|
+
"blockTags": [
|
|
47
|
+
{
|
|
48
|
+
"tag": "@default",
|
|
49
|
+
"content": [
|
|
50
|
+
{
|
|
51
|
+
"kind": "code",
|
|
52
|
+
"text": "```ts\nfalse\n```"
|
|
53
|
+
}
|
|
54
|
+
]
|
|
55
|
+
}
|
|
56
|
+
]
|
|
57
|
+
}
|
|
46
58
|
}
|
|
47
59
|
]
|
|
48
60
|
},
|
|
@@ -83,7 +95,7 @@
|
|
|
83
95
|
"name": "Input"
|
|
84
96
|
},
|
|
85
97
|
"arguments": {
|
|
86
|
-
"
|
|
98
|
+
"obj": "'foo'"
|
|
87
99
|
}
|
|
88
100
|
}
|
|
89
101
|
],
|
|
@@ -91,7 +103,19 @@
|
|
|
91
103
|
"type": "instrinct",
|
|
92
104
|
"name": "boolean"
|
|
93
105
|
},
|
|
94
|
-
"
|
|
106
|
+
"comment": {
|
|
107
|
+
"blockTags": [
|
|
108
|
+
{
|
|
109
|
+
"tag": "@default",
|
|
110
|
+
"content": [
|
|
111
|
+
{
|
|
112
|
+
"kind": "code",
|
|
113
|
+
"text": "```ts\nfalse\n```"
|
|
114
|
+
}
|
|
115
|
+
]
|
|
116
|
+
}
|
|
117
|
+
]
|
|
118
|
+
}
|
|
95
119
|
}
|
|
96
120
|
]
|
|
97
121
|
}
|
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"id": 0,
|
|
3
3
|
"name": "package-name",
|
|
4
|
-
|
|
4
|
+
"variant": "project",
|
|
5
|
+
"kind": 1,
|
|
5
6
|
"flags": {},
|
|
6
7
|
"children": [
|
|
7
8
|
{
|
|
8
9
|
"id": 68,
|
|
9
10
|
"name": "\"src/base.d\"",
|
|
10
|
-
"kind":
|
|
11
|
+
"kind": 2,
|
|
11
12
|
"kindString": "External module",
|
|
12
13
|
"flags": {
|
|
13
14
|
"isExported": true
|
|
@@ -22,7 +23,12 @@
|
|
|
22
23
|
"isExported": true
|
|
23
24
|
},
|
|
24
25
|
"comment": {
|
|
25
|
-
"
|
|
26
|
+
"summary": [
|
|
27
|
+
{
|
|
28
|
+
"kind": "text",
|
|
29
|
+
"text": "An interface"
|
|
30
|
+
}
|
|
31
|
+
]
|
|
26
32
|
},
|
|
27
33
|
"typeParameter": [
|
|
28
34
|
{
|
|
@@ -43,7 +49,12 @@
|
|
|
43
49
|
"isExported": true
|
|
44
50
|
},
|
|
45
51
|
"comment": {
|
|
46
|
-
"
|
|
52
|
+
"summary": [
|
|
53
|
+
{
|
|
54
|
+
"kind": "text",
|
|
55
|
+
"shortText": "METHOD_DESC"
|
|
56
|
+
}
|
|
57
|
+
]
|
|
47
58
|
},
|
|
48
59
|
"signatures": [
|
|
49
60
|
{
|
|
@@ -53,8 +64,23 @@
|
|
|
53
64
|
"kindString": "Call signature",
|
|
54
65
|
"flags": {},
|
|
55
66
|
"comment": {
|
|
56
|
-
"
|
|
57
|
-
|
|
67
|
+
"summary": [
|
|
68
|
+
{
|
|
69
|
+
"kind": "text",
|
|
70
|
+
"text": "SIG_DESC"
|
|
71
|
+
}
|
|
72
|
+
],
|
|
73
|
+
"blockTags": [
|
|
74
|
+
{
|
|
75
|
+
"tag": "@returns",
|
|
76
|
+
"content": [
|
|
77
|
+
{
|
|
78
|
+
"kind": "text",
|
|
79
|
+
"text": "The current instance to allow chaining.\n"
|
|
80
|
+
}
|
|
81
|
+
]
|
|
82
|
+
}
|
|
83
|
+
]
|
|
58
84
|
},
|
|
59
85
|
"parameters": [
|
|
60
86
|
{
|
|
@@ -64,7 +90,12 @@
|
|
|
64
90
|
"kindString": "Parameter",
|
|
65
91
|
"flags": {},
|
|
66
92
|
"comment": {
|
|
67
|
-
"
|
|
93
|
+
"summary": [
|
|
94
|
+
{
|
|
95
|
+
"kind": "text",
|
|
96
|
+
"text": "PARAM_DESC"
|
|
97
|
+
}
|
|
98
|
+
]
|
|
68
99
|
},
|
|
69
100
|
"type": {
|
|
70
101
|
"type": "instrinct",
|
|
@@ -107,7 +138,7 @@
|
|
|
107
138
|
{
|
|
108
139
|
"type": "reference",
|
|
109
140
|
"name": "Child",
|
|
110
|
-
"
|
|
141
|
+
"target": 519
|
|
111
142
|
}
|
|
112
143
|
]
|
|
113
144
|
}
|
|
@@ -116,7 +147,7 @@
|
|
|
116
147
|
{
|
|
117
148
|
"id": 561,
|
|
118
149
|
"name": "\"src/impl.d\"",
|
|
119
|
-
"kind":
|
|
150
|
+
"kind": 2,
|
|
120
151
|
"kindString": "External module",
|
|
121
152
|
"flags": {
|
|
122
153
|
"isExported": true
|
|
@@ -131,7 +162,12 @@
|
|
|
131
162
|
"isExported": true
|
|
132
163
|
},
|
|
133
164
|
"comment": {
|
|
134
|
-
"
|
|
165
|
+
"summary": [
|
|
166
|
+
{
|
|
167
|
+
"kind": "text",
|
|
168
|
+
"text": "An impl"
|
|
169
|
+
}
|
|
170
|
+
]
|
|
135
171
|
},
|
|
136
172
|
"children": [
|
|
137
173
|
{
|
|
@@ -165,12 +201,12 @@
|
|
|
165
201
|
"type": {
|
|
166
202
|
"type": "reference",
|
|
167
203
|
"name": "Impl",
|
|
168
|
-
"
|
|
204
|
+
"target": 562
|
|
169
205
|
},
|
|
170
206
|
"implementationOf": {
|
|
171
207
|
"type": "reference",
|
|
172
208
|
"name": "Base.foo",
|
|
173
|
-
"
|
|
209
|
+
"target": 1142
|
|
174
210
|
}
|
|
175
211
|
}
|
|
176
212
|
],
|
|
@@ -184,7 +220,7 @@
|
|
|
184
220
|
"implementationOf": {
|
|
185
221
|
"type": "reference",
|
|
186
222
|
"name": "Base.foo",
|
|
187
|
-
"
|
|
223
|
+
"target": 1141
|
|
188
224
|
}
|
|
189
225
|
}
|
|
190
226
|
],
|
|
@@ -231,12 +267,12 @@
|
|
|
231
267
|
{
|
|
232
268
|
"type": "reference",
|
|
233
269
|
"name": "Base",
|
|
234
|
-
"
|
|
270
|
+
"target": 1139,
|
|
235
271
|
"typeArguments": [
|
|
236
272
|
{
|
|
237
273
|
"type": "reference",
|
|
238
274
|
"name": "Impl",
|
|
239
|
-
"
|
|
275
|
+
"target": 562
|
|
240
276
|
}
|
|
241
277
|
]
|
|
242
278
|
}
|
|
@@ -263,7 +299,7 @@
|
|
|
263
299
|
{
|
|
264
300
|
"id": 1561,
|
|
265
301
|
"name": "\"src/impl2.d\"",
|
|
266
|
-
"kind":
|
|
302
|
+
"kind": 2,
|
|
267
303
|
"kindString": "External module",
|
|
268
304
|
"flags": {
|
|
269
305
|
"isExported": true
|
|
@@ -278,7 +314,12 @@
|
|
|
278
314
|
"isExported": true
|
|
279
315
|
},
|
|
280
316
|
"comment": {
|
|
281
|
-
"
|
|
317
|
+
"summary": [
|
|
318
|
+
{
|
|
319
|
+
"kind": "text",
|
|
320
|
+
"text": "IMPL_COMMENT"
|
|
321
|
+
}
|
|
322
|
+
]
|
|
282
323
|
},
|
|
283
324
|
"children": [
|
|
284
325
|
{
|
|
@@ -297,8 +338,23 @@
|
|
|
297
338
|
"kindString": "Call signature",
|
|
298
339
|
"flags": {},
|
|
299
340
|
"comment": {
|
|
300
|
-
"
|
|
301
|
-
|
|
341
|
+
"summary": [
|
|
342
|
+
{
|
|
343
|
+
"kind": "text",
|
|
344
|
+
"text": "IMPL_SIG_DESC"
|
|
345
|
+
}
|
|
346
|
+
],
|
|
347
|
+
"blockTags": [
|
|
348
|
+
{
|
|
349
|
+
"tag": "@returns",
|
|
350
|
+
"content": [
|
|
351
|
+
{
|
|
352
|
+
"kind": "text",
|
|
353
|
+
"text": "The current instance to allow chaining.\n"
|
|
354
|
+
}
|
|
355
|
+
]
|
|
356
|
+
}
|
|
357
|
+
]
|
|
302
358
|
},
|
|
303
359
|
"parameters": [
|
|
304
360
|
{
|
|
@@ -308,7 +364,12 @@
|
|
|
308
364
|
"kindString": "Parameter",
|
|
309
365
|
"flags": {},
|
|
310
366
|
"comment": {
|
|
311
|
-
"
|
|
367
|
+
"summary": [
|
|
368
|
+
{
|
|
369
|
+
"kind": "text",
|
|
370
|
+
"text": "IMPL_PARAM_DESC"
|
|
371
|
+
}
|
|
372
|
+
]
|
|
312
373
|
},
|
|
313
374
|
"type": {
|
|
314
375
|
"type": "instrinct",
|
|
@@ -332,7 +393,7 @@
|
|
|
332
393
|
"implementationOf": {
|
|
333
394
|
"type": "reference",
|
|
334
395
|
"name": "Base.foo",
|
|
335
|
-
"
|
|
396
|
+
"target": 1141
|
|
336
397
|
}
|
|
337
398
|
}
|
|
338
399
|
],
|
|
@@ -379,12 +440,12 @@
|
|
|
379
440
|
{
|
|
380
441
|
"type": "reference",
|
|
381
442
|
"name": "Base",
|
|
382
|
-
"
|
|
443
|
+
"target": 1139,
|
|
383
444
|
"typeArguments": [
|
|
384
445
|
{
|
|
385
446
|
"type": "reference",
|
|
386
447
|
"name": "Impl",
|
|
387
|
-
"
|
|
448
|
+
"target": 1562
|
|
388
449
|
}
|
|
389
450
|
]
|
|
390
451
|
}
|
package/test/intersection.json
CHANGED
package/test/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"id": 0,
|
|
3
3
|
"name": "package-name",
|
|
4
|
-
|
|
4
|
+
"variant": "project",
|
|
5
|
+
"kind": 1,
|
|
5
6
|
"flags": {},
|
|
6
7
|
"children": [
|
|
7
8
|
{
|
|
8
9
|
"id": 68,
|
|
9
10
|
"name": "\"src/module1/foo.d\"",
|
|
10
|
-
"kind":
|
|
11
|
+
"kind": 2,
|
|
11
12
|
"kindString": "External module",
|
|
12
13
|
"flags": {
|
|
13
14
|
"isExported": true
|
|
@@ -49,7 +50,7 @@
|
|
|
49
50
|
"type": {
|
|
50
51
|
"type": "reference",
|
|
51
52
|
"name": "Foo",
|
|
52
|
-
"
|
|
53
|
+
"target": 69
|
|
53
54
|
}
|
|
54
55
|
}
|
|
55
56
|
],
|
|
@@ -82,7 +83,7 @@
|
|
|
82
83
|
{
|
|
83
84
|
"id": 561,
|
|
84
85
|
"name": "\"src/foo.d\"",
|
|
85
|
-
"kind":
|
|
86
|
+
"kind": 2,
|
|
86
87
|
"kindString": "External module",
|
|
87
88
|
"flags": {
|
|
88
89
|
"isExported": true
|
|
@@ -134,14 +135,14 @@
|
|
|
134
135
|
"type": {
|
|
135
136
|
"type": "reference",
|
|
136
137
|
"name": "Circle",
|
|
137
|
-
"
|
|
138
|
+
"target": 69
|
|
138
139
|
}
|
|
139
140
|
}
|
|
140
141
|
],
|
|
141
142
|
"type": {
|
|
142
143
|
"type": "reference",
|
|
143
144
|
"name": "Foo",
|
|
144
|
-
"
|
|
145
|
+
"target": 562
|
|
145
146
|
}
|
|
146
147
|
}
|
|
147
148
|
],
|
package/test/warning.js
CHANGED
|
@@ -15,12 +15,18 @@ describe('comment warnings', () => {
|
|
|
15
15
|
{
|
|
16
16
|
name: "Input"
|
|
17
17
|
}
|
|
18
|
+
],
|
|
19
|
+
sources: [
|
|
20
|
+
{
|
|
21
|
+
"fileName": "libs/foo.ts",
|
|
22
|
+
"line": 42
|
|
23
|
+
}
|
|
18
24
|
]
|
|
19
25
|
};
|
|
20
26
|
|
|
21
|
-
warn(member
|
|
27
|
+
warn(member);
|
|
22
28
|
|
|
23
|
-
expect(utils.warnings()[0]).toContain('Undocumented member foo');
|
|
29
|
+
expect(utils.warnings()[0]).toContain('Undocumented member \'foo\' libs/foo.ts:42');
|
|
24
30
|
});
|
|
25
31
|
|
|
26
32
|
it('should warn for Output property', () => {
|
|
@@ -30,12 +36,18 @@ describe('comment warnings', () => {
|
|
|
30
36
|
{
|
|
31
37
|
name: "Output"
|
|
32
38
|
}
|
|
39
|
+
],
|
|
40
|
+
sources: [
|
|
41
|
+
{
|
|
42
|
+
"fileName": "libs/foo.ts",
|
|
43
|
+
"line": 42
|
|
44
|
+
}
|
|
33
45
|
]
|
|
34
46
|
};
|
|
35
47
|
|
|
36
|
-
warn(member
|
|
48
|
+
warn(member);
|
|
37
49
|
|
|
38
|
-
expect(utils.warnings()[0]).toContain('Undocumented member foo');
|
|
50
|
+
expect(utils.warnings()[0]).toContain('Undocumented member \'foo\' libs/foo.ts:42');
|
|
39
51
|
});
|
|
40
52
|
|
|
41
53
|
it('should warn for Output property', () => {
|
|
@@ -45,12 +57,18 @@ describe('comment warnings', () => {
|
|
|
45
57
|
{
|
|
46
58
|
name: "Output"
|
|
47
59
|
}
|
|
60
|
+
],
|
|
61
|
+
sources: [
|
|
62
|
+
{
|
|
63
|
+
"fileName": "libs/foo.ts",
|
|
64
|
+
"line": 42
|
|
65
|
+
}
|
|
48
66
|
]
|
|
49
67
|
};
|
|
50
68
|
|
|
51
|
-
warn(member
|
|
69
|
+
warn(member);
|
|
52
70
|
|
|
53
|
-
expect(utils.warnings()[0]).toContain('Undocumented member foo');
|
|
71
|
+
expect(utils.warnings()[0]).toContain('Undocumented member \'foo\' libs/foo.ts:42');
|
|
54
72
|
});
|
|
55
73
|
|
|
56
74
|
it('should not warn for fields without decorators', () => {
|
|
@@ -58,7 +76,7 @@ describe('comment warnings', () => {
|
|
|
58
76
|
name: "foo"
|
|
59
77
|
};
|
|
60
78
|
|
|
61
|
-
warn(member
|
|
79
|
+
warn(member);
|
|
62
80
|
|
|
63
81
|
expect(utils.warnings().length).toEqual(0);
|
|
64
82
|
});
|
|
@@ -73,7 +91,7 @@ describe('comment warnings', () => {
|
|
|
73
91
|
]
|
|
74
92
|
};
|
|
75
93
|
|
|
76
|
-
warn(member
|
|
94
|
+
warn(member);
|
|
77
95
|
|
|
78
96
|
expect(utils.warnings().length).toEqual(0);
|
|
79
97
|
});
|
|
@@ -83,7 +101,7 @@ describe('comment warnings', () => {
|
|
|
83
101
|
name: "__namedParameters"
|
|
84
102
|
};
|
|
85
103
|
|
|
86
|
-
warn(member
|
|
104
|
+
warn(member);
|
|
87
105
|
|
|
88
106
|
expect(utils.warnings().length).toEqual(0);
|
|
89
107
|
});
|