tsify 0.5.6

Tsify is a library for generating TypeScript definitions from rust code.
Documentation 
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

#![allow(dead_code)]

use indoc::indoc;
use pretty_assertions::assert_eq;
use tsify::Tsify;

struct Unsupported;

#[test]
fn test_struct_with_type_override() {
    /// Comment for Struct
    #[derive(Tsify)]
    struct Struct {
        /// Comment for a
        a: i32,
        /// Comment for b
        #[tsify(type = "0 | 1 | 2")]
        b: i32,
        /// Comment for c
        #[tsify(type = "string | null")]
        c: Unsupported,
    }

    /// Comment for Newtype
    #[derive(Tsify)]
    struct Newtype(#[tsify(type = "string | null")] Unsupported);

    assert_eq!(
        Struct::DECL,
        indoc! {r#"
            /**
             * Comment for Struct
             */
            export interface Struct {
                /**
                 * Comment for a
                 */
                a: number;
                /**
                 * Comment for b
                 */
                b: 0 | 1 | 2;
                /**
                 * Comment for c
                 */
                c: string | null;
            }"#
        }
    );

    assert_eq!(
        Newtype::DECL,
        indoc! {"
        /**
         * Comment for Newtype
         */
        export type Newtype = string | null;"
        }
    );
}

#[test]
fn test_enum_with_type_override() {
    /// Comment for Enum
    #[derive(Tsify)]
    enum Enum {
        /// Comment for Struct
        Struct {
            /// Comment for x
            #[tsify(type = "`tpl_lit_${string}`")]
            x: String,
            /// Comment for y
            #[tsify(type = "0 | 1 | 2")]
            y: i32,
        },
        /// Comment for Tuple
        Tuple(
            #[tsify(type = "`tpl_lit_${string}`")] String,
            #[tsify(type = "0 | 1 | 2")] i32,
        ),
        /// Comment for Newtype
        Newtype(#[tsify(type = "number")] Unsupported),
    }

    let expected = indoc! {r#"
        /**
         * Comment for Enum
         */
        export type Enum = { Struct: { x: `tpl_lit_${string}`; y: 0 | 1 | 2 } } | { Tuple: [`tpl_lit_${string}`, 0 | 1 | 2] } | { Newtype: number };"#
    };

    assert_eq!(Enum::DECL, expected);
}

#[test]
fn test_generic_struct_with_type_override() {
    /// Comment for Foo
    #[derive(Tsify)]
    pub struct Foo<T> {
        /// Comment for bar
        #[tsify(type = "[T, ...T[]]")]
        bar: Vec<T>,
    }

    let expected = indoc! {r#"
        /**
         * Comment for Foo
         */
        export interface Foo<T> {
            /**
             * Comment for bar
             */
            bar: [T, ...T[]];
        }"#
    };

    assert_eq!(Foo::<()>::DECL, expected);
}

#[test]
fn test_generic_struct_with_container_param_override() {
    trait Trait {
        type Assoc;
    }

    #[derive(Tsify)]
    #[tsify(type_params = "T")]
    pub struct Foo<T: Trait> {
        #[tsify(type = "T.Assoc")]
        bar: T::Assoc,
    }

    #[derive(Tsify)]
    #[tsify(type = "{ Assoc: string }")]
    pub struct Bar;

    impl Trait for Bar {
        type Assoc = String;
    }

    let expected = indoc! {r#"
        export interface Foo<T> {
            bar: T.Assoc;
        }"#
    };

    assert_eq!(Foo::<Bar>::DECL, expected);
}

#[test]
fn test_generic_struct_with_field_param_override() {
    trait Trait {
        type Assoc;
    }

    #[derive(Tsify)]
    pub struct Foo<T: Trait> {
        #[tsify(type = "T.Assoc", type_params = "T")]
        bar: T::Assoc,
    }

    #[derive(Tsify)]
    #[tsify(type = "{ Assoc: string }")]
    pub struct Bar;

    impl Trait for Bar {
        type Assoc = String;
    }

    let expected = indoc! {r#"
        export interface Foo<T> {
            bar: T.Assoc;
        }"#
    };

    assert_eq!(Foo::<Bar>::DECL, expected);
}