UNPKG

20.5 kBJSONView Raw
1{
2 "name": "@microsoft/tsdoc",
3 "entries": [
4 {
5 "version": "0.13.1",
6 "tag": "@microsoft/tsdoc_v0.13.1",
7 "date": "Mon, 19 Apr 2021 21:22:32 GMT",
8 "comments": {
9 "patch": [
10 {
11 "comment": "Add a new TSDocMessageId definition used by @microsoft/tsdoc-config"
12 }
13 ]
14 }
15 },
16 {
17 "version": "0.13.0",
18 "tag": "@microsoft/tsdoc_v0.13.0",
19 "date": "Fri, 22 Jan 2021 18:07:19 GMT",
20 "comments": {
21 "patch": [
22 {
23 "comment": "Update doc comments to fix some syntax issues"
24 }
25 ],
26 "minor": [
27 {
28 "comment": "Update tsdoc.json schema to add a new field \"noStandardTags\""
29 },
30 {
31 "comment": "Add new APIs: TSDocConfiguration.clear() and TSDocTagDefinition.validateTSDocTagName()"
32 },
33 {
34 "comment": "Add new \"supportForTags\" field to tsdoc.json schema"
35 }
36 ]
37 }
38 },
39 {
40 "version": "0.12.24",
41 "tag": "@microsoft/tsdoc_v0.12.24",
42 "date": "Thu, 03 Dec 2020 08:07:55 GMT",
43 "comments": {
44 "patch": [
45 {
46 "comment": "Add a missing declaration file"
47 }
48 ]
49 }
50 },
51 {
52 "version": "0.12.23",
53 "tag": "@microsoft/tsdoc_v0.12.23",
54 "date": "Thu, 03 Dec 2020 04:31:52 GMT",
55 "comments": {
56 "patch": [
57 {
58 "comment": "Add a definition for the `@decorator` block tag (RFC 271)"
59 }
60 ]
61 }
62 },
63 {
64 "version": "0.12.22",
65 "tag": "@microsoft/tsdoc_v0.12.22",
66 "date": "Mon, 30 Nov 2020 06:16:21 GMT",
67 "comments": {
68 "patch": [
69 {
70 "comment": "Update documentation to reference the new website URL"
71 },
72 {
73 "comment": "Upgrade build tools and configuration"
74 },
75 {
76 "comment": "Fix typo"
77 }
78 ]
79 }
80 },
81 {
82 "version": "0.12.21",
83 "tag": "@microsoft/tsdoc_v0.12.21",
84 "date": "Fri, 04 Sep 2020 15:53:27 GMT",
85 "comments": {
86 "patch": [
87 {
88 "comment": "Fix an issue where the line extractor's trailing whitespace trimming sometimes trimmed a non-whitespace character (GitHub #258)"
89 },
90 {
91 "comment": "Update build system"
92 }
93 ]
94 }
95 },
96 {
97 "version": "0.12.20",
98 "tag": "@microsoft/tsdoc_v0.12.20",
99 "date": "Wed, 20 May 2020 22:33:27 GMT",
100 "comments": {
101 "patch": [
102 {
103 "comment": "Add support for `@see` tag"
104 },
105 {
106 "comment": "Improve documentation for `@inheritDoc`"
107 }
108 ]
109 }
110 },
111 {
112 "version": "0.12.19",
113 "tag": "@microsoft/tsdoc_v0.12.19",
114 "date": "Fri, 27 Mar 2020 23:14:53 GMT",
115 "comments": {
116 "patch": [
117 {
118 "comment": "Add some missing entries to TSDocConfiguration.allTsdocMessageIds() which were breaking eslint-plugin-tsdoc"
119 },
120 {
121 "comment": "Fix an issue where \"h1\" was not allowed as an HTML element name"
122 }
123 ]
124 }
125 },
126 {
127 "version": "0.12.18",
128 "tag": "@microsoft/tsdoc_v0.12.18",
129 "date": "Sat, 22 Feb 2020 20:44:16 GMT",
130 "comments": {
131 "patch": [
132 {
133 "comment": "Fix an issue where JSDoc optional params were not parsed correctly"
134 }
135 ]
136 }
137 },
138 {
139 "version": "0.12.17",
140 "tag": "@microsoft/tsdoc_v0.12.17",
141 "date": "Sat, 22 Feb 2020 02:55:07 GMT",
142 "comments": {
143 "patch": [
144 {
145 "comment": "Improve the parsing of `@param` and `@typeParam` tags to recognize legacy syntaxes"
146 }
147 ]
148 }
149 },
150 {
151 "version": "0.12.16",
152 "tag": "@microsoft/tsdoc_v0.12.16",
153 "date": "Tue, 19 Nov 2019 22:01:56 GMT",
154 "comments": {
155 "patch": [
156 {
157 "comment": "Add some new TSDocMessageId definitions used by @microsoft/tsdoc-config"
158 }
159 ]
160 }
161 },
162 {
163 "version": "0.12.15",
164 "tag": "@microsoft/tsdoc_v0.12.15",
165 "date": "Sat, 09 Nov 2019 05:55:42 GMT",
166 "comments": {
167 "patch": [
168 {
169 "comment": "Add new API TSDocConfiguration.allTsdocMessageIds"
170 }
171 ]
172 }
173 },
174 {
175 "version": "0.12.14",
176 "tag": "@microsoft/tsdoc_v0.12.14",
177 "date": "Wed, 04 Sep 2019 03:30:10 GMT",
178 "comments": {
179 "patch": [
180 {
181 "comment": "Fix a regression where some API signatures were incompatible with TypeScript versions prior to 3.4"
182 }
183 ]
184 }
185 },
186 {
187 "version": "0.12.13",
188 "tag": "@microsoft/tsdoc_v0.12.13",
189 "date": "Fri, 30 Aug 2019 18:38:59 GMT",
190 "comments": {
191 "patch": [
192 {
193 "comment": "Fix an invalid regular expression."
194 }
195 ]
196 }
197 },
198 {
199 "version": "0.12.12",
200 "tag": "@microsoft/tsdoc_v0.12.12",
201 "date": "Wed, 07 Aug 2019 23:06:02 GMT",
202 "comments": {
203 "patch": [
204 {
205 "comment": "Improve DeclarationReference.parse for module sources"
206 },
207 {
208 "comment": "Add a definition for the `@throws` block tag (RFC 171)"
209 }
210 ]
211 }
212 },
213 {
214 "version": "0.12.11",
215 "tag": "@microsoft/tsdoc_v0.12.11",
216 "date": "Wed, 24 Jul 2019 00:38:18 GMT",
217 "comments": {
218 "patch": [
219 {
220 "comment": "Add new meanings to DeclarationReference and fix some parsing bugs"
221 }
222 ]
223 }
224 },
225 {
226 "version": "0.12.10",
227 "tag": "@microsoft/tsdoc_v0.12.10",
228 "date": "Fri, 19 Jul 2019 02:47:09 GMT",
229 "comments": {
230 "patch": [
231 {
232 "comment": "Add beta implementation of new DeclarationReference API"
233 }
234 ]
235 }
236 },
237 {
238 "version": "0.12.9",
239 "tag": "@microsoft/tsdoc_v0.12.9",
240 "date": "Thu, 11 Apr 2019 03:58:35 GMT",
241 "comments": {
242 "patch": [
243 {
244 "comment": "Improve the wording of the error messages involving character sequences that look like TSDoc tags"
245 }
246 ]
247 }
248 },
249 {
250 "version": "0.12.8",
251 "tag": "@microsoft/tsdoc_v0.12.8",
252 "date": "Tue, 12 Mar 2019 23:18:11 GMT",
253 "comments": {
254 "patch": [
255 {
256 "comment": "Fix an issue where tsdoc-param-tag-with-invalid-name was sometimes incorrectly reported certain identifiers (issue #148)"
257 }
258 ]
259 }
260 },
261 {
262 "version": "0.12.7",
263 "tag": "@microsoft/tsdoc_v0.12.7",
264 "date": "Fri, 01 Mar 2019 06:39:52 GMT",
265 "comments": {
266 "patch": [
267 {
268 "comment": "Add new API TSDocConfiguration.isKnownMessageId()"
269 }
270 ]
271 }
272 },
273 {
274 "version": "0.12.6",
275 "tag": "@microsoft/tsdoc_v0.12.6",
276 "date": "Thu, 28 Feb 2019 01:29:39 GMT",
277 "comments": {
278 "patch": [
279 {
280 "comment": "Add a new API ParserMessage.messageId with a unique ID useful for filtering and searching for errors"
281 }
282 ]
283 }
284 },
285 {
286 "version": "0.12.5",
287 "tag": "@microsoft/tsdoc_v0.12.5",
288 "date": "Tue, 29 Jan 2019 22:49:58 GMT",
289 "comments": {
290 "patch": [
291 {
292 "comment": "Update parser to allow `$` character in `@param` names, since ECMAScript allows this in unquoted identifiers"
293 },
294 {
295 "comment": "Allow `$` character in declaration reference member identifiers (Example: `{@link Button.$render}`)"
296 }
297 ]
298 }
299 },
300 {
301 "version": "0.12.4",
302 "tag": "@microsoft/tsdoc_v0.12.4",
303 "date": "Tue, 20 Nov 2018 21:23:06 GMT",
304 "comments": {
305 "patch": [
306 {
307 "comment": "Add new interface `IStringBuilder`"
308 }
309 ]
310 }
311 },
312 {
313 "version": "0.12.3",
314 "tag": "@microsoft/tsdoc_v0.12.3",
315 "date": "Tue, 20 Nov 2018 07:42:17 GMT",
316 "comments": {
317 "patch": [
318 {
319 "comment": "Add a new API `PlainTextEmitter.hasAnyTextContent()`"
320 }
321 ]
322 }
323 },
324 {
325 "version": "0.12.2",
326 "tag": "@microsoft/tsdoc_v0.12.2",
327 "date": "Fri, 09 Nov 2018 15:13:13 GMT",
328 "comments": {
329 "patch": [
330 {
331 "comment": "Improve trimming of spacing for link text in `{@link}` tags"
332 }
333 ]
334 }
335 },
336 {
337 "version": "0.12.1",
338 "tag": "@microsoft/tsdoc_v0.12.1",
339 "date": "Tue, 06 Nov 2018 01:37:22 GMT",
340 "comments": {
341 "patch": [
342 {
343 "comment": "Allow HTML in a `DocSection` node"
344 },
345 {
346 "comment": "Fix a bug where `TSDocEmitter.renderHtmlTag()` and `TSDocEmitter.renderDeclarationReference()` were including comment framing"
347 },
348 {
349 "comment": "Add `DocSection.appendNodesInParagraph()` API"
350 }
351 ]
352 }
353 },
354 {
355 "version": "0.12.0",
356 "tag": "@microsoft/tsdoc_v0.12.0",
357 "date": "Sat, 03 Nov 2018 02:07:10 GMT",
358 "comments": {
359 "patch": [
360 {
361 "comment": "Add `DocDeclarationReference.emitAsTsdoc()`, `DocHtmlStartTag.emitAsHtml()`, and `DocHtmlEndTag.emitAsHtml()`"
362 },
363 {
364 "comment": "Child nodes can now be specified as a second constructor parameter for `DocNodeContainer`"
365 }
366 ],
367 "minor": [
368 {
369 "comment": "(API change) `DocErrorText` is no longer allowed in `DocSection`; instead it must be part of a `DocParagraph`"
370 },
371 {
372 "comment": "(API change) Rename `TSDocParserConfiguration` to `TSDocConfiguration`"
373 },
374 {
375 "comment": "(API change) Require an associated `TSDocConfiguration` to be included with the parameters for every `DocNode` constructor"
376 },
377 {
378 "comment": "Introduce `TSDocConfiguration.docNodeManager` for registering custom `DocNode` subclasses and their container relationships"
379 }
380 ]
381 }
382 },
383 {
384 "version": "0.11.0",
385 "tag": "@microsoft/tsdoc_v0.11.0",
386 "date": "Sat, 27 Oct 2018 04:52:23 GMT",
387 "comments": {
388 "minor": [
389 {
390 "comment": "(API change) Introduce `DocParamCollection` to enable efficient lookups of parameters by name"
391 },
392 {
393 "comment": "(API change) Rename `DocComment.typeParamBlocks` --> `DocComment.typeParams`"
394 },
395 {
396 "comment": "(API change) Rename `DocComment.paramBlocks` --> `DocComment.params`"
397 }
398 ]
399 }
400 },
401 {
402 "version": "0.10.0",
403 "tag": "@microsoft/tsdoc_v0.10.0",
404 "date": "Fri, 26 Oct 2018 08:42:51 GMT",
405 "comments": {
406 "minor": [
407 {
408 "comment": "Add new APIs `DocComment.emitAsTsdoc()`, `TSDocEmitter`, and `StringBuilder`"
409 }
410 ]
411 }
412 },
413 {
414 "version": "0.9.3",
415 "tag": "@microsoft/tsdoc_v0.9.3",
416 "date": "Thu, 25 Oct 2018 08:29:36 GMT",
417 "comments": {
418 "patch": [
419 {
420 "comment": "Fix issue where `DocErrorText.text` returned `[object Object]` instead of the text"
421 }
422 ]
423 }
424 },
425 {
426 "version": "0.9.2",
427 "tag": "@microsoft/tsdoc_v0.9.2",
428 "date": "Wed, 17 Oct 2018 13:41:54 GMT",
429 "comments": {
430 "patch": [
431 {
432 "comment": "Fix stack overflow in DocFencedCode.language property getter"
433 }
434 ]
435 }
436 },
437 {
438 "version": "0.9.1",
439 "tag": "@microsoft/tsdoc_v0.9.1",
440 "date": "Wed, 17 Oct 2018 12:49:01 GMT",
441 "comments": {
442 "patch": [
443 {
444 "comment": "Fix a regression where the paragraph splitter was sometimes skipping blocks"
445 }
446 ]
447 }
448 },
449 {
450 "version": "0.9.0",
451 "tag": "@microsoft/tsdoc_v0.9.0",
452 "date": "Wed, 17 Oct 2018 04:47:19 GMT",
453 "comments": {
454 "minor": [
455 {
456 "comment": "(API change) Change `DocBlock` to have a `DocSection` property rather than inheriting from `DocSection`; this eliminates confusion about which nodes belong to the container"
457 },
458 {
459 "comment": "(API change) Rename `DocParticle` to `DocExcerpt`, and eliminate the `Excerpt` class"
460 },
461 {
462 "comment": "(API change) Eliminate `DocNodeLeaf`, since now `DocExcerpt` is the only class that can represent excerpts"
463 },
464 {
465 "comment": "(API change) Remove `DocNode.updateParameters()` because it is no longer needed"
466 },
467 {
468 "comment": "(API change) Spacing is now represented as a normal `DocExcerpt`, rather than via a special `Excerpt.spacingAfterContent`"
469 },
470 {
471 "comment": "(API change) Simplify `DocNodeTransforms.trimSpacesInParagraph()` to no longer merge/remap excerpts during the transformation. If we need this information, we will track it differently."
472 }
473 ]
474 }
475 },
476 {
477 "version": "0.8.1",
478 "tag": "@microsoft/api-extractor_v0.8.1",
479 "date": "Sun, 07 Oct 2018 06:30:34 GMT",
480 "comments": {
481 "patch": [
482 {
483 "comment": "Improve error reporting for declaration references that are probably missing a `\"#\"` delimiter"
484 },
485 {
486 "comment": "Rename `DocCodeFence` to `DocFencedCode`"
487 }
488 ]
489 }
490 },
491 {
492 "version": "0.8.0",
493 "tag": "@microsoft/api-extractor_v0.8.0",
494 "date": "Wed, 03 Oct 2018 02:43:47 GMT",
495 "comments": {
496 "minor": [
497 {
498 "comment": "Introduce a distinction between \"defined\" tags (i.e. recognized) versus \"supported\" tags (i.e. implemented by the tool)"
499 },
500 {
501 "comment": "The parser optionally reports usage of undefined tags"
502 },
503 {
504 "comment": "The parser optionally reports usage of unsupported tags"
505 },
506 {
507 "comment": "The parser reports usage of inline/block syntax that is inconsistent with the tag definition"
508 },
509 {
510 "comment": "Code spans are now allowed to be adjacent to other text, but must contain at least one character"
511 },
512 {
513 "comment": "An `@deprecated` block must contain a deprecation message"
514 },
515 {
516 "comment": "If `@inheritDoc` is used, then the summary section must be empty, and there must not be an `@remarks` block"
517 }
518 ]
519 }
520 },
521 {
522 "version": "0.7.0",
523 "tag": "@microsoft/api-extractor_v0.7.0",
524 "date": "Tue, 02 Oct 2018 02:35:35 GMT",
525 "comments": {
526 "minor": [
527 {
528 "comment": "Add support for `@defaultValue` tag"
529 },
530 {
531 "comment": "Add support for `@typeParam` tag"
532 }
533 ]
534 }
535 },
536 {
537 "version": "0.6.0",
538 "tag": "@microsoft/api-extractor_v0.6.0",
539 "date": "Mon, 01 Oct 2018 22:11:24 GMT",
540 "comments": {
541 "minor": [
542 {
543 "comment": "Add support for `@link` tags using the new declaration reference syntax"
544 },
545 {
546 "comment": "Add support for `@inheritDoc` tags"
547 },
548 {
549 "comment": "Add new APIs: `DocDeclarationReference`, `DocInheritDocTag`, `DocLinkTag`, `DocMemberIdentifier`, `DocMemberReference`, `DocMemberSelector`, `DocMemberSymbol`"
550 },
551 {
552 "comment": "Remove `ParserContext.verbatimNodes`"
553 },
554 {
555 "comment": "Add `DocParticle.particleId` property"
556 }
557 ]
558 }
559 },
560 {
561 "version": "0.5.0",
562 "tag": "@microsoft/api-extractor_v0.5.0",
563 "date": "Tue, 25 Sep 2018 03:04:06 GMT",
564 "comments": {
565 "minor": [
566 {
567 "comment": "Add a new API `DocNode.updateParameters()` that allows a `DocNode` object to be updated after it was created; the tree nodes are no longer immutable"
568 },
569 {
570 "comment": "Add `DocNodeTransforms.trimSpacesInParagraphNodes()` for collapsing whitespace inside `DocParagraph` subtrees"
571 },
572 {
573 "comment": "Extract the `DocNode.excerpt` property into a new abstract base class `DocNodeLeaf`"
574 }
575 ]
576 }
577 },
578 {
579 "version": "0.4.1",
580 "tag": "@microsoft/api-extractor_v0.4.1",
581 "date": "Fri, 31 Aug 2018 03:32:18 GMT",
582 "comments": {
583 "patch": [
584 {
585 "comment": "Improve the error location reporting for DocErrorText objects"
586 },
587 {
588 "comment": "Separate the **api-demo** sample into a \"simple\" scenario which parses a simple text string, and an \"advanced\" scenario which uses the TypeScript compiler API to extract comments and parse custom TSDoc tags"
589 }
590 ]
591 }
592 },
593 {
594 "version": "0.4.0",
595 "tag": "@microsoft/api-extractor_v0.4.0",
596 "date": "Tue, 28 Aug 2018 03:17:20 GMT",
597 "comments": {
598 "minor": [
599 {
600 "comment": "Rename `DocCodeSpan.text` to `DocCodeSpan.code` and model the delimiters using particles"
601 },
602 {
603 "comment": "Add support for code fences (`DocCodeFence`)"
604 },
605 {
606 "comment": "`DocSection` content is now grouped into `DocParagraph` nodes; blank lines are used to indicate paragraph boundaries"
607 },
608 {
609 "comment": "Rename `DocComment.deprecated` to `deprecatedBlock`"
610 }
611 ]
612 }
613 },
614 {
615 "version": "0.3.0",
616 "tag": "@microsoft/api-extractor_v0.3.0",
617 "date": "Sat, 25 Aug 2018 05:53:56 GMT",
618 "comments": {
619 "minor": [
620 {
621 "comment": "Add TextRange.isEmpty()"
622 },
623 {
624 "comment": "Improve the ModifierTagSet API"
625 },
626 {
627 "comment": "Implement the @privateRemarks and @deprecated tags"
628 }
629 ]
630 }
631 },
632 {
633 "version": "0.2.0",
634 "tag": "@microsoft/api-extractor_v0.2.0",
635 "date": "Fri, 24 Aug 2018 01:19:56 GMT",
636 "comments": {
637 "minor": [
638 {
639 "comment": "Rename `CoreTags` to `StandardTags` so we can include non-core tags in the standard definitions"
640 },
641 {
642 "comment": "Rename `CoreModifierTagSet` to `StandardModifierTagSet` and convert properties to functions"
643 },
644 {
645 "comment": "Categorize the standard tags according to a `Standardization` enum, and document them"
646 },
647 {
648 "comment": "Add more standard tag definitions: `@deprecated`, `@eventProperty`, `@example`, `@inheritDoc`, `@link`, `@override`, `@packageDocumentation`, `@public`, `@privateRemarks`, `@sealed`, `@virtual`"
649 },
650 {
651 "comment": "Replace TSDocTagDefinition.singleton with TSDocTagDefinition.allowMultiple, since in practice most tags are single-usage"
652 }
653 ]
654 }
655 },
656 {
657 "version": "0.1.0",
658 "tag": "@microsoft/api-extractor_v0.1.0",
659 "date": "Thu, 16 Aug 2018 18:18:02 GMT",
660 "comments": {
661 "minor": [
662 {
663 "comment": "Initial release of the TSDoc library! :-)"
664 }
665 ]
666 }
667 }
668 ]
669}