Add info about allowed attributes to error

pksunkara · pksunkara · commit 1eb2835c61a3 · 2021-12-09T15:42:14.000Z
diff --git a/diesel_compile_tests/tests/fail/derive/bad_belongs_to.stderr b/diesel_compile_tests/tests/fail/derive/bad_belongs_to.stderr
@@ -40,7 +40,7 @@ error: expected `=`
 71 | #[diesel(belongs_to(Bar, foreign_key(bar_id)))]
    |                                     ^^^^^^^^
 
-error: unknown attribute
+error: unknown attribute, expected `foreign_key`
   --> $DIR/bad_belongs_to.rs:78:26
    |
 78 | #[diesel(belongs_to(Bar, what))]
diff --git a/diesel_compile_tests/tests/fail/derive/bad_mysql_type.stderr b/diesel_compile_tests/tests/fail/derive/bad_mysql_type.stderr
@@ -34,7 +34,7 @@ error: expected string literal
 26 | #[diesel(mysql_type(name = Foo))]
    |                            ^^^
 
-error: unknown attribute
+error: unknown attribute, expected `name`
   --> $DIR/bad_mysql_type.rs:30:21
    |
 30 | #[diesel(mysql_type(what))]
diff --git a/diesel_compile_tests/tests/fail/derive/bad_postgres_type.stderr b/diesel_compile_tests/tests/fail/derive/bad_postgres_type.stderr
@@ -73,7 +73,7 @@ error: expected `name` to be also present
 50 | #[diesel(postgres_type(schema = "foo"))]
    |                                 ^^^^^
 
-error: unknown attribute
+error: unknown attribute, expected one of `oid`, `array_oid`, `name`, `schema`
   --> $DIR/bad_postgres_type.rs:54:24
    |
 54 | #[diesel(postgres_type(what))]
diff --git a/diesel_compile_tests/tests/fail/derive/bad_sqlite_type.stderr b/diesel_compile_tests/tests/fail/derive/bad_sqlite_type.stderr
@@ -34,7 +34,7 @@ error: expected string literal
 26 | #[diesel(sqlite_type(name = Foo))]
    |                             ^^^
 
-error: unknown attribute
+error: unknown attribute, expected `name`
   --> $DIR/bad_sqlite_type.rs:30:22
    |
 30 | #[diesel(sqlite_type(what))]
diff --git a/diesel_compile_tests/tests/fail/derive/belongs_to_second_parent.stderr b/diesel_compile_tests/tests/fail/derive/belongs_to_second_parent.stderr
@@ -1,4 +1,4 @@
-error: unknown attribute
+error: unknown attribute, expected `foreign_key`
   --> $DIR/belongs_to_second_parent.rs:29:26
    |
 29 | #[diesel(belongs_to(Bar, Baz))]
diff --git a/diesel_compile_tests/tests/fail/derive/unknown_attribute.stderr b/diesel_compile_tests/tests/fail/derive/unknown_attribute.stderr
@@ -1,10 +1,10 @@
-error: unknown attribute
+error: unknown attribute, expected one of `aggregate`, `not_sized`, `foreign_derive`, `table_name`, `sql_type`, `treat_none_as_default_value`, `treat_none_as_null`, `belongs_to`, `mysql_type`, `sqlite_type`, `postgres_type`, `primary_key`
  --> $DIR/unknown_attribute.rs:5:10
   |
 5 | #[diesel(what = true)]
   |          ^^^^
 
-error: unknown attribute
+error: unknown attribute, expected one of `embed`, `column_name`, `sql_type`, `serialize_as`, `deserialize_as`
   --> $DIR/unknown_attribute.rs:12:14
    |
 12 |     #[diesel(what = true)]
diff --git a/diesel_compile_tests/tests/fail/derive_deprecated/deprecated_postgres_type.stderr b/diesel_compile_tests/tests/fail/derive_deprecated/deprecated_postgres_type.stderr
@@ -67,7 +67,7 @@ error: expected string literal
 warning: #[postgres] attribute form is deprecated
   = help: use `#[diesel(postgres_type(oid = 1, array_oid = 1))]` instead
 
-error: unknown attribute
+error: unknown attribute, expected one of `oid`, `array_oid`, `type_name`
   --> $DIR/deprecated_postgres_type.rs:54:12
    |
 54 | #[postgres(what)]
diff --git a/diesel_derives/src/attrs.rs b/diesel_derives/src/attrs.rs
@@ -91,7 +91,16 @@ impl Parse for FieldAttr {
             "serialize_as" => Ok(FieldAttr::SerializeAs(name, parse_eq(input)?)),
             "deserialize_as" => Ok(FieldAttr::DeserializeAs(name, parse_eq(input)?)),
 
-            _ => unknown_attribute(&name),
+            _ => unknown_attribute(
+                &name,
+                &[
+                    "embed",
+                    "column_name",
+                    "sql_type",
+                    "serialize_as",
+                    "deserialize_as",
+                ],
+            ),
         }
     }
 }
@@ -141,7 +150,23 @@ impl Parse for StructAttr {
                 content.parse_terminated(Ident::parse)?
             })),
 
-            _ => unknown_attribute(&name),
+            _ => unknown_attribute(
+                &name,
+                &[
+                    "aggregate",
+                    "not_sized",
+                    "foreign_derive",
+                    "table_name",
+                    "sql_type",
+                    "treat_none_as_default_value",
+                    "treat_none_as_null",
+                    "belongs_to",
+                    "mysql_type",
+                    "sqlite_type",
+                    "postgres_type",
+                    "primary_key",
+                ],
+            ),
         }
     }
 }
diff --git a/diesel_derives/src/deprecated/postgres_type.rs b/diesel_derives/src/deprecated/postgres_type.rs
@@ -32,7 +32,7 @@ impl Parse for Attr {
                 parse_eq_and_lit_str(name, input)?,
             )),
 
-            _ => unknown_attribute(&name),
+            _ => unknown_attribute(&name, &["oid", "array_oid", "type_name"]),
         }
     }
 }
diff --git a/diesel_derives/src/parsers/belongs_to.rs b/diesel_derives/src/parsers/belongs_to.rs
@@ -17,7 +17,7 @@ impl Parse for Attr {
         match &*name_str {
             "foreign_key" => Ok(Attr::ForeignKey(name, parse_eq(input)?)),
 
-            _ => unknown_attribute(&name),
+            _ => unknown_attribute(&name, &["foreign_key"]),
         }
     }
 }
diff --git a/diesel_derives/src/parsers/mysql_type.rs b/diesel_derives/src/parsers/mysql_type.rs
@@ -17,7 +17,7 @@ impl Parse for Attr {
         match &*name_str {
             "name" => Ok(Attr::Name(name, parse_eq(input)?)),
 
-            _ => unknown_attribute(&name),
+            _ => unknown_attribute(&name, &["name"]),
         }
     }
 }
diff --git a/diesel_derives/src/parsers/postgres_type.rs b/diesel_derives/src/parsers/postgres_type.rs
@@ -24,7 +24,7 @@ impl Parse for Attr {
             "name" => Ok(Attr::Name(name, parse_eq(input)?)),
             "schema" => Ok(Attr::Schema(name, parse_eq(input)?)),
 
-            _ => unknown_attribute(&name),
+            _ => unknown_attribute(&name, &["oid", "array_oid", "name", "schema"]),
         }
     }
 }
diff --git a/diesel_derives/src/parsers/sqlite_type.rs b/diesel_derives/src/parsers/sqlite_type.rs
@@ -17,7 +17,7 @@ impl Parse for Attr {
         match &*name_str {
             "name" => Ok(Attr::Name(name, parse_eq(input)?)),
 
-            _ => unknown_attribute(&name),
+            _ => unknown_attribute(&name, &["name"]),
         }
     }
 }
diff --git a/diesel_derives/src/util.rs b/diesel_derives/src/util.rs
@@ -5,8 +5,15 @@ use syn::{parenthesized, Data, DeriveInput, GenericArgument, Ident, Type};
 
 use model::Model;
 
-pub fn unknown_attribute(name: &Ident) -> ! {
-    abort!(name, "unknown attribute")
+pub fn unknown_attribute(name: &Ident, valid: &[&str]) -> ! {
+    let prefix = if valid.len() == 1 { "" } else { " one of" };
+
+    abort!(
+        name,
+        "unknown attribute, expected{} `{}`",
+        prefix,
+        valid.join("`, `")
+    )
 }
 
 pub fn parse_eq<T: Parse>(input: ParseStream) -> Result<T> {

Original file line number	Diff line number	Diff line change
@@ -40,7 +40,7 @@ error: expected `=`
`40`	`40`	`71 \| #[diesel(belongs_to(Bar, foreign_key(bar_id)))]`
`41`	`41`	`\| ^^^^^^^^`
`42`	`42`
`43`		`-error: unknown attribute`
	`43`	+error: unknown attribute, expected `foreign_key`
`44`	`44`	`--> $DIR/bad_belongs_to.rs:78:26`
`45`	`45`	`\|`
`46`	`46`	`78 \| #[diesel(belongs_to(Bar, what))]`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ error: expected string literal`
`34`	`34`	`26 \| #[diesel(mysql_type(name = Foo))]`
`35`	`35`	`\| ^^^`
`36`	`36`
`37`		`-error: unknown attribute`
	`37`	+error: unknown attribute, expected `name`
`38`	`38`	`--> $DIR/bad_mysql_type.rs:30:21`
`39`	`39`	`\|`
`40`	`40`	`30 \| #[diesel(mysql_type(what))]`
Original file line number	Diff line number	Diff line change
@@ -73,7 +73,7 @@ error: expected `name` to be also present
`73`	`73`	`50 \| #[diesel(postgres_type(schema = "foo"))]`
`74`	`74`	`\| ^^^^^`
`75`	`75`
`76`		`-error: unknown attribute`
	`76`	+error: unknown attribute, expected one of `oid`, `array_oid`, `name`, `schema`
`77`	`77`	`--> $DIR/bad_postgres_type.rs:54:24`
`78`	`78`	`\|`
`79`	`79`	`54 \| #[diesel(postgres_type(what))]`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-error: unknown attribute`
	`1`	+error: unknown attribute, expected `foreign_key`
`2`	`2`	`--> $DIR/belongs_to_second_parent.rs:29:26`
`3`	`3`	`\|`
`4`	`4`	`29 \| #[diesel(belongs_to(Bar, Baz))]`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`		`-error: unknown attribute`
	`1`	+error: unknown attribute, expected one of `aggregate`, `not_sized`, `foreign_derive`, `table_name`, `sql_type`, `treat_none_as_default_value`, `treat_none_as_null`, `belongs_to`, `mysql_type`, `sqlite_type`, `postgres_type`, `primary_key`
`2`	`2`	`--> $DIR/unknown_attribute.rs:5:10`
`3`	`3`	`\|`
`4`	`4`	`5 \| #[diesel(what = true)]`
`5`	`5`	`\| ^^^^`
`6`	`6`
`7`		`-error: unknown attribute`
	`7`	+error: unknown attribute, expected one of `embed`, `column_name`, `sql_type`, `serialize_as`, `deserialize_as`
`8`	`8`	`--> $DIR/unknown_attribute.rs:12:14`
`9`	`9`	`\|`
`10`	`10`	`12 \| #[diesel(what = true)]`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ error: expected string literal`
`67`	`67`	`warning: #[postgres] attribute form is deprecated`
`68`	`68`	= help: use `#[diesel(postgres_type(oid = 1, array_oid = 1))]` instead
`69`	`69`
`70`		`-error: unknown attribute`
	`70`	+error: unknown attribute, expected one of `oid`, `array_oid`, `type_name`
`71`	`71`	`--> $DIR/deprecated_postgres_type.rs:54:12`
`72`	`72`	`\|`
`73`	`73`	`54 \| #[postgres(what)]`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ impl Parse for Attr {`
`32`	`32`	`parse_eq_and_lit_str(name, input)?,`
`33`	`33`	`)),`
`34`	`34`
`35`		`- _ => unknown_attribute(&name),`
	`35`	`+ _ => unknown_attribute(&name, &["oid", "array_oid", "type_name"]),`
`36`	`36`	`}`
`37`	`37`	`}`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ impl Parse for Attr {`
`17`	`17`	`match &*name_str {`
`18`	`18`	`"foreign_key" => Ok(Attr::ForeignKey(name, parse_eq(input)?)),`
`19`	`19`
`20`		`- _ => unknown_attribute(&name),`
	`20`	`+ _ => unknown_attribute(&name, &["foreign_key"]),`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`	`}`