feat: add v1 parsing

Author: joshprk

Cargo.lock

@@ -8,5 +8,5 @@ name = "jsonkdl"
 path = "src/main.rs"
 
 [dependencies]
-kdl = "6.3.4"
+kdl = { version = "6.3.4", features = ["v1"] }
 serde_json = "1.0.140"

Cargo.toml

@@ -5,14 +5,18 @@ Converts JSON to KDL.
 ## Usage
 
 ```
-JSON to KDL Converter
-Usage:
-  jsonkdl <input> <output> [options]
+Usage: jsonkdl <input> <output> [options]
+Converts JSON to KDL.
+By default, KDL spec v2 is used.
+
 Arguments:
-  <input>   Input JSON file
-  <output>  Output KDL file
+  <input>          Path to input JSON file
+  <output>         Path to output KDL file
+
 Options:
-  -f, --force      Overwrite existing files
-  -v, --verbose    Verbose output
+  -1, --kdl-v1     Convert to KDL v1
+  -2, --kdl-v2     Convert to KDL v2
+  -f, --force      Overwrite output if it exists
+  -v, --verbose    Print extra information during conversion
   -h, --help       Show this help message
 ```

README.md

@@ -4,15 +4,17 @@ use std::env;
 use std::path::Path;
 
 const HELP_TEXT: &str = "\
-jsonkdl - convert json to kdl
-Usage:
-  jsonkdl <input> <output> [options]
+Usage: jsonkdl <input> <output> [options]
+Converts JSON to KDL.
+By default, KDL spec v2 is used.
 
 Arguments:
-  <input>          Path to input json file
-  <output>         Path to output kdl file
+  <input>          Path to input JSON file
+  <output>         Path to output KDL file
 
-Aptions:
+Options:
+  -1, --kdl-v1     Convert to KDL v1
+  -2, --kdl-v2     Convert to KDL v2
   -f, --force      Overwrite output if it exists
   -v, --verbose    Print extra information during conversion
   -h, --help       Show this help message
@@ -23,6 +25,7 @@ pub enum CliError {
     MissingInput,
     MissingOutput,
     HelpRequested,
+    MultipleKdlVersion,
     InvalidInputPath(String),
     FileExists(String),
     InputNotFound(String),
@@ -37,6 +40,7 @@ pub struct Args {
     pub output: String,
     pub force: bool,
     pub verbose: bool,
+    pub kdl_version: i32,
 }
 
 impl std::fmt::Display for CliError {
@@ -45,6 +49,7 @@ impl std::fmt::Display for CliError {
             CliError::MissingInput => writeln!(f, "missing input path"),
             CliError::MissingOutput => writeln!(f, "missing output path"),
             CliError::HelpRequested => writeln!(f, "help requested"),
+            CliError::MultipleKdlVersion => writeln!(f, "specify only one of --kdl-v1 or --kdl-v2"),
             CliError::InvalidInputPath(path) => writeln!(f, "not a file: {}", path),
             CliError::FileExists(path) => writeln!(f, "file exists: {} (use --force to overwrite)", path),
             CliError::InputNotFound(path) => writeln!(f, "no such file: {}", path),
@@ -71,33 +76,62 @@ impl From<ConversionError> for CliError {
 impl Args {
     fn parse() -> Result<Self> {
         let args: Vec<String> = env::args().collect();
+        let mut positional: Vec<String> = vec![];
+        let mut force = false;
+        let mut verbose = false;
+        let mut kdl_version = 0;
 
-        // If no args besides the program name, show help
-        if args.len() == 1
-            || args.iter().any(|arg| arg == "--help" || arg == "-h")
-        {
+        if args.len() == 1 {
             return Err(CliError::HelpRequested);
         }
 
-        let force = args.iter().any(|arg| arg == "--force" || arg == "-f");
-        let verbose = args.iter().any(|arg| arg == "--verbose" || arg == "-v");
+        for arg in args.iter().skip(1) {
+            if !arg.starts_with('-') {
+                positional.push(arg.into());
+            } else if arg == "-f" || arg == "--force" {
+                force = true;
+            } else if arg == "-v" || arg == "--verbose" {
+                verbose = true;
+            } else if arg == "-1" || arg == "--kdl-v1" {
+                if kdl_version != 0 {
+                    return Err(CliError::MultipleKdlVersion);
+                }
+
+                kdl_version = 1;
+            } else if arg == "-2" || arg == "--kdl-v2" {
+                if kdl_version != 0 {
+                    return Err(CliError::MultipleKdlVersion);
+                }
+
+                kdl_version = 2;
+            } else if arg == "-h" || arg == "--help" {
+                return Err(CliError::HelpRequested);
+            }
+        }
+
+        if kdl_version == 0 {
+            kdl_version = 2;
+        };
 
-        let positional: Vec<String> = args
-            .iter()
-            .skip(1)
-            .filter(|arg| !arg.starts_with('-'))
-            .cloned()
-            .collect();
+        let input = positional
+            .get(0)
+            .ok_or(CliError::MissingInput)?
+            .to_string();
 
-        let input = positional.get(0).ok_or(CliError::MissingInput)?.to_string();
-        let output = positional.get(1).ok_or(CliError::MissingOutput)?.to_string();
+        let output = positional
+            .get(1)
+            .ok_or(CliError::MissingOutput)?
+            .to_string();
 
-        Ok(Self {
+        let result = Self {
             input,
             output,
             force,
             verbose,
-        })
+            kdl_version,
+        };
+
+        Ok(result)
     }
 }
 
@@ -130,6 +164,6 @@ pub fn run() -> Result<()> {
         return Err(CliError::FileExists(args.output));
     }
 
-    convert_file_contents(input_path, output_path, args.verbose)?;
+    convert_file_contents(input_path, output_path, args.verbose, args.kdl_version)?;
     Ok(())
 }

src/cli.rs

@@ -43,10 +43,19 @@ impl From<serde_json::Error> for ConversionError {
 
 pub type Result<T> = std::result::Result<T, ConversionError>;
 
-pub fn convert_file_contents(input: &Path, output: &Path, verbose: bool) -> Result<()> {
+pub fn convert_file_contents(input: &Path, output: &Path, verbose: bool, kdl_version: i32) -> Result<()> {
     let json_content = fs::read_to_string(input)?;
     let json_value: Value = serde_json::from_str(&json_content)?;
-    let kdl_doc = json_to_kdl(json_value)?;
+    let mut kdl_doc = json_to_kdl(json_value)?;
+
+    // For some reason, you MUST autoformat before ensuring version.
+    kdl_doc.autoformat();
+
+    if kdl_version == 2 {
+        kdl_doc.ensure_v2();
+    } else {
+        kdl_doc.ensure_v1();
+    }
 
     // Create output directory if needed
     if let Some(parent) = output.parent() {
@@ -74,8 +83,6 @@ pub fn json_to_kdl(json: Value) -> Result<KdlDocument> {
         document.nodes_mut().push(node);
     }
 
-    document.autoformat();
-
     Ok(document)
 }
 

src/convert.rs

@@ -5,9 +5,9 @@ use std::process::Command;
 use kdl::KdlDocument;
 
 #[test]
-fn test_examples() {
+fn test_examples_v1() {
     let examples_dir = Path::new("examples");
-    let output_dir = Path::new("target/test_outputs");
+    let output_dir = Path::new("target/test_outputs/v1");
 
     fs::create_dir_all(output_dir).expect("failed to create test output directory");
 
@@ -23,9 +23,10 @@ fn test_examples() {
         let output_file = output_dir.join(format!("{file_name}.kdl"));
 
         let status = Command::new(env!("CARGO_BIN_EXE_jsonkdl"))
+            .arg("-f")
+            .arg("-1")
             .arg(&path)
             .arg(&output_file)
-            .arg("-f")
             .status()
             .expect("failed to run binary");
 
@@ -38,8 +39,6 @@ fn test_examples() {
             .read_to_string(&mut kdl_str)
             .expect("failed to read output kdl");
 
-        let _doc: KdlDocument = kdl_str
-            .parse()
-            .expect("output is not valid kdl");
+        KdlDocument::parse_v1(&kdl_str).expect("output is not valid kdl");
     }
 }

tests/integration.rs renamed to tests/integration_v1.rs

@@ -0,0 +1,44 @@
+use std::fs::{self, File};
+use std::io::Read;
+use std::path::Path;
+use std::process::Command;
+use kdl::KdlDocument;
+
+#[test]
+fn test_examples_v2() {
+    let examples_dir = Path::new("examples");
+    let output_dir = Path::new("target/test_outputs/v2");
+
+    fs::create_dir_all(output_dir).expect("failed to create test output directory");
+
+    for entry in fs::read_dir(examples_dir).expect("failed to read examples directory") {
+        let entry = entry.expect("failed to read entry");
+        let path = entry.path();
+
+        if path.extension().and_then(|s| s.to_str()) != Some("json") {
+            continue;
+        }
+
+        let file_name = path.file_stem().unwrap().to_str().unwrap();
+        let output_file = output_dir.join(format!("{file_name}.kdl"));
+
+        let status = Command::new(env!("CARGO_BIN_EXE_jsonkdl"))
+            .arg("-f")
+            .arg("-2")
+            .arg(&path)
+            .arg(&output_file)
+            .status()
+            .expect("failed to run binary");
+
+        assert!(status.success(), "jsonkdl failed on input: {:?}", path);
+
+        let mut kdl_str = String::new();
+
+        File::open(&output_file)
+            .expect("failed to open output kdl")
+            .read_to_string(&mut kdl_str)
+            .expect("failed to read output kdl");
+
+        KdlDocument::parse_v2(&kdl_str).expect("output is not valid kdl");
+    }
+}