Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-25 12:33:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

Change missing impl assist to use todo!() instead of unimplemented()

Browse source 
todo!() "Indicates unfinished code" (https://doc.rust-lang.org/std/macro.todo.html)

Rust documentation provides further clarification:

> The difference between unimplemented! and todo! is that while todo!
> conveys an intent of implementing the functionality later and the
> message is "not yet implemented", unimplemented! makes no such claims.

todo!() seems more appropriate for assists that insert missing impls.
This commit is contained in:
Chris Hopman 2020-04-10 13:41:11 -07:00
parent ca9a5dd165
commit af04d45d32
5 changed files with 32 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
crates/ra_assists/src/doc_tests/generated.rs
View file

@ -180,7 +180,7 @@ trait Trait<T> {
}
impl Trait<u32> for () {
fn foo(&self) -> u32 { unimplemented!() }
fn foo(&self) -> u32 { todo!() }
}
"#####,

34
crates/ra_assists/src/handlers/add_missing_impl_members.rs
View file

@ -40,7 +40,7 @@ enum AddMissingImplMembersMode {
// }
//
// impl Trait<u32> for () {
// fn foo(&self) -> u32 { unimplemented!() }
// fn foo(&self) -> u32 { todo!() }
//
// }
// ```
@ -165,7 +165,7 @@ fn add_missing_impl_members_inner(
fn add_body(fn_def: ast::FnDef) -> ast::FnDef {
if fn_def.body().is_none() {
fn_def.with_body(make::block_from_expr(make::expr_unimplemented()))
fn_def.with_body(make::block_from_expr(make::expr_todo()))
} else {
fn_def
}
@ -215,8 +215,8 @@ impl Foo for S {
fn bar(&self) {}
<|>type Output;
const CONST: usize = 42;
fn foo(&self) { unimplemented!() }
fn baz(&self) { unimplemented!() }
fn foo(&self) { todo!() }
fn baz(&self) { todo!() }
}",
);
@ -250,7 +250,7 @@ struct S;
impl Foo for S {
fn bar(&self) {}
<|>fn foo(&self) { unimplemented!() }
<|>fn foo(&self) { todo!() }
}",
);
@ -268,7 +268,7 @@ impl Foo for S { <|> }",
trait Foo { fn foo(&self); }
struct S;
impl Foo for S {
<|>fn foo(&self) { unimplemented!() }
<|>fn foo(&self) { todo!() }
}",
);
}
@ -285,7 +285,7 @@ impl Foo<u32> for S { <|> }",
trait Foo<T> { fn foo(&self, t: T) -> &T; }
struct S;
impl Foo<u32> for S {
<|>fn foo(&self, t: u32) -> &u32 { unimplemented!() }
<|>fn foo(&self, t: u32) -> &u32 { todo!() }
}",
);
}
@ -302,7 +302,7 @@ impl<U> Foo<U> for S { <|> }",
trait Foo<T> { fn foo(&self, t: T) -> &T; }
struct S;
impl<U> Foo<U> for S {
<|>fn foo(&self, t: U) -> &U { unimplemented!() }
<|>fn foo(&self, t: U) -> &U { todo!() }
}",
);
}
@ -319,7 +319,7 @@ impl Foo for S {}<|>",
trait Foo { fn foo(&self); }
struct S;
impl Foo for S {
<|>fn foo(&self) { unimplemented!() }
<|>fn foo(&self) { todo!() }
}",
)
}
@ -342,7 +342,7 @@ mod foo {
}
struct S;
impl foo::Foo for S {
<|>fn foo(&self, bar: foo::Bar) { unimplemented!() }
<|>fn foo(&self, bar: foo::Bar) { todo!() }
}",
);
}
@ -365,7 +365,7 @@ mod foo {
}
struct S;
impl foo::Foo for S {
<|>fn foo(&self, bar: foo::Bar<u32>) { unimplemented!() }
<|>fn foo(&self, bar: foo::Bar<u32>) { todo!() }
}",
);
}
@ -388,7 +388,7 @@ mod foo {
}
struct S;
impl foo::Foo<u32> for S {
<|>fn foo(&self, bar: foo::Bar<u32>) { unimplemented!() }
<|>fn foo(&self, bar: foo::Bar<u32>) { todo!() }
}",
);
}
@ -414,7 +414,7 @@ mod foo {
struct Param;
struct S;
impl foo::Foo<Param> for S {
<|>fn foo(&self, bar: Param) { unimplemented!() }
<|>fn foo(&self, bar: Param) { todo!() }
}",
);
}
@ -439,7 +439,7 @@ mod foo {
}
struct S;
impl foo::Foo for S {
<|>fn foo(&self, bar: foo::Bar<u32>::Assoc) { unimplemented!() }
<|>fn foo(&self, bar: foo::Bar<u32>::Assoc) { todo!() }
}",
);
}
@ -464,7 +464,7 @@ mod foo {
}
struct S;
impl foo::Foo for S {
<|>fn foo(&self, bar: foo::Bar<foo::Baz>) { unimplemented!() }
<|>fn foo(&self, bar: foo::Bar<foo::Baz>) { todo!() }
}",
);
}
@ -487,7 +487,7 @@ mod foo {
}
struct S;
impl foo::Foo for S {
<|>fn foo(&self, bar: dyn Fn(u32) -> i32) { unimplemented!() }
<|>fn foo(&self, bar: dyn Fn(u32) -> i32) { todo!() }
}",
);
}
@ -544,7 +544,7 @@ trait Foo {
struct S;
impl Foo for S {
<|>type Output;
fn foo(&self) { unimplemented!() }
fn foo(&self) { todo!() }
}"#,
)
}

3
crates/ra_syntax/src/ast/make.rs
View file

@ -100,6 +100,9 @@ pub fn expr_empty_block() -> ast::Expr {
pub fn expr_unimplemented() -> ast::Expr {
expr_from_text("unimplemented!()")
}
pub fn expr_todo() -> ast::Expr {
expr_from_text("todo!()")
}
pub fn expr_path(path: ast::Path) -> ast::Expr {
expr_from_text(&path.to_string())
}

2
docs/user/assists.md
View file

@ -175,7 +175,7 @@ trait Trait<T> {
}
impl Trait<u32> for () {
fn foo(&self) -> u32 { unimplemented!() }
fn foo(&self) -> u32 { todo!() }
}
```

11
xtask/tests/tidy-tests/main.rs
View file

@ -20,7 +20,16 @@ fn rust_files_are_tidy() {
}
fn check_todo(path: &Path, text: &str) {
if path.ends_with("tests/cli.rs") {
let whitelist = &[
// This file itself is whitelisted since this test itself contains matches.
"tests/cli.rs",
// Some of our assists generate `todo!()` so those files are whitelisted.
"doc_tests/generated.rs",
"handlers/add_missing_impl_members.rs",
// To support generating `todo!()` in assists, we have `expr_todo()` in ast::make.
"ast/make.rs",
];
if whitelist.iter().any(|p| path.ends_with(p)) {
return;
}
if text.contains("TODO") || text.contains("TOOD") || text.contains("todo!") {