Remove diagnostics from parser

Author: benwebber

src/lib.rs

@@ -22,8 +22,8 @@ pub use rule::Rule;
 
 /// Parse a changelog from a string.
 ///
-/// Parsing a changelog will nearly always succeed. This function returns a [`Result`] to support
-/// future fatal errors (e.g. if the document is not a changelog at all).
+/// Parsing a changelog will always succeed. This function returns a [`Result`] to support future
+/// fatal errors (e.g. if the document is not a changelog at all).
 pub fn parse_str(s: &str) -> Result<(Changelog, Vec<Diagnostic>), ParseError> {
     parse(s, None)
 }
@@ -38,9 +38,9 @@ pub fn parse_file(path: &Path) -> Result<(Changelog, Vec<Diagnostic>), Error> {
 }
 
 fn parse(s: &str, path: Option<&Path>) -> Result<(Changelog, Vec<Diagnostic>), ParseError> {
-    let (changelog, mut diagnostics) = parser::parse(s);
+    let changelog = parser::parse(s);
     let profile = profile::Profile::default();
-    diagnostics.append(&mut linter::lint(&changelog, &profile));
+    let mut diagnostics = linter::lint(&changelog, &profile);
     diagnostics.sort_by_key(|d| d.span);
     for diagnostic in &mut diagnostics {
         diagnostic.path = path.map(|p| p.to_path_buf());

src/parser.rs

@@ -1,6 +1,5 @@
 //! Parse a changelog as its [intermediate representation](crate::ir::Changelog).
 use crate::ast::*;
-use crate::diagnostic::Diagnostic;
 use crate::ir::*;
 use crate::rule::Rule;
 use crate::span::{Span, SpanIterator};
@@ -10,11 +9,9 @@ use pulldown_cmark as md;
 
 /// Parse a changelog.
 ///
-/// Parsing never fails, although the parser may return diagnostics indicating that it cannot parse
-/// some element of the document correctly.
-pub fn parse(s: &str) -> (Changelog, Vec<Diagnostic>) {
+/// Parsing never fails.
+pub fn parse(s: &str) -> Changelog {
     let mut changelog = Changelog::default();
-    let mut diagnostics: Vec<Diagnostic> = Vec::new();
     let mut blocks = Parser::new(s).peekable();
     while let Some(block) = blocks.next() {
         match block {
@@ -31,8 +28,7 @@ pub fn parse(s: &str) -> (Changelog, Vec<Diagnostic>) {
                 changelog.sections.push(section);
             }
             Block::Heading(heading @ Heading { level: 2, .. }) => {
-                let (section, mut section_diagnostics) = parse_section(s, &heading, &mut blocks);
-                diagnostics.append(&mut section_diagnostics);
+                let section = parse_section(s, &heading, &mut blocks);
                 if let Some(sec) = section {
                     changelog.sections.push(sec);
                 }
@@ -47,20 +43,14 @@ pub fn parse(s: &str) -> (Changelog, Vec<Diagnostic>) {
     };
     let parser = md::Parser::new_with_broken_link_callback(s, md::Options::empty(), Some(callback));
     for _event in parser {}
-    (changelog, diagnostics)
+    changelog
 }
 
-fn parse_section(
-    s: &str,
-    heading: &Heading,
-    blocks: &mut Peekable<Parser>,
-) -> (Option<Section>, Vec<Diagnostic>) {
-    let mut diagnostics: Vec<Diagnostic> = Vec::new();
+fn parse_section(s: &str, heading: &Heading, blocks: &mut Peekable<Parser>) -> Option<Section> {
     let section = match heading.inlines.as_slice() {
         // Unreleased
         [Inline::Link(l)] if &s[l.content.span.range()] == "Unreleased" => {
-            let (changes, mut change_diagnostics) = parse_changes(s, blocks);
-            diagnostics.append(&mut change_diagnostics);
+            let changes = parse_changes(s, blocks);
             Some(Section::Unreleased(Unreleased {
                 heading_span: heading.span,
                 url: Some(l.target.clone()),
@@ -86,21 +76,19 @@ fn parse_section(
                 let yanked = &s[span.range()];
                 release.yanked = Some(Spanned::new(span, yanked.to_string()));
             }
-            let (changes, mut change_diagnostics) = parse_changes(s, blocks);
+            let changes = parse_changes(s, blocks);
             release.changes = changes;
-            diagnostics.append(&mut change_diagnostics);
             Some(Section::Release(release))
         }
         _ => Some(Section::Invalid(InvalidSection {
             heading_span: heading.span,
         })),
     };
-    (section, diagnostics)
+    section
 }
 
-fn parse_changes(s: &str, blocks: &mut Peekable<Parser>) -> (Vec<Changes>, Vec<Diagnostic>) {
+fn parse_changes(s: &str, blocks: &mut Peekable<Parser>) -> Vec<Changes> {
     let mut sections: Vec<(Span, Spanned<String>, Vec<Spanned<String>>)> = Vec::new();
-    let diagnostics: Vec<Diagnostic> = Vec::new();
     let mut current_kind: Option<String> = None;
     let mut current_changes: Vec<Spanned<String>> = Vec::new();
     let mut current_heading_span: Span = Span::default();
@@ -151,7 +139,7 @@ fn parse_changes(s: &str, blocks: &mut Peekable<Parser>) -> (Vec<Changes>, Vec<D
         })
         .collect();
 
-    (changes, diagnostics)
+    changes
 }
 
 fn get_heading_span(heading: &Heading) -> Option<Span> {
@@ -206,7 +194,7 @@ mod tests {
 [1.0.0]: https://example.org/release/1.0.0
 [0.1.0]: https://example.org/release/0.1.0
         ";
-        let (changelog, diagnostics) = parse(source);
-        assert_yaml_snapshot!((changelog, diagnostics));
+        let changelog = parse(source);
+        assert_yaml_snapshot!(changelog);
     }
 }

src/snapshots/notabene__parser__tests__parse.snap

@@ -1,110 +1,109 @@
 ---
 source: src/parser.rs
-expression: "(changelog, diagnostics)"
+expression: changelog
 ---
-- sections:
-    - Title:
-        span:
-          start: 3
-          end: 10
-        value: Title 1
-    - Title:
-        span:
-          start: 13
-          end: 20
-        value: Title 2
-    - Unreleased:
-        heading_span:
-          start: 22
-          end: 39
-        url: "https://example.org/unreleased"
-        changes:
-          - heading_span:
+sections:
+  - Title:
+      span:
+        start: 3
+        end: 10
+      value: Title 1
+  - Title:
+      span:
+        start: 13
+        end: 20
+      value: Title 2
+  - Unreleased:
+      heading_span:
+        start: 22
+        end: 39
+      url: "https://example.org/unreleased"
+      changes:
+        - heading_span:
+            start: 41
+            end: 52
+          kind:
+            span:
               start: 41
               end: 52
-            kind:
-              span:
-                start: 41
-                end: 52
-              value: Removed
-            changes:
-              - span:
-                  start: 56
-                  end: 66
-                value: Remove foo
-    - Release:
-        heading_span:
-          start: 68
+            value: Removed
+          changes:
+            - span:
+                start: 56
+                end: 66
+              value: Remove foo
+  - Release:
+      heading_span:
+        start: 68
+        end: 91
+      version:
+        span:
+          start: 72
+          end: 77
+        value: 1.0.0
+      url: "https://example.org/release/1.0.0"
+      date:
+        span:
+          start: 81
           end: 91
-        version:
-          span:
-            start: 72
-            end: 77
-          value: 1.0.0
-        url: "https://example.org/release/1.0.0"
-        date:
-          span:
-            start: 81
-            end: 91
-          value: 2025-01-01
-        yanked: ~
-        changes:
-          - heading_span:
+        value: 2025-01-01
+      yanked: ~
+      changes:
+        - heading_span:
+            start: 93
+            end: 102
+          kind:
+            span:
               start: 93
               end: 102
-            kind:
-              span:
-                start: 93
-                end: 102
-              value: Added
-            changes:
-              - span:
-                  start: 106
-                  end: 113
-                value: Add foo
-              - span:
-                  start: 116
-                  end: 123
-                value: Add bar
-    - Release:
-        heading_span:
-          start: 125
+            value: Added
+          changes:
+            - span:
+                start: 106
+                end: 113
+              value: Add foo
+            - span:
+                start: 116
+                end: 123
+              value: Add bar
+  - Release:
+      heading_span:
+        start: 125
+        end: 148
+      version:
+        span:
+          start: 129
+          end: 134
+        value: 0.1.0
+      url: "https://example.org/release/0.1.0"
+      date:
+        span:
+          start: 138
           end: 148
-        version:
-          span:
-            start: 129
-            end: 134
-          value: 0.1.0
-        url: "https://example.org/release/0.1.0"
-        date:
-          span:
-            start: 138
-            end: 148
-          value: 2024-01-01
-        yanked: ~
-        changes:
-          - heading_span:
+        value: 2024-01-01
+      yanked: ~
+      changes:
+        - heading_span:
+            start: 150
+            end: 159
+          kind:
+            span:
               start: 150
               end: 159
-            kind:
-              span:
-                start: 150
-                end: 159
-              value: Added
-            changes:
-              - span:
-                  start: 163
-                  end: 170
-                value: Add baz
-              - span:
-                  start: 173
-                  end: 181
-                value: Add quux
-    - Invalid:
-        heading_span:
-          start: 183
-          end: 207
-  broken_links:
-    - start: 186
-      end: 194
-- []
+            value: Added
+          changes:
+            - span:
+                start: 163
+                end: 170
+              value: Add baz
+            - span:
+                start: 173
+                end: 181
+              value: Add quux
+  - Invalid:
+      heading_span:
+        start: 183
+        end: 207
+broken_links:
+  - start: 186
+    end: 194