Merge pull request #340 from grantlemons/span-view-modifications

feat: Span View Command Improvements

harper-cli/src/main.rs

@@ -8,7 +8,7 @@ use clap::Parser;
 use harper_comments::CommentParser;
 use harper_core::linting::{LintGroup, LintGroupConfig, Linter};
 use harper_core::parsers::Markdown;
-use harper_core::{remove_overlaps, Dictionary, Document, FstDictionary};
+use harper_core::{remove_overlaps, Dictionary, Document, FstDictionary, TokenKind};
 
 #[derive(Debug, Parser)]
 enum Args {
@@ -30,6 +30,9 @@ enum Args {
     Spans {
         /// The file you wish to display the spans.
         file: PathBuf,
+        /// Include newlines in the output
+        #[arg(short, long)]
+        include_newlines: bool,
     },
     /// Get the metadata associated with a particular word.
     Metadata { word: String },
@@ -91,11 +94,15 @@ fn main() -> anyhow::Result<()> {
 
             Ok(())
         }
-        Args::Spans { file } => {
+        Args::Spans {
+            file,
+            include_newlines,
+        } => {
             let (doc, source) = load_file(&file)?;
 
             let primary_color = Color::Blue;
             let secondary_color = Color::Magenta;
+            let unlintable_color = Color::Red;
             let filename = file
                 .file_name()
                 .map(|s| s.to_string_lossy().into())
@@ -104,11 +111,19 @@ fn main() -> anyhow::Result<()> {
             let mut report_builder =
                 Report::build(ReportKind::Custom("Spans", primary_color), &filename, 0);
             let mut color = primary_color;
-            for token in doc.tokens() {
+
+            for token in doc.tokens().filter(|t| {
+                include_newlines
+                    || !matches!(t.kind, TokenKind::Newline(_) | TokenKind::ParagraphBreak)
+            }) {
                 report_builder = report_builder.with_label(
                     Label::new((&filename, token.span.into()))
                         .with_message(format!("[{}, {})", token.span.start, token.span.end))
-                        .with_color(color),
+                        .with_color(if matches!(token.kind, TokenKind::Unlintable) {
+                            unlintable_color
+                        } else {
+                            color
+                        }),
                 );
 
                 // Alternate colors so spans are clear