Add line and column to json output for violations

Author: martinemde

schema/check-output.json

@@ -44,6 +44,8 @@
       "required": [
         "violation_type",
         "file",
+        "line",
+        "column",
         "constant_name",
         "referencing_pack_name",
         "defining_pack_name",
@@ -54,6 +56,8 @@
       "properties": {
         "violation_type": { "$ref": "#/$defs/ViolationType" },
         "file": { "type": "string" },
+        "line": { "type": "integer", "minimum": 1 },
+        "column": { "type": "integer", "minimum": 0 },
         "constant_name": { "type": "string" },
         "referencing_pack_name": { "type": "string" },
         "defining_pack_name": { "type": "string" },

src/packs.rs

@@ -234,10 +234,10 @@ pub struct ProcessedFile {
     pub definitions: Vec<ParsedDefinition>,
 }
 
-#[derive(Debug, PartialEq, Serialize, Deserialize, Default, Eq, Clone)]
+#[derive(Debug, PartialEq, Serialize, Deserialize, Default, Eq, Clone, Hash)]
 pub struct SourceLocation {
-    line: usize,
-    column: usize,
+    pub line: usize,
+    pub column: usize,
 }
 
 pub(crate) fn list_definitions(

src/packs/checker.rs

@@ -16,6 +16,7 @@ use crate::packs::pack::write_pack_to_disk;
 use crate::packs::pack::Pack;
 use crate::packs::package_todo;
 use crate::packs::Configuration;
+use crate::packs::SourceLocation;
 
 use anyhow::bail;
 // External imports
@@ -46,6 +47,7 @@ pub struct ViolationIdentifier {
 pub struct Violation {
     pub message: String,
     pub identifier: ViolationIdentifier,
+    pub source_location: SourceLocation,
 }
 
 pub(crate) trait CheckerInterface {
@@ -513,6 +515,7 @@ mod tests {
     use crate::packs::checker::{
         CheckAllResult, Violation, ViolationIdentifier,
     };
+    use crate::packs::SourceLocation;
 
     #[test]
     fn test_write_violations() {
@@ -527,7 +530,8 @@ mod tests {
                         constant_name: "::Foo::PrivateClass".to_string(),
                         referencing_pack_name: "bar".to_string(),
                         defining_pack_name: "foo".to_string(),
-                    }
+                    },
+                    source_location: SourceLocation { line: 10, column: 5 },
                 },
                 Violation {
                     message: "foo/bar/file2.rb:15:3\nDependency violation: `::Foo::AnotherClass` is not allowed to depend on `::Bar::SomeClass`".to_string(),
@@ -538,7 +542,8 @@ mod tests {
                         constant_name: "::Foo::AnotherClass".to_string(),
                         referencing_pack_name: "foo".to_string(),
                         defining_pack_name: "bar".to_string(),
-                    }
+                    },
+                    source_location: SourceLocation { line: 15, column: 3 },
                 }
             ].iter().cloned().collect(),
             stale_violations: Vec::new(),

src/packs/checker/common_test.rs

@@ -54,6 +54,7 @@ pub mod tests {
                 referencing_pack_name: String::from("packs/foo"),
                 defining_pack_name: String::from("packs/bar"),
             },
+            source_location: SourceLocation { line: 3, column: 1 },
         }
     }
 

src/packs/checker/pack_checker.rs

@@ -161,6 +161,7 @@ impl<'a> PackChecker<'a> {
         Ok(Some(Violation {
             message: self.interpolate_violation_message(extra_template_fields),
             identifier: self.violation_identifier(),
+            source_location: self.reference.source_location.clone(),
         }))
     }
 

src/packs/json.rs

@@ -14,6 +14,8 @@ struct JsonOutput<'a> {
 struct JsonViolation<'a> {
     violation_type: &'a str,
     file: &'a str,
+    line: usize,
+    column: usize,
     constant_name: &'a str,
     referencing_pack_name: &'a str,
     defining_pack_name: &'a str,
@@ -57,6 +59,8 @@ pub fn write_json<W: std::io::Write>(
             JsonViolation {
                 violation_type: &v.identifier.violation_type,
                 file: &v.identifier.file,
+                line: v.source_location.line,
+                column: v.source_location.column,
                 constant_name: &v.identifier.constant_name,
                 referencing_pack_name: &v.identifier.referencing_pack_name,
                 defining_pack_name: &v.identifier.defining_pack_name,