fta 3.0.1

Fast TypeScript Analyzer
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

use crate::structs::{FtaConfigOptional, FtaConfigResolved};
use std::fmt;
use std::fs::File;
use std::io::Read;
use std::path::Path;

mod integration_tests;
mod tests;

#[derive(Debug, Clone)]
pub struct ConfigError {
    message: String,
}

impl fmt::Display for ConfigError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "ConfigError! {}", self.message)
    }
}

impl From<FtaConfigOptional> for FtaConfigResolved {
    fn from(opt_config: FtaConfigOptional) -> Self {
        let default_config = get_default_config();
        FtaConfigResolved {
            extensions: opt_config.extensions.unwrap_or(default_config.extensions),
            exclude_filenames: opt_config
                .exclude_filenames
                .unwrap_or(default_config.exclude_filenames),
            exclude_directories: opt_config
                .exclude_directories
                .unwrap_or(default_config.exclude_directories),
            output_limit: opt_config
                .output_limit
                .unwrap_or(default_config.output_limit),
            score_cap: opt_config.score_cap.unwrap_or(default_config.score_cap),
            include_comments: opt_config
                .include_comments
                .unwrap_or(default_config.include_comments),
            exclude_under: opt_config
                .exclude_under
                .unwrap_or(default_config.exclude_under),
        }
    }
}

pub fn get_default_config() -> FtaConfigResolved {
    let default_config = FtaConfigResolved {
        extensions: vec![
            ".js".to_string(),
            ".jsx".to_string(),
            ".ts".to_string(),
            ".tsx".to_string(),
        ],
        exclude_filenames: vec![
            ".d.ts".to_string(),
            ".min.js".to_string(),
            ".bundle.js".to_string(),
        ],
        exclude_directories: vec![
            "/dist".to_string(),
            "/bin".to_string(),
            "/build".to_string(),
        ],
        output_limit: 5000,
        score_cap: 1000,
        include_comments: false,
        exclude_under: 6,
    };

    default_config
}

pub fn read_config(
    config_path: String,
    path_specified_by_user: bool,
) -> Result<FtaConfigResolved, ConfigError> {
    let default_config = get_default_config();
    if Path::new(&config_path).exists() {
        let mut file = File::open(config_path).unwrap();
        let mut content = String::new();
        file.read_to_string(&mut content).unwrap();
        let provided_config: FtaConfigOptional = serde_json::from_str(&content).unwrap_or_default();

        // For extensions, filenames and exclude_directories,
        // user-provided values are added to the defaults.
        return Result::Ok(FtaConfigResolved {
            extensions: {
                let mut extensions = default_config.extensions;
                if let Some(mut provided) = provided_config.extensions {
                    extensions.append(&mut provided);
                }
                extensions
            },
            exclude_filenames: {
                let mut exclude_filenames = default_config.exclude_filenames;
                if let Some(mut provided) = provided_config.exclude_filenames {
                    exclude_filenames.append(&mut provided);
                }
                exclude_filenames
            },
            exclude_directories: {
                let mut exclude_directories = default_config.exclude_directories;
                if let Some(mut provided) = provided_config.exclude_directories {
                    exclude_directories.append(&mut provided);
                }
                exclude_directories
            },
            output_limit: provided_config
                .output_limit
                .unwrap_or(default_config.output_limit),
            score_cap: provided_config
                .score_cap
                .unwrap_or(default_config.score_cap),
            exclude_under: provided_config
                .exclude_under
                .unwrap_or(default_config.exclude_under),
            include_comments: provided_config
                .include_comments
                .unwrap_or(default_config.include_comments),
        });
    }

    if !path_specified_by_user {
        return Result::Ok(default_config);
    }

    Result::Err(ConfigError {
        message: format!("Config file not found at file path: {}", config_path),
    })
}