Merge branch 'validation-issue-11'

Author: msuchane

src/cmd_line.rs

@@ -59,10 +59,19 @@ pub fn get_args() -> ArgMatches<'static> {
                 .multiple(true)
                 .help("Create a reference module"),
         )
-        // This group ensures that at least one of the assembly or module inputs is present
+        .arg(
+            Arg::with_name("validate")
+                .short("l")
+                .long("validate")
+                .takes_value(true)
+                .value_name("file")
+                .multiple(true)
+                .help("Validate (lint) an existing module or assembly file")
+        )
+        // This group specifies that you either generate modules or validate existing ones
         .group(
-            ArgGroup::with_name("modules")
-                .args(&["assembly", "concept", "procedure", "reference"])
+            ArgGroup::with_name("required")
+                .args(&["assembly", "concept", "procedure", "reference", "validate"])
                 .required(true)
                 .multiple(true),
         )

src/main.rs

@@ -4,6 +4,7 @@ mod cmd_line;
 mod logging;
 mod module;
 mod templating;
+mod validation;
 mod write;
 
 use module::{Input, Module, ModuleType};
@@ -97,6 +98,13 @@ fn main() {
 
         populated.write_file(&options);
     }
+
+    // Validate all file names specified on the command line
+    if let Some(files_iterator) = cmdline_args.values_of("validate") {
+        for file in files_iterator {
+            validation::validate(file);
+        }
+    }
 }
 
 /// Process all titles that have been specified on the command line and that belong to a single

src/module.rs

@@ -1,5 +1,6 @@
-use log::debug;
 /// This module defines the `Module` struct, its builder struct, and methods on both structs.
+use log::debug;
+use std::fmt;
 use std::path::{Path, PathBuf};
 
 use crate::Options;
@@ -13,6 +14,19 @@ pub enum ModuleType {
     Reference,
 }
 
+// Implement human-readable string display for the module type
+impl fmt::Display for ModuleType {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let name = match self {
+            Self::Assembly => "assembly",
+            Self::Concept => "concept",
+            Self::Procedure => "procedure",
+            Self::Reference => "reference",
+        };
+        write!(f, "{}", name)
+    }
+}
+
 /// An initial representation of the module with input data, used to construct the `Module` struct
 #[derive(Debug)]
 pub struct Input {