Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change declarations to use type instead of interface #203

Merged
merged 1 commit into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion macros/src/types/named.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ pub(crate) fn named(
#fields,
)
},
decl: quote!(format!("interface {}{} {}", #name, #generic_args, Self::inline())),
decl: quote!(format!("type {}{} = {}", #name, #generic_args, Self::inline())),
inline_flattened: Some(fields),
name: name.to_owned(),
dependencies,
Expand Down
2 changes: 1 addition & 1 deletion ts-rs/tests/chrono.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ fn chrono() {

assert_eq!(
Chrono::decl(),
"interface Chrono { date: [string, string, string, string], time: string, date_time: [string, string, string, string], duration: string, month: string, weekday: string, }"
"type Chrono = { date: [string, string, string, string], time: string, date_time: [string, string, string, string], duration: string, month: string, weekday: string, }"
)
}
16 changes: 4 additions & 12 deletions ts-rs/tests/export_manually.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,12 @@ fn export_manually() {
let expected_content = if cfg!(feature = "format") {
concat!(
"// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.\n\n",
"export interface User {\n",
" name: string;\n",
" age: number;\n",
" active: boolean;\n",
"}\n"
"export type User = { name: string; age: number; active: boolean };\n"
)
} else {
concat!(
"// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.\n",
"\nexport interface User { name: string, age: number, active: boolean, }"
"\nexport type User = { name: string, age: number, active: boolean, }"
)
};

Expand All @@ -52,16 +48,12 @@ fn export_manually_dir() {
let expected_content = if cfg!(feature = "format") {
concat!(
"// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.\n\n",
"export interface UserDir {\n",
" name: string;\n",
" age: number;\n",
" active: boolean;\n",
"}\n"
"export type UserDir = { name: string; age: number; active: boolean };\n"
)
} else {
concat!(
"// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.\n",
"\nexport interface UserDir { name: string, age: number, active: boolean, }"
"\nexport type UserDir = { name: string, age: number, active: boolean, }"
)
};

Expand Down
26 changes: 13 additions & 13 deletions ts-rs/tests/generics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,27 +60,27 @@ declare! {
fn test() {
assert_eq!(
TypeGroup::decl(),
"interface TypeGroup { foo: Array<Container>, }",
"type TypeGroup = { foo: Array<Container>, }",
);

assert_eq!(
Generic::<()>::decl(),
"interface Generic<T> { value: T, values: Array<T>, }"
"type Generic<T> = { value: T, values: Array<T>, }"
);

assert_eq!(
GenericAutoBound::<()>::decl(),
"interface GenericAutoBound<T> { value: T, values: Array<T>, }"
"type GenericAutoBound<T> = { value: T, values: Array<T>, }"
);

assert_eq!(
GenericAutoBound2::<()>::decl(),
"interface GenericAutoBound2<T> { value: T, values: Array<T>, }"
"type GenericAutoBound2<T> = { value: T, values: Array<T>, }"
);

assert_eq!(
Container::decl(),
"interface Container { foo: Generic<number>, bar: Array<Generic<number>>, baz: Record<string, Generic<string>>, }"
"type Container = { foo: Generic<number>, bar: Array<Generic<number>>, baz: Record<string, Generic<string>>, }"
);
}

Expand Down Expand Up @@ -142,7 +142,7 @@ fn generic_struct() {

assert_eq!(
Struct::<()>::decl(),
"interface Struct<T> { a: T, b: [T, T], c: [T, [T, T]], d: Array<T>, e: Array<[T, T]>, f: Array<T>, g: Array<Array<T>>, h: Array<Array<[T, T]>>, }"
"type Struct<T> = { a: T, b: [T, T], c: [T, [T, T]], d: Array<T>, e: Array<[T, T]>, f: Array<T>, g: Array<Array<T>>, h: Array<Array<[T, T]>>, }"
)
}

Expand All @@ -164,10 +164,10 @@ fn inline() {
t: Generic<String>,
}

assert_eq!(Generic::<()>::decl(), "interface Generic<T> { t: T, }");
assert_eq!(Generic::<()>::decl(), "type Generic<T> = { t: T, }");
assert_eq!(
Container::decl(),
"interface Container { g: Generic<string>, gi: { t: string }, t: string, }"
"type Container = { g: Generic<string>, gi: { t: string }, t: string, }"
);
}

Expand All @@ -177,15 +177,15 @@ fn default() {
struct A<T = String> {
t: T,
}
assert_eq!(A::<()>::decl(), "interface A<T = string> { t: T, }");
assert_eq!(A::<()>::decl(), "type A<T = string> = { t: T, }");

#[derive(TS)]
struct B<U = Option<A<i32>>> {
u: U,
}
assert_eq!(
B::<()>::decl(),
"interface B<U = A<number> | null> { u: U, }"
"type B<U = A<number> | null> = { u: U, }"
);
assert!(B::<()>::dependencies().iter().any(|dep| dep.ts_name == "A"));

Expand All @@ -200,7 +200,7 @@ fn default() {
// #[ts(inline)]
// xi2: X<i32>
}
assert_eq!(Y::decl(), "interface Y { a1: A, a2: A<number>, }")
assert_eq!(Y::decl(), "type Y = { a1: A, a2: A<number>, }")
}

#[test]
Expand All @@ -209,7 +209,7 @@ fn trait_bounds() {
struct A<T: ToString = i32> {
t: T,
}
assert_eq!(A::<i32>::decl(), "interface A<T = number> { t: T, }");
assert_eq!(A::<i32>::decl(), "type A<T = number> = { t: T, }");

#[derive(TS)]
struct B<T: ToString + Debug + Clone + 'static>(T);
Expand All @@ -232,5 +232,5 @@ fn trait_bounds() {
t: [T; N],
}

assert_eq!(D::<&str, 41>::decl(), "interface D<T> { t: Array<T>, }")
assert_eq!(D::<&str, 41>::decl(), "type D<T> = { t: Array<T>, }")
}
2 changes: 1 addition & 1 deletion ts-rs/tests/indexmap.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ fn indexmap() {

assert_eq!(
Indexes::decl(),
"interface Indexes { map: Record<string, string>, set: Array<string>, }"
"type Indexes = { map: Record<string, string>, set: Array<string>, }"
)
}
4 changes: 2 additions & 2 deletions ts-rs/tests/lifetimes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ fn contains_borrow() {
s: &'a str,
}

assert_eq!(S::decl(), "interface S { s: string, }")
assert_eq!(S::decl(), "type S = { s: string, }")
}

#[test]
Expand All @@ -29,6 +29,6 @@ fn contains_borrow_type_args() {

assert_eq!(
A::decl(),
"interface A { a: Array<number>, b: Array<B<number>>, c: Record<string, boolean>, }"
"type A = { a: Array<number>, b: Array<B<number>>, c: Record<string, boolean>, }"
);
}
2 changes: 1 addition & 1 deletion ts-rs/tests/list.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ fn list() {

assert_eq!(
List::decl(),
"interface List { data: Array<number> | null, }"
"type List = { data: Array<number> | null, }"
);
}
2 changes: 1 addition & 1 deletion ts-rs/tests/ranges.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ struct RangeTest {
fn range() {
assert_eq!(
RangeTest::decl(),
"interface RangeTest { a: { start: number, end: number, }, b: { start: string, end: string, }, c: { start: { start: number, end: number, }, end: { start: number, end: number, }, }, d: { start: number, end: number, }, e: { start: Inner, end: Inner, }, }"
"type RangeTest = { a: { start: number, end: number, }, b: { start: string, end: string, }, c: { start: { start: number, end: number, }, end: { start: number, end: number, }, }, d: { start: number, end: number, }, e: { start: Inner, end: Inner, }, }"
);
assert_eq!(
RangeTest::dependencies(),
Expand Down
2 changes: 1 addition & 1 deletion ts-rs/tests/raw_idents.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ fn raw_idents() {
let out = <r#enum as TS>::decl();
assert_eq!(
out,
"interface enum { type: number, use: number, struct: number, let: number, enum: number, }"
"type enum = { type: number, use: number, struct: number, let: number, enum: number, }"
);
}
2 changes: 1 addition & 1 deletion ts-rs/tests/serde-skip-with-default.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ pub struct Foobar {
fn serde_skip_with_default() {
assert_eq!(
Foobar::decl(),
"interface Foobar { something_else: number, }"
"type Foobar = { something_else: number, }"
);
}
4 changes: 2 additions & 2 deletions ts-rs/tests/union_with_data.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ enum SimpleEnum {

#[test]
fn test_stateful_enum() {
assert_eq!(Bar::decl(), r#"interface Bar { field: number, }"#);
assert_eq!(Bar::decl(), r#"type Bar = { field: number, }"#);
assert_eq!(Bar::dependencies(), vec![]);

assert_eq!(Foo::decl(), r#"interface Foo { bar: Bar, }"#);
assert_eq!(Foo::decl(), r#"type Foo = { bar: Bar, }"#);
assert_eq!(
Foo::dependencies(),
vec![Dependency::from_ty::<Bar>().unwrap()]
Expand Down
2 changes: 1 addition & 1 deletion ts-rs/tests/unsized.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ fn contains_str() {

assert_eq!(
S::decl(),
"interface S { b: string, c: string, r: string, a: string, }"
"type S = { b: string, c: string, r: string, a: string, }"
)
}
Loading