emmylua_code_analysis 0.22.0

A library for analyzing 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

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use serde_with::{DefaultOnError, serde_as};

#[serde_as]
#[derive(Serialize, Deserialize, Debug, JsonSchema, Clone)]
#[serde(rename_all = "camelCase")]
/// Configuration for EmmyLua code completion.
pub struct EmmyrcCompletion {
    /// Enable autocompletion.
    #[serde(default = "default_true")]
    #[schemars(extend("x-vscode-setting" = true))]
    pub enable: bool,
    /// Automatically insert call to `require` when autocompletion
    /// inserts objects from other modules.
    #[serde(default = "default_true")]
    #[schemars(extend("x-vscode-setting" = true))]
    pub auto_require: bool,
    /// The function used for auto-requiring modules.
    #[serde(default = "default_require_function")]
    pub auto_require_function: String,
    /// The naming convention for auto-required filenames.
    #[serde(default)]
    pub auto_require_naming_convention: EmmyrcFilenameConvention,
    /// A separator used in auto-require paths.
    #[serde(default = "default_auto_require_separator")]
    pub auto_require_separator: String,
    /// Whether to use call snippets in completions.
    #[serde(default)]
    #[serde_as(deserialize_as = "DefaultOnError")]
    pub call_snippet: bool,
    /// Symbol that's used to trigger postfix autocompletion.
    #[serde(default = "default_postfix")]
    #[schemars(extend("x-vscode-setting" = {
        "type": ["string", "null"],
        "default": null,
        "enum": [null, "@", ".", ":"],
        "enumItemLabels": ["Default"],
        "markdownEnumDescriptions": ["%config.common.enum.default.description%"],
    }))]
    pub postfix: String,
    /// Whether to include the name in the base function completion. Effect: `function () end` -> `function name() end`.
    #[serde(default = "default_true")]
    #[schemars(extend("x-vscode-setting" = true))]
    pub base_function_includes_name: bool,
}

impl Default for EmmyrcCompletion {
    fn default() -> Self {
        Self {
            enable: default_true(),
            auto_require: default_true(),
            auto_require_function: default_require_function(),
            auto_require_naming_convention: Default::default(),
            call_snippet: false,
            auto_require_separator: default_auto_require_separator(),
            postfix: default_postfix(),
            base_function_includes_name: default_true(),
        }
    }
}

fn default_true() -> bool {
    true
}

fn default_require_function() -> String {
    "require".to_string()
}

fn default_postfix() -> String {
    "@".to_string()
}

fn default_auto_require_separator() -> String {
    ".".to_string()
}

#[derive(Serialize, Deserialize, Debug, JsonSchema, Clone, Copy)]
#[serde(rename_all = "kebab-case")]
#[derive(Default)]
pub enum EmmyrcFilenameConvention {
    /// Keep the original filename.
    #[default]
    Keep,
    /// Convert the filename to snake_case.
    SnakeCase,
    /// Convert the filename to PascalCase.
    PascalCase,
    /// Convert the filename to camelCase.
    CamelCase,
    /// When returning class definition, use class name, otherwise keep original name.
    KeepClass,
}