prep releasing v0.6

Author: CrockAgile

Cargo.toml

@@ -1,17 +1,19 @@
 [package]
 name = "bnf"
 # don't manually edit this version unless you're sure you want to circumvent the process documented in RELEASE.md
-version = "0.5.0"
+version = "0.6.0"
 edition = "2024"
 authors = ["@shnewto", "@CrockAgile"]
 
 description = "A library for parsing Backus–Naur form context-free grammars"
 readme = "README.md"
 keywords = ["bnf", "earley", "parser"]
+categories = ["parser-implementations", "parsing", "development-tools"]
 exclude = [".github", "tests", "*.snap", "*.bnf"]
 
 homepage = "https://github.com/shnewto/bnf"
 repository = "https://github.com/shnewto/bnf"
+documentation = "https://docs.rs/bnf"
 
 license = "MIT"
 
@@ -51,9 +53,6 @@ hashbrown = "0.16.1"
 [dependencies.rand]
 version = "0.9.2"
 
-[dependencies.mutants]
-version = "0.0.4"
-
 [dependencies.nom]
 version = "^8.0.0"
 
@@ -69,6 +68,7 @@ optional = true
 [dev-dependencies]
 divan = "0.1.21"
 insta = { version = "1.46.1", default-features = false }
+mutants = "0.0.4"
 
 [dev-dependencies.quickcheck]
 version = "1.0.3"
@@ -80,6 +80,9 @@ serde = ["dep:serde", "dep:serde_json"]
 unstable = []
 tracing = ["dep:tracing", "dep:tracing-subscriber", "dep:tracing-flame"]
 
+[package.metadata.docs.rs]
+all-features = true
+
 [[bench]]
 name = "divan"
 harness = false

README.md

@@ -4,10 +4,20 @@
 [![coveralls](https://coveralls.io/repos/github/shnewto/bnf/badge.svg?branch=main)](https://coveralls.io/github/shnewto/bnf?branch=main)
 [![Crates.io Version](https://img.shields.io/crates/v/bnf.svg)](https://crates.io/crates/bnf)
 [![Crates.io](https://img.shields.io/crates/d/bnf.svg)](https://crates.io/crates/bnf)
+[![Documentation](https://docs.rs/bnf/badge.svg)](https://docs.rs/bnf)
 [![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/shnewto/bnf/blob/main/LICENSE)
 
 A library for parsing Backus–Naur form context-free grammars.
 
+## Installation
+
+Add to your `Cargo.toml`:
+
+```toml
+[dependencies]
+bnf = "0.6"
+```
+
 ## What does a parsable BNF grammar look like?
 
 The following grammar from the

src/earley/grammar.rs

@@ -39,7 +39,7 @@ impl<'gram> InputRange<'gram> {
             },
         }
     }
-    #[mutants::skip]
+    #[cfg_attr(test, mutants::skip)]
     pub fn advance_by(&self, step: usize) -> Self {
         let InputRangeOffset { start, len } = self.offset;
         let max_len = self.input.len() - start;

src/earley/input_range.rs

@@ -224,7 +224,7 @@ impl<'gram> TraversalTree<'gram> {
 mod tests {
     use super::*;
     use crate::Grammar;
-    use crate::earley::ParseGrammar;
+    use crate::parser::grammar::ParseGrammar;
 
     fn dna_grammar() -> Grammar {
         let grammar: Grammar = "<dna> ::= <base> | <base> <dna>

src/earley/traversal.rs

@@ -803,7 +803,7 @@ impl str::FromStr for Grammar {
         }
     }
     #[cfg(not(feature = "ABNF"))]
-    #[mutants::skip]
+    #[cfg_attr(test, mutants::skip)]
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         match parsers::grammar_complete::<BNF>(s) {
             Ok((_, g)) => Ok(g),

src/grammar.rs

@@ -129,7 +129,7 @@ pub fn terminal(input: &str) -> IResult<&str, Term> {
 }
 
 /// Skips whitespace and ;-comments in one pass. Never fails.
-#[mutants::skip]
+#[cfg_attr(test, mutants::skip)]
 pub fn whitespace_plus_comments(mut input: &str) -> IResult<&str, char> {
     let _span = crate::tracing::span!(DEBUG, "whitespace_plus_comments").entered();
     loop {

src/parsers/mod.rs

@@ -19,7 +19,7 @@ mod defs {
     pub(crate) use span;
 
     #[allow(dead_code)]
-    #[mutants::skip]
+    #[cfg_attr(test, mutants::skip)]
     pub fn init_subscriber() {
         tracing_subscriber::fmt()
             .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
@@ -43,7 +43,7 @@ mod defs {
     pub struct Span {}
 
     impl Span {
-        #[mutants::skip]
+        #[cfg_attr(test, mutants::skip)]
         pub const fn entered(&self) -> Self {
             Self {}
         }
@@ -78,7 +78,7 @@ mod defs {
     pub(crate) use event;
 
     #[allow(dead_code)]
-    #[mutants::skip]
+    #[cfg_attr(test, mutants::skip)]
     pub const fn init_subscriber() {}
 }