fix(language_server): add whitespace for // oxlint-disable-next-line fix

Author: Sysix

crates/oxc_linter/src/lsp.rs

@@ -207,11 +207,31 @@ fn disable_for_this_line<'a>(
     rope: &Rope,
     source_text: &str,
 ) -> FixWithPosition<'a> {
-    let mut start_position = offset_to_position(rope, error_offset, source_text);
-    start_position.character = 0; // TODO: character should be set to match the first non-whitespace character in the source text to match the existing indentation.
+    // 1. search for the first line break character before the error_offset in source_text (if any)
+    // 2. count all whitespace characters after the line break character
+    // 3. set start_position.character to the line break character
+    // 4. add the same whitespace characters to the content of the fix
+    let bytes = source_text.as_bytes()[..error_offset as usize].iter().rev();
+    let mut line_break_offset = error_offset;
+    for byte in bytes {
+        if *byte == b'\n' || *byte == b'\r' {
+            break;
+        }
+        line_break_offset -= 1;
+    }
+    let whitespace_string = source_text
+        .as_bytes()
+        .get(line_break_offset as usize..error_offset as usize)
+        .and_then(|slice| std::str::from_utf8(slice).ok())
+        .map(|s| s.chars().filter(|c| c.is_whitespace()).collect::<String>())
+        .unwrap_or_default();
+
+    let start_position = offset_to_position(rope, line_break_offset, source_text);
     let end_position = start_position.clone();
     FixWithPosition {
-        content: Cow::Owned(format!("// oxlint-disable-next-line {rule_name}\n")),
+        content: Cow::Owned(format!(
+            "{whitespace_string}// oxlint-disable-next-line {rule_name}\n"
+        )),
         span: SpanPositionMessage::new(start_position, end_position)
             .with_message(Some(Cow::Owned(format!("Disable {rule_name} for this line")))),
     }
@@ -344,6 +364,127 @@ mod test {
         assert_eq!(fix.span.start.character, 6);
     }
 
+    #[test]
+    fn disable_for_this_line_single_line() {
+        let source = "console.log('hello');";
+        let rope = Rope::from_str(source);
+        let fix = super::disable_for_this_line("no-console", 8, &rope, source);
+
+        assert_eq!(fix.content, "// oxlint-disable-next-line no-console\n");
+        assert_eq!(fix.span.start.line, 0);
+        assert_eq!(fix.span.start.character, 0);
+    }
+
+    #[test]
+    fn disable_for_this_line_with_spaces() {
+        let source = "  console.log('hello');";
+        let rope = Rope::from_str(source);
+        let fix = super::disable_for_this_line("no-console", 10, &rope, source);
+
+        assert_eq!(fix.content, "  // oxlint-disable-next-line no-console\n");
+        assert_eq!(fix.span.start.line, 0);
+        assert_eq!(fix.span.start.character, 0);
+    }
+
+    #[test]
+    fn disable_for_this_line_with_tabs() {
+        let source = "\t\tconsole.log('hello');";
+        let rope = Rope::from_str(source);
+        let fix = super::disable_for_this_line("no-console", 10, &rope, source);
+
+        assert_eq!(fix.content, "\t\t// oxlint-disable-next-line no-console\n");
+        assert_eq!(fix.span.start.line, 0);
+        assert_eq!(fix.span.start.character, 0);
+    }
+
+    #[test]
+    fn disable_for_this_line_mixed_tabs_spaces() {
+        let source = "\t  \tconsole.log('hello');";
+        let rope = Rope::from_str(source);
+        let fix = super::disable_for_this_line("no-console", 12, &rope, source);
+
+        assert_eq!(fix.content, "\t  \t// oxlint-disable-next-line no-console\n");
+        assert_eq!(fix.span.start.line, 0);
+        assert_eq!(fix.span.start.character, 0);
+    }
+
+    #[test]
+    fn disable_for_this_line_multiline_with_tabs() {
+        let source = "function test() {\n\tconsole.log('hello');\n}";
+        let rope = Rope::from_str(source);
+        let fix = super::disable_for_this_line("no-console", 27, &rope, source);
+
+        assert_eq!(fix.content, "\t// oxlint-disable-next-line no-console\n");
+        assert_eq!(fix.span.start.line, 1);
+        assert_eq!(fix.span.start.character, 0);
+    }
+
+    #[test]
+    fn disable_for_this_line_multiline_with_spaces() {
+        let source = "function test() {\n    console.log('hello');\n}";
+        let rope = Rope::from_str(source);
+        let fix = super::disable_for_this_line("no-console", 30, &rope, source);
+
+        assert_eq!(fix.content, "    // oxlint-disable-next-line no-console\n");
+        assert_eq!(fix.span.start.line, 1);
+        assert_eq!(fix.span.start.character, 0);
+    }
+
+    #[test]
+    fn disable_for_this_line_complex_indentation() {
+        let source = "function test() {\n\t  \t  console.log('hello');\n}";
+        let rope = Rope::from_str(source);
+        let fix = super::disable_for_this_line("no-console", 33, &rope, source);
+
+        assert_eq!(fix.content, "\t  \t  // oxlint-disable-next-line no-console\n");
+        assert_eq!(fix.span.start.line, 1);
+        assert_eq!(fix.span.start.character, 0);
+    }
+
+    #[test]
+    fn disable_for_this_line_no_indentation() {
+        let source = "function test() {\nconsole.log('hello');\n}";
+        let rope = Rope::from_str(source);
+        let fix = super::disable_for_this_line("no-console", 26, &rope, source);
+
+        assert_eq!(fix.content, "// oxlint-disable-next-line no-console\n");
+        assert_eq!(fix.span.start.line, 1);
+        assert_eq!(fix.span.start.character, 0);
+    }
+
+    #[test]
+    fn disable_for_this_line_crlf_with_tabs() {
+        let source = "function test() {\r\n\tconsole.log('hello');\r\n}";
+        let rope = Rope::from_str(source);
+        let fix = super::disable_for_this_line("no-console", 28, &rope, source);
+
+        assert_eq!(fix.content, "\t// oxlint-disable-next-line no-console\n");
+        assert_eq!(fix.span.start.line, 1);
+        assert_eq!(fix.span.start.character, 0);
+    }
+
+    #[test]
+    fn disable_for_this_line_deeply_nested() {
+        let source = "if (true) {\n\t\tif (nested) {\n\t\t\tconsole.log('deep');\n\t\t}\n}";
+        let rope = Rope::from_str(source);
+        let fix = super::disable_for_this_line("no-console", 40, &rope, source);
+
+        assert_eq!(fix.content, "\t\t\t// oxlint-disable-next-line no-console\n");
+        assert_eq!(fix.span.start.line, 2);
+        assert_eq!(fix.span.start.character, 0);
+    }
+
+    #[test]
+    fn disable_for_this_line_at_start_of_file() {
+        let source = "console.log('hello');";
+        let rope = Rope::from_str(source);
+        let fix = super::disable_for_this_line("no-console", 0, &rope, source);
+
+        assert_eq!(fix.content, "// oxlint-disable-next-line no-console\n");
+        assert_eq!(fix.span.start.line, 0);
+        assert_eq!(fix.span.start.character, 0);
+    }
+
     fn assert_position(source: &str, offset: u32, expected: (u32, u32)) {
         let position = offset_to_position(&Rope::from_str(source), offset, source);
         assert_eq!(position.line, expected.0);