darklua 0.19.0

Transform Lua scripts
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

use std::path::{Component, Path, PathBuf};

use crate::{
    frontend::DarkluaResult,
    utils::{convert_os_string, normalize_path_with_current_dir},
    DarkluaError,
};

pub(crate) fn get_relative_path(
    require_path: &Path,
    source_path: &Path,
    use_current_dir_prefix: bool,
) -> Result<Option<PathBuf>, DarkluaError> {
    let source_parent = get_relative_parent_path(source_path);

    if require_path.has_root() && !source_parent.has_root() {
        return Ok(None);
    }

    Ok(pathdiff::diff_paths(require_path, source_parent)
        .map(|path| {
            if use_current_dir_prefix && !path.starts_with(".") && !path.starts_with("..") {
                Path::new(".").join(path)
            } else if !use_current_dir_prefix && path.starts_with(".") {
                path.strip_prefix(".")
                    .map(Path::to_path_buf)
                    .ok()
                    .unwrap_or(path)
            } else {
                path
            }
        })
        .map(normalize_path_with_current_dir))
}

pub(crate) fn get_relative_parent_path(path: &Path) -> &Path {
    match path.parent() {
        Some(parent) => {
            if parent == Path::new("") {
                Path::new(".")
            } else {
                parent
            }
        }
        None => Path::new(".."),
    }
}

/// This function is an alternative to the `is_relative` method from std::path::Path.
/// Darklua considers a require relative if the path starts with `.` or `..`.
pub(crate) fn is_require_relative(path: &Path) -> bool {
    path.starts_with(Path::new(".")) || path.starts_with(Path::new(".."))
}

pub(crate) fn write_require_path(path: &Path) -> DarkluaResult<String> {
    path.components()
        .try_fold(String::new(), |mut result, component| {
            if !(result.is_empty() || result.ends_with('/')) {
                result.push('/');
            }

            match component {
                Component::CurDir => {
                    result.push('.');
                }
                Component::ParentDir => {
                    result.push('.');
                    result.push('.');
                }
                Component::Normal(name) => {
                    return convert_os_string(name).map(|name| {
                        result.push_str(name);
                        result
                    });
                }
                Component::Prefix(prefix) => {
                    return convert_os_string(prefix.as_os_str()).map(|name| {
                        result.push_str(name);
                        result
                    });
                }
                Component::RootDir => {
                    if result.is_empty() {
                        result.push('/');
                    }
                }
            }

            Ok(result)
        })
}

#[cfg(test)]
mod test {
    use super::*;

    mod write_require_path {
        use super::*;

        macro_rules! test_write_require_path {
            ($($test_name:ident($path:expr) => $expected:expr),* $(,)?) => {
                $(
                    #[test]
                    fn $test_name() {
                        let path = Path::new($path);
                        let result = write_require_path(path).unwrap();

                        pretty_assertions::assert_eq!(result, $expected);
                    }
                )*
            };
        }

        test_write_require_path!(
            writes_current_dir(".") => ".",
            writes_parent_dir("..") => "..",
            writes_root_dir("/") => "/",
            relative_path("./folder") => "./folder",
            relative_path_to_file_with_extension("./folder/module.lua") => "./folder/module.lua",
            writes_root_dir_1_level("/root") => "/root",
            writes_root_dir_2_levels("/root/lib") => "/root/lib",
            writes_root_dir_3_levels("/root/lib/name") => "/root/lib/name",
            writes_root_dir_3_levels_with_extension("/root/lib/name.luau") => "/root/lib/name.luau",
        );

        #[cfg(windows)]
        test_write_require_path!(
            writes_root_with_prefix("c:\\root") => "c:/root",
        );
    }
}