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

Add null to argument types of optional parameters #4188

Merged
merged 25 commits into from
Dec 7, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
c1d8bc6
Add `null` to argument types of optional parameters
RunDevelopment Oct 12, 2024
0fe90f9
Update echo.js
RunDevelopment Oct 12, 2024
e3fd6f0
Merge branch 'main' into input-null
RunDevelopment Oct 12, 2024
ff5dd9d
Updated refs and changelog
RunDevelopment Oct 12, 2024
914222d
Adjust changelog entry
daxpedda Oct 12, 2024
49c13bf
Merge branch 'main' into input-null
RunDevelopment Oct 12, 2024
3febb5e
Fixed missing null in TS optional args
RunDevelopment Oct 12, 2024
841f802
Remove `| undefined` from JSDoc types
RunDevelopment Oct 13, 2024
22e345f
Merge branch 'main' into input-null
RunDevelopment Oct 13, 2024
bf08a5d
Merge branch 'main' into input-null
RunDevelopment Oct 15, 2024
90f1efb
Update ref
RunDevelopment Oct 15, 2024
7695674
Merge branch 'main' into input-null
RunDevelopment Oct 15, 2024
e86acdf
Merge branch 'main' into input-null
RunDevelopment Oct 16, 2024
b712add
Updated refs
RunDevelopment Oct 16, 2024
e9cedd4
Update crates/cli-support/src/js/binding.rs
RunDevelopment Oct 17, 2024
b23e3d7
Merge branch 'main' into input-null
RunDevelopment Oct 29, 2024
fd337f2
Updated refs
RunDevelopment Oct 29, 2024
3939d03
Merge branch 'main' into input-null
RunDevelopment Oct 31, 2024
d4ff7fa
Updated refs
RunDevelopment Oct 31, 2024
b45cfb6
Unreachable has been reached
RunDevelopment Oct 31, 2024
dd79ed4
Fixed TS test
RunDevelopment Oct 31, 2024
54b6852
Added test for optional args
RunDevelopment Oct 31, 2024
d329619
Merge branch 'main' into input-null
RunDevelopment Nov 30, 2024
36846b3
Updated refs
RunDevelopment Nov 30, 2024
366df0a
Merge branch 'main' into input-null
RunDevelopment Dec 7, 2024
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
35 changes: 27 additions & 8 deletions crates/cli-support/src/js/binding.rs
Original file line number Diff line number Diff line change
Expand Up @@ -300,13 +300,15 @@ impl<'a, 'b> Builder<'a, 'b> {
let mut ts = String::new();
match ty {
AdapterType::Option(ty) if omittable => {
// e.g. `foo?: string | null`
arg.push_str("?: ");
adapter2ts(ty, &mut ts);
adapter2ts(ty, &mut ts, NoneType::Both);
ts.push_str(" | null");
}
ty => {
omittable = false;
arg.push_str(": ");
adapter2ts(ty, &mut ts);
adapter2ts(ty, &mut ts, NoneType::Both);
}
}
arg.push_str(&ts);
Expand Down Expand Up @@ -342,7 +344,7 @@ impl<'a, 'b> Builder<'a, 'b> {
let mut ret = String::new();
match result_tys.len() {
0 => ret.push_str("void"),
1 => adapter2ts(&result_tys[0], &mut ret),
1 => adapter2ts(&result_tys[0], &mut ret, NoneType::Undefined),
_ => ret.push_str("[any]"),
}
if asyncness {
Expand Down Expand Up @@ -374,7 +376,7 @@ impl<'a, 'b> Builder<'a, 'b> {
for (name, ty) in fn_arg_names.iter().zip(arg_tys).rev() {
let mut arg = "@param {".to_string();

adapter2ts(ty, &mut arg);
adapter2ts(ty, &mut arg, NoneType::Both);
arg.push_str("} ");
match ty {
AdapterType::Option(..) if omittable => {
Expand All @@ -395,7 +397,7 @@ impl<'a, 'b> Builder<'a, 'b> {

if let (Some(name), Some(ty)) = (variadic_arg, arg_tys.last()) {
ret.push_str("@param {...");
adapter2ts(ty, &mut ret);
adapter2ts(ty, &mut ret, NoneType::Both);
ret.push_str("} ");
ret.push_str(name);
ret.push('\n');
Expand Down Expand Up @@ -1417,7 +1419,23 @@ impl Invocation {
}
}

fn adapter2ts(ty: &AdapterType, dst: &mut String) {
#[derive(Debug, Clone, Copy)]
enum NoneType {
Undefined,
Null,
RunDevelopment marked this conversation as resolved.
Show resolved Hide resolved
Both,
}
impl NoneType {
fn js_ty(&self) -> &str {
match self {
NoneType::Undefined => "undefined",
NoneType::Null => "null",
NoneType::Both => "undefined | null",
}
}
}

fn adapter2ts(ty: &AdapterType, dst: &mut String, none_type: NoneType) {
match ty {
AdapterType::I32
| AdapterType::S8
Expand All @@ -1435,8 +1453,9 @@ fn adapter2ts(ty: &AdapterType, dst: &mut String) {
AdapterType::Bool => dst.push_str("boolean"),
AdapterType::Vector(kind) => dst.push_str(&kind.js_ty()),
AdapterType::Option(ty) => {
adapter2ts(ty, dst);
dst.push_str(" | undefined");
adapter2ts(ty, dst, none_type);
dst.push_str(" | ");
dst.push_str(none_type.js_ty());
}
AdapterType::NamedExternref(name) => dst.push_str(name),
AdapterType::Struct(name) => dst.push_str(name),
Expand Down
185 changes: 185 additions & 0 deletions crates/cli/tests/reference/echo.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
/* tslint:disable */
/* eslint-disable */
/**
* @param {number} a
* @returns {number}
*/
export function echo_u8(a: number): number;
/**
* @param {number} a
* @returns {number}
*/
export function echo_i8(a: number): number;
/**
* @param {number} a
* @returns {number}
*/
export function echo_u16(a: number): number;
/**
* @param {number} a
* @returns {number}
*/
export function echo_i16(a: number): number;
/**
* @param {number} a
* @returns {number}
*/
export function echo_u32(a: number): number;
/**
* @param {number} a
* @returns {number}
*/
export function echo_i32(a: number): number;
/**
* @param {bigint} a
* @returns {bigint}
*/
export function echo_u64(a: bigint): bigint;
/**
* @param {bigint} a
* @returns {bigint}
*/
export function echo_i64(a: bigint): bigint;
/**
* @param {number} a
* @returns {number}
*/
export function echo_usize(a: number): number;
/**
* @param {number} a
* @returns {number}
*/
export function echo_isize(a: number): number;
/**
* @param {number} a
* @returns {number}
*/
export function echo_f32(a: number): number;
/**
* @param {number} a
* @returns {number}
*/
export function echo_f64(a: number): number;
/**
* @param {boolean} a
* @returns {boolean}
*/
export function echo_bool(a: boolean): boolean;
/**
* @param {string} a
* @returns {string}
*/
export function echo_char(a: string): string;
/**
* @param {string} a
* @returns {string}
*/
export function echo_string(a: string): string;
/**
* @param {Uint8Array} a
* @returns {Uint8Array}
*/
export function echo_vec_u8(a: Uint8Array): Uint8Array;
/**
* @param {Foo} a
* @returns {Foo}
*/
export function echo_struct(a: Foo): Foo;
/**
* @param {(Foo)[]} a
* @returns {(Foo)[]}
*/
export function echo_vec_struct(a: (Foo)[]): (Foo)[];
/**
* @param {number | undefined | null} [a]
* @returns {number | undefined}
*/
export function echo_option_u8(a?: number | null): number | undefined;
/**
* @param {number | undefined | null} [a]
* @returns {number | undefined}
*/
export function echo_option_i8(a?: number | null): number | undefined;
/**
* @param {number | undefined | null} [a]
* @returns {number | undefined}
*/
export function echo_option_u16(a?: number | null): number | undefined;
/**
* @param {number | undefined | null} [a]
* @returns {number | undefined}
*/
export function echo_option_i16(a?: number | null): number | undefined;
/**
* @param {number | undefined | null} [a]
* @returns {number | undefined}
*/
export function echo_option_u32(a?: number | null): number | undefined;
/**
* @param {number | undefined | null} [a]
* @returns {number | undefined}
*/
export function echo_option_i32(a?: number | null): number | undefined;
/**
* @param {bigint | undefined | null} [a]
* @returns {bigint | undefined}
*/
export function echo_option_u64(a?: bigint | null): bigint | undefined;
/**
* @param {bigint | undefined | null} [a]
* @returns {bigint | undefined}
*/
export function echo_option_i64(a?: bigint | null): bigint | undefined;
/**
* @param {number | undefined | null} [a]
* @returns {number | undefined}
*/
export function echo_option_usize(a?: number | null): number | undefined;
/**
* @param {number | undefined | null} [a]
* @returns {number | undefined}
*/
export function echo_option_isize(a?: number | null): number | undefined;
/**
* @param {number | undefined | null} [a]
* @returns {number | undefined}
*/
export function echo_option_f32(a?: number | null): number | undefined;
/**
* @param {number | undefined | null} [a]
* @returns {number | undefined}
*/
export function echo_option_f64(a?: number | null): number | undefined;
/**
* @param {boolean | undefined | null} [a]
* @returns {boolean | undefined}
*/
export function echo_option_bool(a?: boolean | null): boolean | undefined;
/**
* @param {string | undefined | null} [a]
* @returns {string | undefined}
*/
export function echo_option_char(a?: string | null): string | undefined;
/**
* @param {string | undefined | null} [a]
* @returns {string | undefined}
*/
export function echo_option_string(a?: string | null): string | undefined;
/**
* @param {Uint8Array | undefined | null} [a]
* @returns {Uint8Array | undefined}
*/
export function echo_option_vec_u8(a?: Uint8Array | null): Uint8Array | undefined;
/**
* @param {Foo | undefined | null} [a]
* @returns {Foo | undefined}
*/
export function echo_option_struct(a?: Foo | null): Foo | undefined;
/**
* @param {(Foo)[] | undefined | null} [a]
* @returns {(Foo)[] | undefined}
*/
export function echo_option_vec_struct(a?: (Foo)[] | null): (Foo)[] | undefined;
export class Foo {
free(): void;
}
Loading
Loading