1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
use swc_atoms::JsWord;
use swc_common::{ast_node, Span};

/// Spanned text
#[ast_node]
#[derive(Eq)]
pub struct Text {
    pub span: Span,
    pub value: JsWord,
}

#[ast_node]
pub struct JsDoc {
    pub span: Span,

    pub description: Text,
    pub tags: Vec<TagItem>,
}

///  tag with comments.
#[ast_node]
pub struct TagItem {
    pub span: Span,
    #[serde(rename = "tagName")]
    pub tag_name: Text,
    #[serde(flatten)]
    pub tag: Tag,
}

#[ast_node]
#[non_exhaustive]
pub enum Tag {
    #[tag("Yield")]
    Yield(YieldTag),
    #[tag("TypeDef")]
    TypeDef(TypeDefTag),
    #[tag("Throw")]
    Throw(ThrowTag),
    #[tag("Todo")]
    Todo(TodoTag),
    #[tag("Tutorial")]
    Tutorial(TutorialTag),
    #[tag("Static")]
    Static(StaticTag),
    #[tag("Summary")]
    Summary(SummaryTag),
    #[tag("See")]
    See(SeeTag),
    #[tag("Since")]
    Since(SinceTag),
    #[tag("Requires")]
    Requires(RequiresTag),
    #[tag("Override")]
    Override(OverrideTag),
    #[tag("Package")]
    Package(PackageTag),
    #[tag("Module")]
    Module(ModuleTag),
    #[tag("Name")]
    Name(NameTag),
    #[tag("Namespace")]
    Namespace(NamespaceTag),
    #[tag("Variation")]
    Variation(VariationTag),
    #[tag("Version")]
    Version(VersionTag),
    #[tag("MemberOf")]
    MemberOf(MemberOfTag),
    #[tag("Mixes")]
    Mixes(MixesTag),
    #[tag("Mixin")]
    Mixin(MixinTag),
    #[tag("Member")]
    Member(MemberTag),
    #[tag("Listens")]
    Listens(ListensTag),
    #[tag("License")]
    License(LicenseTag),
    #[tag("Kind")]
    Kind(KindTag),
    #[tag("Lends")]
    Lends(LendsTag),
    #[tag("Instance")]
    Instance(InstanceTag),
    #[tag("Interface")]
    Interface(InterfaceTag),
    #[tag("Inner")]
    Inner(InnerTag),
    #[tag("InheritDoc")]
    InheritDoc(InheritDocTag),
    #[tag("IgnoreTag")]
    Ignore(IgnoreTag),
    #[tag("HideConstructorTag")]
    HideConstructor(HideConstructorTag),
    #[tag("GeneratorTag")]
    Generator(GeneratorTag),
    #[tag("FunctionTag")]
    Function(FunctionTag),
    #[tag("FilelTag")]
    File(FilelTag),
    #[tag("ConstructsTag")]
    Constructs(ConstructsTag),
    #[tag("CopyrightTag")]
    Copyright(CopyrightTag),
    #[tag("AbstractTag")]
    Abstract(AbstractTag),
    #[tag("AccessTag")]
    Access(AccessTag),
    #[tag("AliasTag")]
    Alias(AliasTag),
    #[tag("AsyncTag")]
    Async(AsyncTag),
    #[tag("UnknownTag")]
    Unknown(UnknownTag),
    #[tag("AugmentsTag")]
    Augments(AugmentsTag),
    #[tag("ImplementsTag")]
    Implements(ImplementsTag),
    #[tag("AuthorTag")]
    Author(AuthorTag),
    #[tag("BorrowsTag")]
    Borrows(BorrowsTag),
    #[tag("ClassTag")]
    Class(ClassTag),
    #[tag("JSDocClassDescTag")]
    ClassDesc(JSDocClassDescTag),
    #[tag("ConstTag")]
    Const(ConstTag),
    #[tag("PublicTag")]
    Public(PublicTag),
    #[tag("PrivateTag")]
    Private(PrivateTag),
    #[tag("ProtectedTag")]
    Protected(ProtectedTag),
    #[tag("ReadonlyTag")]
    Readonly(ReadonlyTag),
    #[tag("CallbackTag")]
    Callback(CallbackTag),
    #[tag("EnumTag")]
    Enum(EnumTag),
    #[tag("ParameterTag")]
    Parameter(ParameterTag),
    #[tag("ReturnTag")]
    Return(ReturnTag),
    #[tag("ThisTag")]
    This(ThisTag),
    #[tag("TypeTag")]
    Type(TypeTag),
    #[tag("TemplateTag")]
    Template(TemplateTag),
    #[tag("TypedefTag")]
    Typedef(TypedefTag),
    #[tag("PropertyTag")]
    Property(PropertyTag),
    #[tag("DescriptionTag")]
    Description(DescriptionTag),
    #[tag("ExampleTag")]
    Example(ExampleTag),
    #[tag("ExportsTag")]
    Exports(ExportsTag),
    #[tag("ExternalTag")]
    External(ExternalTag),
    #[tag("DefaultTag")]
    Default(DefaultTag),
    #[tag("DeprecatedTag")]
    Deprecated(DeprecatedTag),
}

#[ast_node]
pub struct AbstractTag {
    pub span: Span,
}

#[ast_node]
pub struct AccessTag {
    pub span: Span,
    pub access: Text,
}

#[ast_node]
pub struct AliasTag {
    pub span: Span,
    pub name_path: NamePath,
}

#[ast_node]
pub struct AsyncTag {
    pub span: Span,
}

#[ast_node]
pub struct BorrowsTag {
    pub span: Span,
    pub from: NamePath,
    pub to: NamePath,
}

#[ast_node]
pub struct JSDocClassDescTag {
    pub span: Span,
    pub desc: Text,
}

#[ast_node]
pub struct ConstTag {
    pub span: Span,
    pub ty: Option<Text>,
    pub name: Option<Text>,
}

#[ast_node]
pub struct UnknownTag {
    pub span: Span,
    pub extras: Text,
}

/// `@extends`, `@augments`
#[ast_node]
pub struct AugmentsTag {
    pub span: Span,
    pub class: NamePath,
}

#[ast_node]
pub struct ImplementsTag {
    pub span: Span,
    pub class: Text,
}

#[ast_node]
pub struct ExprWithTypeArgs {
    pub span: Span,

    // TODO parent: HeritageClause | JSDocAugmentsTag | JSDocImplementsTag;
    pub expr: Box<Expr>,
}

#[ast_node]
pub enum Expr {
    #[tag("Identifier")]
    Text(Text),
    #[tag("NamePath")]
    Property(NamePath),
}

#[ast_node]
pub struct AuthorTag {
    pub span: Span,
    /// `<name> [<emailAddress>]`
    pub author: Text,
}

#[ast_node]
#[derive(Eq)]
pub struct ClassTag {
    pub span: Span,
    pub ty: Option<Text>,
    pub name: Option<Text>,
}

#[ast_node]
#[derive(Eq)]
pub struct PublicTag {
    pub span: Span,
}

#[ast_node]
#[derive(Eq)]
pub struct PrivateTag {
    pub span: Span,
    pub ty: Option<Text>,
}

#[ast_node]
#[derive(Eq)]
pub struct ProtectedTag {
    pub span: Span,
    pub ty: Option<Text>,
}

#[ast_node]
#[derive(Eq)]
pub struct ReadonlyTag {
    pub span: Span,
}

#[ast_node]
pub struct CallbackTag {
    pub span: Span,
    pub name_path: NamePath,
}

#[ast_node]
pub struct PropertyTag {
    pub span: Span,

    pub name_path: NamePath,
    pub ty: Option<Text>,
    pub desc: Text,
}

#[ast_node]
pub struct ParameterTag {
    pub span: Span,

    pub name: Option<Text>,
    #[serde(rename = "typeExpression")]
    pub ty: Option<Text>,

    pub desc: Text,
}

#[ast_node]
#[derive(Eq)]
pub struct EnumTag {
    pub span: Span,
    pub ty: Text,
}

#[ast_node]
pub struct ReturnTag {
    pub span: Span,
    pub ty: Option<Text>,
    pub description: Text,
}

#[ast_node]
pub struct ThisTag {
    pub span: Span,
    pub name_path: NamePath,
}

#[ast_node]
pub struct TypeTag {
    pub span: Span,
    pub name: Text,
}

#[ast_node]
pub struct TemplateTag {
    pub span: Span,
    pub constraint: Option<TypeExpr>,
}

#[ast_node]
pub struct TypedefTag {
    pub span: Span,
    #[serde(rename = "full_name")]
    pub full_name: Option<NamespaceBody>,

    pub name: Option<Text>,
    #[serde(rename = "typeExpression")]
    pub type_expr: Option<TypeExprOrTypeLit>,
}

#[ast_node]
pub enum Type {
    /// `*`
    #[tag("AllType")]
    All(AllType),
    /// `?`
    #[tag("UnknownType")]
    Unknown(UnknownType),
    #[tag("NullableType")]
    Nullable(NullableType),
    #[tag("NonNullableType")]
    NonNullable(NonNullableType),
    #[tag("OptionalType")]
    Optional(OptionalType),
    #[tag("FunctionType")]
    Function(FunctionType),
    #[tag("VariadicType")]
    Variadic(VariadicType),
    // https://jsdoc.app/about-namepaths.html
    #[tag("NamePathType")]
    NamePath(NamePathType),
    #[tag("UnionType")]
    Union(UnionType),
    #[tag("ParenType")]
    Paren(ParenType),
}

#[ast_node]
pub struct UnionType {
    pub span: Span,
    pub types: Vec<Type>,
}

#[ast_node]
pub struct ParenType {
    pub span: Span,
    pub ty: Box<Type>,
}

#[ast_node]
#[derive(Eq)]
pub struct AllType {
    pub span: Span,
}

#[ast_node]
#[derive(Eq)]
pub struct UnknownType {
    pub span: Span,
}

#[ast_node]
pub struct NullableType {
    pub span: Span,
    pub ty: Box<Type>,
}

#[ast_node]
pub struct NonNullableType {
    pub span: Span,
    pub ty: Box<Type>,
}

#[ast_node]
pub struct OptionalType {
    pub span: Span,
    pub ty: Box<Type>,
}

/// TODO: Add fields
#[ast_node]
pub struct FunctionType {
    pub span: Span,
    pub ty: Box<Type>,
}

#[ast_node]
pub struct VariadicType {
    pub span: Span,
    pub ty: Box<Type>,
}

#[ast_node]
pub struct NamePathType {
    pub span: Span,
    pub ty: Box<Type>,
}

/// represents a top level: { type } expression in a JSDoc comment.
#[ast_node]
pub struct TypeExpr {
    pub span: Span,
    pub ty: Type,
}

#[ast_node]
pub struct NamespaceDecl {
    pub span: Span,
    pub name: Text,
    pub body: Vec<NamespaceBody>,
}

#[ast_node]
pub enum NamespaceBody {
    #[tag("Identifier")]
    Text(Box<Text>),
    #[tag("NamespaceDecl")]
    Decl(Box<NamespaceDecl>),
}

#[ast_node]
pub enum TypeExprOrTypeLit {
    #[tag("TypeExpr")]
    Expr(Box<TypeExpr>),
    #[tag("TypeLit")]
    TypeLit(Box<TypeLit>),
}

#[ast_node]
pub struct TypeLit {
    pub span: Span,
    pub tags: Vec<PropOrParam>,
    /// If true, then this type literal represents an *array* of its type.
    pub is_array_type: bool,
}

#[ast_node]
pub enum PropOrParam {
    #[tag("PropertyTag")]
    Prop(PropertyTag),
    #[tag("ParameterTag")]
    Param(ParameterTag),
}

#[ast_node]
pub struct NamePath {
    pub span: Span,
    pub components: Vec<Text>,
}

#[ast_node]
pub struct CopyrightTag {
    pub span: Span,
    pub text: Text,
}

#[ast_node]
pub struct DescriptionTag {
    pub span: Span,
    pub text: Text,
}

#[ast_node]
pub struct ExampleTag {
    pub span: Span,
    pub text: Text,
}

#[ast_node]
pub struct ExportsTag {
    pub span: Span,
    pub module_name: Text,
}

#[ast_node]
pub struct ExternalTag {
    pub span: Span,
    pub name: Text,
}

#[ast_node]
pub struct ConstructsTag {
    pub span: Span,
    pub name: Text,
}

#[ast_node]
pub struct DefaultTag {
    pub span: Span,
    pub value: Text,
}

#[ast_node]
pub struct DeprecatedTag {
    pub span: Span,
    pub text: Text,
}

#[ast_node]
pub struct FilelTag {
    pub span: Span,
    pub text: Text,
}

#[ast_node]
pub struct FunctionTag {
    pub span: Span,
    pub name: Option<Text>,
}

#[ast_node]
pub struct GeneratorTag {
    pub span: Span,
}
#[ast_node]
pub struct HideConstructorTag {
    pub span: Span,
}

#[ast_node]
pub struct IgnoreTag {
    pub span: Span,
}

#[ast_node]
pub struct InheritDocTag {
    pub span: Span,
}

#[ast_node]
pub struct InnerTag {
    pub span: Span,
}

#[ast_node]
pub struct InstanceTag {
    pub span: Span,
}

#[ast_node]
pub struct InterfaceTag {
    pub span: Span,
    pub name: Option<Text>,
}
#[ast_node]
pub struct KindTag {
    pub span: Span,
    pub name: Text,
}

#[ast_node]
pub struct LendsTag {
    pub span: Span,
    pub name: NamePath,
}

#[ast_node]
pub struct LicenseTag {
    pub span: Span,
    pub identifier: Text,
}

#[ast_node]
pub struct ListensTag {
    pub span: Span,
    pub event_name: Text,
}

#[ast_node]
pub struct MemberTag {
    pub span: Span,
    pub ty: Text,
    pub name: Text,
}

#[ast_node]
pub struct MemberOfTag {
    pub span: Span,
    pub parent_name_path: NamePath,
}

#[ast_node]
pub struct TypeDefTag {
    pub span: Span,
    pub ty: Option<Text>,
    pub name_path: NamePath,
}

#[ast_node]
pub struct MixesTag {
    pub span: Span,
    pub name_path: NamePath,
}

#[ast_node]
pub struct MixinTag {
    pub span: Span,
    pub name: Text,
}

#[ast_node]
pub struct ModuleTag {
    pub span: Span,
    pub name: Text,
    pub ty: Text,
}

#[ast_node]
pub struct NameTag {
    pub span: Span,
    pub name_path: NamePath,
}

#[ast_node]
pub struct NamespaceTag {
    pub span: Span,
    pub ty: Option<Text>,
    pub name: Option<Text>,
}

#[ast_node]
pub struct OverrideTag {
    pub span: Span,
}

#[ast_node]
pub struct PackageTag {
    pub span: Span,
    pub ty: Option<Text>,
}

#[ast_node]
pub struct RequiresTag {
    pub span: Span,
    pub name_path: NamePath,
}

#[ast_node]
pub struct SeeTag {
    pub span: Span,
    pub text: Text,
}

#[ast_node]
pub struct SinceTag {
    pub span: Span,
    pub version: Text,
}

#[ast_node]
pub struct SummaryTag {
    pub span: Span,
    pub text: Text,
}

#[ast_node]
pub struct StaticTag {
    pub span: Span,
}

#[ast_node]
pub struct ThrowTag {
    pub span: Span,
    pub text: Text,
}

#[ast_node]
pub struct TodoTag {
    pub span: Span,
    pub text: Text,
}

#[ast_node]
pub struct TutorialTag {
    pub span: Span,
    pub text: Text,
}

#[ast_node]
pub struct VariationTag {
    pub span: Span,
    pub number: Text,
}

#[ast_node]
pub struct VersionTag {
    pub span: Span,
    pub value: Text,
}

#[ast_node]
pub struct YieldTag {
    pub span: Span,
    pub value: Option<Text>,
    pub description: Text,
}