Separate parsing and linting in public API

Author: benwebber

src/cli/commands.rs

@@ -4,7 +4,8 @@ use std::path::PathBuf;
 
 use clap::ArgMatches;
 
-use crate::parse_file;
+use crate::parse_and_lint_file;
+use crate::profile::Profile;
 use crate::rule::Rule;
 use crate::span::Index;
 
@@ -23,7 +24,8 @@ pub fn check(matches: &ArgMatches) -> Result<()> {
         "full" => OutputFormat::Full,
         _ => unreachable!(),
     };
-    let (_, diagnostics) = parse_file(&path).unwrap();
+    let profile = Profile::default();
+    let (_, diagnostics) = parse_and_lint_file(&path, &profile).unwrap();
     if diagnostics.is_empty() {
         Ok(())
     } else {

src/lib.rs

@@ -18,28 +18,52 @@ pub mod unist;
 pub use changelog::Changelog;
 pub use diagnostic::Diagnostic;
 pub use error::{Error, ParseError};
+pub use profile::Profile;
 pub use rule::Rule;
 
 /// Parse a changelog from a string.
 ///
 /// 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)
+pub fn parse_str(s: &str) -> Result<Changelog, ParseError> {
+    Ok(parser::parse(&s).into())
+}
+
+/// Parse and lint a changelog from a string.
+pub fn parse_and_lint_str(
+    s: &str,
+    profile: &Profile,
+) -> Result<(Changelog, Vec<Diagnostic>), ParseError> {
+    parse_and_lint(s, None, profile)
 }
 
 /// Parse a changelog from a file.
 ///
 /// As with [`parse_str()`], parsing the changelog document will nearly always succeed.
 /// `parse_file()` may additionally return a [`std::io::Error`] ([`Error::Io`]).
-pub fn parse_file(path: &Path) -> Result<(Changelog, Vec<Diagnostic>), Error> {
+pub fn parse_file(path: &Path) -> Result<Changelog, Error> {
+    let s = std::fs::read_to_string(path)?;
+    Ok(parser::parse(&s).into())
+}
+
+/// Parse and lint a changelog from a file.
+///
+/// As with [`parse_str()`], parsing the changelog document will nearly always succeed.
+/// `parse_file()` may additionally return a [`std::io::Error`] ([`Error::Io`]).
+pub fn parse_and_lint_file(
+    path: &Path,
+    profile: &Profile,
+) -> Result<(Changelog, Vec<Diagnostic>), Error> {
     let s = std::fs::read_to_string(path)?;
-    Ok(parse(&s, Some(path))?)
+    Ok(parse_and_lint(&s, Some(path), profile)?)
 }
 
-fn parse(s: &str, path: Option<&Path>) -> Result<(Changelog, Vec<Diagnostic>), ParseError> {
+fn parse_and_lint(
+    s: &str,
+    path: Option<&Path>,
+    profile: &Profile,
+) -> Result<(Changelog, Vec<Diagnostic>), ParseError> {
     let changelog = parser::parse(s);
-    let profile = profile::Profile::default();
     let mut diagnostics = linter::lint(&changelog, &profile);
     diagnostics.sort_by_key(|d| d.span);
     for diagnostic in &mut diagnostics {