Address comments and fix build.

mathew-horner · mathew-horner · commit f57c15f3e984 · 2022-09-12T16:34:13.000-05:00
diff --git a/crates/ide/src/annotations.rs b/crates/ide/src/annotations.rs
@@ -41,7 +41,7 @@ pub struct AnnotationConfig {
     pub annotate_references: bool,
     pub annotate_method_references: bool,
     pub annotate_enum_variant_references: bool,
-    pub annotation_location: AnnotationLocation,
+    pub location: AnnotationLocation,
 }
 
 pub enum AnnotationLocation {
@@ -137,7 +137,7 @@ pub(crate) fn annotations(
         ) -> Option<TextRange> {
             if let Some(InFile { file_id, value }) = node.original_ast_node(db) {
                 if file_id == source_file_id.into() {
-                    return match config.annotation_location {
+                    return match config.location {
                         AnnotationLocation::AboveName => {
                             value.name().map(|name| name.syntax().text_range())
                         }
@@ -212,10 +212,10 @@ mod tests {
         annotate_references: true,
         annotate_method_references: true,
         annotate_enum_variant_references: true,
-        annotation_location: AnnotationLocation::AboveName,
+        location: AnnotationLocation::AboveName,
     };
 
-    fn check(ra_fixture: &str, expect: Expect, config: &AnnotationConfig) {
+    fn check_with_config(ra_fixture: &str, expect: Expect, config: &AnnotationConfig) {
         let (analysis, file_id) = fixture::file(ra_fixture);
 
         let annotations: Vec<Annotation> = analysis
@@ -228,6 +228,10 @@ mod tests {
         expect.assert_debug_eq(&annotations);
     }
 
+    fn check(ra_fixture: &str, expect: Expect) {
+        check_with_config(ra_fixture, expect, &DEFAULT_CONFIG);
+    }
+
     #[test]
     fn const_annotations() {
         check(
@@ -303,7 +307,6 @@ fn main() {
                     },
                 ]
             "#]],
-            &DEFAULT_CONFIG,
         );
     }
 
@@ -380,7 +383,6 @@ fn main() {
                     },
                 ]
             "#]],
-            &DEFAULT_CONFIG,
         );
     }
 
@@ -516,7 +518,6 @@ fn main() {
                     },
                 ]
             "#]],
-            &DEFAULT_CONFIG,
         );
     }
 
@@ -560,7 +561,6 @@ fn main() {}
                     },
                 ]
             "#]],
-            &DEFAULT_CONFIG,
         );
     }
 
@@ -675,7 +675,6 @@ fn main() {
                     },
                 ]
             "#]],
-            &DEFAULT_CONFIG,
         );
     }
 
@@ -772,7 +771,6 @@ mod tests {
                     },
                 ]
             "#]],
-            &DEFAULT_CONFIG,
         );
     }
 
@@ -788,7 +786,6 @@ struct Foo;
             expect![[r#"
                 []
             "#]],
-            &DEFAULT_CONFIG,
         );
     }
 
@@ -808,13 +805,12 @@ m!();
             expect![[r#"
                 []
             "#]],
-            &DEFAULT_CONFIG,
         );
     }
 
     #[test]
     fn test_annotations_appear_above_whole_item_when_configured_to_do_so() {
-        check(
+        check_with_config(
             r#"
 /// This is a struct named Foo, obviously.
 #[derive(Clone)]
@@ -844,10 +840,7 @@ struct Foo;
                     },
                 ]
             "#]],
-            &AnnotationConfig {
-                annotation_location: AnnotationLocation::AboveWholeItem,
-                ..DEFAULT_CONFIG
-            },
+            &AnnotationConfig { location: AnnotationLocation::AboveWholeItem, ..DEFAULT_CONFIG },
         );
     }
 }
diff --git a/crates/rust-analyzer/src/config.rs b/crates/rust-analyzer/src/config.rs
@@ -307,8 +307,7 @@ config_data! {
         /// Join lines unwraps trivial blocks.
         joinLines_unwrapTrivialBlock: bool = "true",
 
-        /// Where to render annotations.
-        lens_annotationLocation: AnnotationLocation = "\"above_name\"",
+
         /// Whether to show `Debug` lens. Only applies when
         /// `#rust-analyzer.lens.enable#` is set.
         lens_debug_enable: bool            = "true",
@@ -320,6 +319,8 @@ config_data! {
         /// Whether to show `Implementations` lens. Only applies when
         /// `#rust-analyzer.lens.enable#` is set.
         lens_implementations_enable: bool  = "true",
+        /// Where to render annotations.
+        lens_location: AnnotationLocation = "\"above_name\"",
         /// Whether to show `References` lens for Struct, Enum, and Union.
         /// Only applies when `#rust-analyzer.lens.enable#` is set.
         lens_references_adt_enable: bool = "false",
@@ -498,7 +499,7 @@ pub struct LensConfig {
     pub enum_variant_refs: bool,
 
     // annotations
-    pub annotation_location: AnnotationLocation,
+    pub location: AnnotationLocation,
 }
 
 #[derive(Copy, Clone, Debug, PartialEq, Eq, Deserialize)]
@@ -1206,7 +1207,7 @@ impl Config {
             refs_trait: self.data.lens_enable && self.data.lens_references_trait_enable,
             enum_variant_refs: self.data.lens_enable
                 && self.data.lens_references_enumVariant_enable,
-            annotation_location: self.data.lens_annotationLocation,
+            location: self.data.lens_location,
         }
     }
 
diff --git a/crates/rust-analyzer/src/handlers.rs b/crates/rust-analyzer/src/handlers.rs
@@ -1234,7 +1234,7 @@ pub(crate) fn handle_code_lens(
             annotate_references: lens_config.refs_adt,
             annotate_method_references: lens_config.method_refs,
             annotate_enum_variant_references: lens_config.enum_variant_refs,
-            annotation_location: lens_config.annotation_location.into(),
+            location: lens_config.location.into(),
         },
         file_id,
     )?;
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc
@@ -451,11 +451,6 @@ Join lines removes trailing commas.
 --
 Join lines unwraps trivial blocks.
 --
-[[rust-analyzer.lens.annotation.location]]rust-analyzer.lens.annotation.location (default: `above_name`)::
-+
---
-Where to render annotations.
---
 [[rust-analyzer.lens.debug.enable]]rust-analyzer.lens.debug.enable (default: `true`)::
 +
 --
@@ -479,6 +474,11 @@ client doesn't set the corresponding capability.
 Whether to show `Implementations` lens. Only applies when
 `#rust-analyzer.lens.enable#` is set.
 --
+[[rust-analyzer.lens.location]]rust-analyzer.lens.location (default: `"above_name"`)::
++
+--
+Where to render annotations.
+--
 [[rust-analyzer.lens.references.adt.enable]]rust-analyzer.lens.references.adt.enable (default: `false`)::
 +
 --
diff --git a/editors/code/package.json b/editors/code/package.json
@@ -943,19 +943,6 @@
                     "default": true,
                     "type": "boolean"
                 },
-                "rust-analyzer.lens.annotationLocation": {
-                    "markdownDescription": "Where to render annotations.",
-                    "default": "above_name",
-                    "type": "string",
-                    "enum": [
-                        "above_name",
-                        "above_whole_item"
-                    ],
-                    "enumDescriptions": [
-                        "Render annotations above the name of the item.",
-                        "Render annotations above the whole item, including documentation comments and attributes."
-                    ]
-                },
                 "rust-analyzer.lens.debug.enable": {
                     "markdownDescription": "Whether to show `Debug` lens. Only applies when\n`#rust-analyzer.lens.enable#` is set.",
                     "default": true,
@@ -976,6 +963,19 @@
                     "default": true,
                     "type": "boolean"
                 },
+                "rust-analyzer.lens.location": {
+                    "markdownDescription": "Where to render annotations.",
+                    "default": "above_name",
+                    "type": "string",
+                    "enum": [
+                        "above_name",
+                        "above_whole_item"
+                    ],
+                    "enumDescriptions": [
+                        "Render annotations above the name of the item.",
+                        "Render annotations above the whole item, including documentation comments and attributes."
+                    ]
+                },
                 "rust-analyzer.lens.references.adt.enable": {
                     "markdownDescription": "Whether to show `References` lens for Struct, Enum, and Union.\nOnly applies when `#rust-analyzer.lens.enable#` is set.",
                     "default": false,

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ pub struct AnnotationConfig {`
`41`	`41`	`pub annotate_references: bool,`
`42`	`42`	`pub annotate_method_references: bool,`
`43`	`43`	`pub annotate_enum_variant_references: bool,`
`44`		`- pub annotation_location: AnnotationLocation,`
	`44`	`+ pub location: AnnotationLocation,`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`pub enum AnnotationLocation {`
`@@ -137,7 +137,7 @@ pub(crate) fn annotations(`
`137`	`137`	`) -> Option<TextRange> {`
`138`	`138`	`if let Some(InFile { file_id, value }) = node.original_ast_node(db) {`
`139`	`139`	`if file_id == source_file_id.into() {`
`140`		`- return match config.annotation_location {`
	`140`	`+ return match config.location {`
`141`	`141`	`AnnotationLocation::AboveName => {`
`142`	`142`	`value.name().map(\|name\| name.syntax().text_range())`
`143`	`143`	`}`
`@@ -212,10 +212,10 @@ mod tests {`
`212`	`212`	`annotate_references: true,`
`213`	`213`	`annotate_method_references: true,`
`214`	`214`	`annotate_enum_variant_references: true,`
`215`		`- annotation_location: AnnotationLocation::AboveName,`
	`215`	`+ location: AnnotationLocation::AboveName,`
`216`	`216`	`};`
`217`	`217`
`218`		`- fn check(ra_fixture: &str, expect: Expect, config: &AnnotationConfig) {`
	`218`	`+ fn check_with_config(ra_fixture: &str, expect: Expect, config: &AnnotationConfig) {`
`219`	`219`	`let (analysis, file_id) = fixture::file(ra_fixture);`
`220`	`220`
`221`	`221`	`let annotations: Vec<Annotation> = analysis`
`@@ -228,6 +228,10 @@ mod tests {`
`228`	`228`	`expect.assert_debug_eq(&annotations);`
`229`	`229`	`}`
`230`	`230`
	`231`	`+ fn check(ra_fixture: &str, expect: Expect) {`
	`232`	`+ check_with_config(ra_fixture, expect, &DEFAULT_CONFIG);`
	`233`	`+ }`
	`234`	`+`
`231`	`235`	`#[test]`
`232`	`236`	`fn const_annotations() {`
`233`	`237`	`check(`
`@@ -303,7 +307,6 @@ fn main() {`
`303`	`307`	`},`
`304`	`308`	`]`
`305`	`309`	`"#]],`
`306`		`- &DEFAULT_CONFIG,`
`307`	`310`	`);`
`308`	`311`	`}`
`309`	`312`
`@@ -380,7 +383,6 @@ fn main() {`
`380`	`383`	`},`
`381`	`384`	`]`
`382`	`385`	`"#]],`
`383`		`- &DEFAULT_CONFIG,`
`384`	`386`	`);`
`385`	`387`	`}`
`386`	`388`
`@@ -516,7 +518,6 @@ fn main() {`
`516`	`518`	`},`
`517`	`519`	`]`
`518`	`520`	`"#]],`
`519`		`- &DEFAULT_CONFIG,`
`520`	`521`	`);`
`521`	`522`	`}`
`522`	`523`
`@@ -560,7 +561,6 @@ fn main() {}`
`560`	`561`	`},`
`561`	`562`	`]`
`562`	`563`	`"#]],`
`563`		`- &DEFAULT_CONFIG,`
`564`	`564`	`);`
`565`	`565`	`}`
`566`	`566`
`@@ -675,7 +675,6 @@ fn main() {`
`675`	`675`	`},`
`676`	`676`	`]`
`677`	`677`	`"#]],`
`678`		`- &DEFAULT_CONFIG,`
`679`	`678`	`);`
`680`	`679`	`}`
`681`	`680`
`@@ -772,7 +771,6 @@ mod tests {`
`772`	`771`	`},`
`773`	`772`	`]`
`774`	`773`	`"#]],`
`775`		`- &DEFAULT_CONFIG,`
`776`	`774`	`);`
`777`	`775`	`}`
`778`	`776`
`@@ -788,7 +786,6 @@ struct Foo;`
`788`	`786`	`expect![[r#"`
`789`	`787`	`[]`
`790`	`788`	`"#]],`
`791`		`- &DEFAULT_CONFIG,`
`792`	`789`	`);`
`793`	`790`	`}`
`794`	`791`
`@@ -808,13 +805,12 @@ m!();`
`808`	`805`	`expect![[r#"`
`809`	`806`	`[]`
`810`	`807`	`"#]],`
`811`		`- &DEFAULT_CONFIG,`
`812`	`808`	`);`
`813`	`809`	`}`
`814`	`810`
`815`	`811`	`#[test]`
`816`	`812`	`fn test_annotations_appear_above_whole_item_when_configured_to_do_so() {`
`817`		`- check(`
	`813`	`+ check_with_config(`
`818`	`814`	`r#"`
`819`	`815`	`/// This is a struct named Foo, obviously.`
`820`	`816`	`#[derive(Clone)]`
`@@ -844,10 +840,7 @@ struct Foo;`
`844`	`840`	`},`
`845`	`841`	`]`
`846`	`842`	`"#]],`
`847`		`- &AnnotationConfig {`
`848`		`- annotation_location: AnnotationLocation::AboveWholeItem,`
`849`		`- ..DEFAULT_CONFIG`
`850`		`- },`
	`843`	`+ &AnnotationConfig { location: AnnotationLocation::AboveWholeItem, ..DEFAULT_CONFIG },`
`851`	`844`	`);`
`852`	`845`	`}`
`853`	`846`	`}`