Merge pull request #286 from DaniPopes/export-parser

Export parser types

Author: oli-obk

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+* exported previously-unnameable parser types
+
 ### Changed
 
 ## [0.27.0] - 2024-10-07

src/config.rs

@@ -9,7 +9,6 @@ use crate::{
     per_test_config::{Comments, Condition},
     CommandBuilder, Error, Errors,
 };
-pub use color_eyre;
 use color_eyre::eyre::Result;
 use regex::bytes::Regex;
 use spanned::Spanned;

src/diff.rs

@@ -142,7 +142,7 @@ fn has_both_insertions_and_deletions(diff: &[DiffOp<'_, &str>]) -> bool {
     seen_l && seen_r
 }
 
-pub fn print_diff(expected: &[u8], actual: &[u8]) {
+pub(crate) fn print_diff(expected: &[u8], actual: &[u8]) {
     let expected_str = String::from_utf8_lossy(expected);
     let actual_str = String::from_utf8_lossy(actual);
 

src/lib.rs

@@ -2,12 +2,15 @@
     clippy::enum_variant_names,
     clippy::useless_format,
     clippy::too_many_arguments,
-    rustc::internal
+    rustc::internal,
+    // `unnameable_types` was stabilized in 1.79 which is higher than the current MSRV.
+    // Ignore the "unknown lint" warning which is emitted on older versions.
+    unknown_lints
 )]
+#![warn(unreachable_pub, unnameable_types)]
 #![deny(missing_docs)]
 #![doc = include_str!("../README.md")]
 
-use crate::parser::Comments;
 use build_manager::BuildManager;
 use build_manager::NewJob;
 pub use color_eyre;
@@ -64,6 +67,7 @@ mod tests;
 pub use cmd::*;
 pub use config::*;
 pub use error::*;
+pub use parser::*;
 pub use spanned;
 
 /// Run all tests as described in the config argument.
@@ -146,8 +150,6 @@ pub fn default_per_file_config(config: &mut Config, file_contents: &Spanned<Vec<
 /// Ignores various settings from `Config` that relate to finding test files.
 #[cfg(feature = "rustc")]
 pub fn test_command(mut config: Config, path: &Path) -> Result<Command> {
-    use status_emitter::SilentStatus;
-
     config.fill_host_and_target()?;
 
     let content = Spanned::read_from_file(path)

src/parser.rs

@@ -4,7 +4,7 @@ use crate::{
 use bstr::{ByteSlice, Utf8Error};
 use color_eyre::eyre::Result;
 use regex::bytes::Regex;
-pub(crate) use spanned::*;
+pub use spanned::*;
 use std::{
     collections::{BTreeMap, HashMap},
     num::NonZeroUsize,
@@ -200,6 +200,7 @@ pub struct CommentParser<T> {
     comment_start: &'static str,
 }
 
+/// Command parser function type.
 pub type CommandParserFunc =
     fn(&mut CommentParser<&mut Revisioned>, args: Spanned<&str>, span: Span);
 
@@ -230,9 +231,10 @@ pub enum Condition {
     OnHost,
 }
 
-#[derive(Debug, Clone)]
 /// A sub string of a target (or a whole target).
-/// Effectively a `String` that only allows lowercase chars, integers and dashes
+///
+/// Effectively a `String` that only allows lowercase chars, integers and dashes.
+#[derive(Debug, Clone)]
 pub struct TargetSubStr(String);
 
 impl PartialEq<&str> for TargetSubStr {
@@ -266,10 +268,12 @@ impl TryFrom<String> for TargetSubStr {
     }
 }
 
-#[derive(Debug, Clone)]
 /// An error pattern parsed from a `//~` comment.
+#[derive(Debug, Clone)]
 pub enum Pattern {
+    /// A substring that must appear in the error message.
     SubString(String),
+    /// A regex that must match the error message.
     Regex(Regex),
 }
 
@@ -288,7 +292,7 @@ pub(crate) enum ErrorMatchKind {
 pub(crate) struct ErrorMatch {
     pub(crate) kind: ErrorMatchKind,
     /// The line this pattern is expecting to find a message in.
-    pub line: NonZeroUsize,
+    pub(crate) line: NonZeroUsize,
 }
 
 impl Condition {
@@ -574,20 +578,23 @@ impl CommentParser<Comments> {
 }
 
 impl<CommentsType> CommentParser<CommentsType> {
+    /// Emits an [`InvalidComment`](Error::InvalidComment) error with the given span and message.
     pub fn error(&mut self, span: Span, s: impl Into<String>) {
         self.errors.push(Error::InvalidComment {
             msg: s.into(),
             span,
         });
     }
 
+    /// Checks a condition and emits an error if it is not met.
     pub fn check(&mut self, span: Span, cond: bool, s: impl Into<String>) {
         if !cond {
             self.error(span, s);
         }
     }
 
-    fn check_some<T>(&mut self, span: Span, opt: Option<T>, s: impl Into<String>) -> Option<T> {
+    /// Checks an option and emits an error if it is `None`.
+    pub fn check_some<T>(&mut self, span: Span, opt: Option<T>, s: impl Into<String>) -> Option<T> {
         self.check(span, opt.is_some(), s);
         opt
     }
@@ -703,7 +710,7 @@ impl CommentParser<&mut Revisioned> {
         Some((regex, to.as_bytes().to_owned()))
     }
 
-    /// Add a flag or error if it already existed
+    /// Adds a flag, or errors if it already existed.
     pub fn set_custom_once(&mut self, key: &'static str, custom: impl Flag + 'static, span: Span) {
         let prev = self
             .custom

src/parser/spanned.rs

@@ -1,5 +1,6 @@
-pub use spanned::*;
+pub(crate) use spanned::*;
 
+/// An optional spanned value.
 #[derive(Debug, Clone)]
 pub struct OptWithLine<T>(Option<Spanned<T>>);
 
@@ -30,6 +31,7 @@ impl<T> Default for OptWithLine<T> {
 }
 
 impl<T> OptWithLine<T> {
+    /// Creates a new optional spanned value.
     pub fn new(data: T, span: Span) -> Self {
         Self(Some(Spanned::new(data, span)))
     }
@@ -47,6 +49,7 @@ impl<T> OptWithLine<T> {
         }
     }
 
+    /// Consumes `self` and returns the inner value.
     #[must_use]
     pub fn into_inner(self) -> Option<Spanned<T>> {
         self.0

src/status_emitter/text.rs

@@ -431,7 +431,7 @@ impl TestStatus for TextTest {
                 stderr: &'a [u8],
                 stdout: &'a [u8],
             }
-            impl<'a> Drop for Guard<'a> {
+            impl Drop for Guard<'_> {
                 fn drop(&mut self) {
                     println!("{}", "full stderr:".bold());
                     std::io::stdout().write_all(self.stderr).unwrap();