fiux 0.5.2

The fastest multi-format file converter CLI tool
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

use std::path::PathBuf;

use clap::{Parser, Subcommand, ValueHint::FilePath};

static LONG_ABT: &str = r#"
fiux: The fastest streaming-first file conveter.

  • Supports JSON, NDJSON, TOML, CSV, TSV, PSV and more!

  • Formats are detected automatically based on file extension, except for custom 
    delimter CSV formats (e.g. TSV, PSV, etc.), which are detected with `--input-delimiter <DELIMITER>` and `--output-delimiter <DELIMITER>`.

  • if there are any bugs or any features you want, open an issue at: `https://github.com/Tahaa-Dev/fiux`.


╭────────────────·Examples·────────────────╮
│                                      ••• │
│ fiux convert data.json out.csv           │
│ fiux validate broken.ndjson --verbose    │
│ fiux convert big.csv big.json --verbose  │
│                                          │
╰──────────────────────────────────────────╯
"#;

#[derive(Parser)]
#[command(
    author,
    version,
    about = "The fastest utility for converting between file formats.",
    long_about = LONG_ABT
)]
pub struct FioxArgs {
    #[command(subcommand)]
    pub cmd: Commands,

    /// Argument for setting a Markdown (MD) file to export error logs to.
    #[arg(short, long, value_hint = FilePath, global = true)]
    pub(crate) log_file: Option<PathBuf>,
}

/// fiux subcommands
#[derive(Subcommand)]
pub enum Commands {
    /// Convert command that takes two positional arguments for input and output, takes one
    Convert {
        /// Argument for input file path
        #[arg(required = true, value_hint = FilePath)]
        input: PathBuf,

        /// Argument for output file path
        #[arg(short, long, required = true, value_hint = FilePath)]
        output: PathBuf,

        /// Argument to append into output file instead of overwriting it (WARNING: This
        /// can lead to unexpected output on some formats)
        #[arg(short, long)]
        append: bool,

        /// Argument for parsing numbers in manual TOML / JSON writers
        #[arg(short, long)]
        parse_numbers: bool,

        /// Argument for specifying delimiters for CSV / CSV-like input formats (e.g. TSV, PSV, etc.).
        /// This flag makes fiux ignore the extension and instead treat the file as a CSV
        /// with the specified delimiter instead of commas.
        #[arg(long)]
        input_delimiter: Option<char>,

        /// Argument for specifying delimiters for CSV / CSV-like output formats (e.g. TSV, PSV, etc.).
        /// This flag makes fiux ignore the extension and instead treat the file as a CSV
        /// with the specified delimiter instead of commas.
        #[arg(long)]
        output_delimiter: Option<char>,
    },

    /// Validate command for file format validation with one positional argument for the file
    Validate {
        /// path to the file to be validated
        #[arg(required = true, value_hint = FilePath)]
        input: PathBuf,

        /// Argument for specifying delimiters for CSV / CSV-like input formats (e.g. TSV, PSV, etc.).
        /// This flag makes fiux ignore the extension and instead treat the file as a CSV
        /// with the specified delimiter instead of commas.
        #[arg(short, long)]
        delimiter: Option<char>,
    },
}