Add error codes

Cargo.toml

@@ -58,6 +58,10 @@ structopt = "0.3.21"
 toml = "0.5"
 tracing = "0.1.22"
 url = "2.2.0"
+termimad = "0.10.1"
+crossterm = "0.19.0"
+strum = "0.20.0"
+strum_macros = "0.20.1"
 
 [dev-dependencies]
 assert_cmd = "1.0.1"

src/cli.rs

@@ -112,6 +112,9 @@ pub enum Command {
     /// Get system information
     #[structopt(setting(structopt::clap::AppSettings::Hidden))]
     Info(command::Info),
+
+    /// Explain error codes
+    Explain(command::Explain),
 }
 
 impl Rover {
@@ -140,6 +143,7 @@ impl Rover {
             Command::Update(command) => command.run(self.get_rover_config()?),
             Command::Install(command) => command.run(self.get_install_override_path()?),
             Command::Info(command) => command.run(),
+            Command::Explain(command) => command.run(),
         }
     }
 }

src/command/explain.rs

@@ -0,0 +1,25 @@
+use crate::command::RoverStdout;
+use crate::error::metadata::code::Code;
+use crate::Result;
+use serde::Serialize;
+use structopt::StructOpt;
+
+#[derive(Debug, Serialize, StructOpt)]
+pub struct Explain {
+    /// The full error code. For example, E020
+    #[structopt(name = "CODE")]
+    code: Code,
+}
+
+impl Explain {
+    pub fn run(&self) -> Result<RoverStdout> {
+        let explanation = &self.code.explain();
+
+        // if we're printing all codes, we don't need to pretty print them
+        if self.code == Code::EALL {
+            Ok(RoverStdout::PlainText(explanation.clone()))
+        } else {
+            Ok(RoverStdout::Markdown(explanation.clone()))
+        }
+    }
+}

src/command/mod.rs

@@ -1,5 +1,6 @@
 mod config;
 mod docs;
+mod explain;
 mod graph;
 mod info;
 mod install;
@@ -10,6 +11,7 @@ mod update;
 
 pub use config::Config;
 pub use docs::Docs;
+pub use explain::Explain;
 pub use graph::Graph;
 pub use info::Info;
 pub use install::Install;

src/command/output.rs

@@ -1,11 +1,13 @@
 use std::fmt::Debug;
 use std::{collections::HashMap, fmt::Display};
 
-use ansi_term::Colour::Yellow;
+use crate::utils::table::{self, cell, row};
+use ansi_term::Colour::{Cyan, Yellow};
 use atty::Stream;
+use crossterm::style::Attribute::*;
+use regex::Regex;
 use rover_client::query::subgraph::list::ListDetails;
-
-use crate::utils::table::{self, cell, row};
+use termimad::MadSkin;
 
 /// RoverStdout defines all of the different types of data that are printed
 /// to `stdout`. Every one of Rover's commands should return `anyhow::Result<RoverStdout>`
@@ -25,6 +27,8 @@ pub enum RoverStdout {
     VariantList(Vec<String>),
     Profiles(Vec<String>),
     Introspection(String),
+    Markdown(String),
+    PlainText(String),
     None,
 }
 
@@ -107,6 +111,27 @@ impl RoverStdout {
                 print_descriptor("Introspection Response");
                 println!("{}", &introspection_response);
             }
+            RoverStdout::Markdown(markdown_string) => {
+                // underline bolded md
+                let mut skin = MadSkin::default();
+                skin.bold.add_attr(Underlined);
+
+                // replace links in format `[this](url)` to `this (url)`, since
+                // termimad doesn't handle links for us.
+
+                // this pattern captures the named groups, <title> and <url_with_parens>
+                // that we can use to replace with later
+                let re = Regex::new(r"\[(?P<title>[^\[]+)\](?P<url_with_parens>\(.*\))").unwrap();
+                // we want to paint the replaced url cyan
+                // the $pattern labels in the replacer match the <pattern>s in the regex above
+                let replacer = format!("$title {}", Cyan.normal().paint("$url_with_parens"));
+                let reformatted_urls = re.replace_all(markdown_string, replacer);
+
+                println!("{}", skin.inline(&reformatted_urls));
+            }
+            RoverStdout::PlainText(text) => {
+                println!("{}", text);
+            }
             RoverStdout::None => (),
         }
     }