emmylua_check 0.25.1

A command-line tool for checking lua code.
Documentation 
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

#[cfg(feature = "cli")]
use clap::{Parser, ValueEnum};

use lsp_types::DiagnosticSeverity;
use std::path::PathBuf;

#[allow(unused)]
#[derive(Debug, Clone)]
#[cfg_attr(feature = "cli", derive(Parser))]
#[cfg_attr(feature = "cli", command(version))]
pub struct CmdArgs {
    /// Configuration file paths.
    /// If not provided, both ".emmyrc.json" ".emmyrc.lua" and ".luarc.json" will be searched in the workspace
    /// directory
    #[cfg_attr(feature = "cli", arg(short, long, value_delimiter = ','))]
    pub config: Option<Vec<PathBuf>>,

    /// Path to the workspace directory
    #[arg(num_args = 1..)]
    pub workspace: Vec<PathBuf>,

    /// Comma separated list of ignore patterns.
    /// Patterns must follow glob syntax
    #[cfg_attr(feature = "cli", arg(short, long, value_delimiter = ','))]
    pub ignore: Option<Vec<String>>,

    /// Specify output format
    #[cfg_attr(
        feature = "cli",
        arg(
            long,
            short = 'f',
            default_value = "text",
            value_enum,
            ignore_case = true
        )
    )]
    pub output_format: OutputFormat,

    /// Specify output destination (stdout or a file path, only used when output_format is json)
    #[cfg_attr(feature = "cli", arg(long, default_value = "stdout"))]
    pub output: OutputDestination,

    /// Treat warnings as errors
    #[cfg_attr(feature = "cli", arg(long))]
    pub warnings_as_errors: bool,

    /// Only output diagnostics at this severity or above
    #[cfg_attr(feature = "cli", arg(long, value_enum, ignore_case = true))]
    pub severity: Option<DiagnosticSeverityFilter>,

    /// Verbose output
    #[cfg_attr(feature = "cli", arg(long))]
    pub verbose: bool,
}

#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "cli", derive(ValueEnum))]
pub enum OutputFormat {
    Json,
    Text,
    Sarif,
    /// GitHub Actions workflow commands (`::error` / `::warning` / `::notice`)
    Github,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "cli", derive(ValueEnum))]
pub enum DiagnosticSeverityFilter {
    Error,
    Warn,
    Info,
    Hint,
}

impl DiagnosticSeverityFilter {
    pub fn allows(self, severity: Option<DiagnosticSeverity>) -> bool {
        match severity {
            Some(severity) => severity <= self.into(),
            None => false,
        }
    }
}

impl From<DiagnosticSeverityFilter> for DiagnosticSeverity {
    fn from(value: DiagnosticSeverityFilter) -> Self {
        match value {
            DiagnosticSeverityFilter::Error => DiagnosticSeverity::ERROR,
            DiagnosticSeverityFilter::Warn => DiagnosticSeverity::WARNING,
            DiagnosticSeverityFilter::Info => DiagnosticSeverity::INFORMATION,
            DiagnosticSeverityFilter::Hint => DiagnosticSeverity::HINT,
        }
    }
}

#[allow(unused)]
#[derive(Debug, Clone)]
pub enum OutputDestination {
    Stdout,
    File(PathBuf),
}

impl std::str::FromStr for OutputDestination {
    type Err = String;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "stdout" => Ok(OutputDestination::Stdout),
            _ => Ok(OutputDestination::File(PathBuf::from(s))),
        }
    }
}