kimun 0.34.3

Code metrics tool — health score, complexity, duplication, hotspots, ownership
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

//! Files that are run rather than used: command-line tasks and scripts.
//!
//! Nothing in the project uses them, so no test of something else passes
//! through them, and few have a test of their own. Warning that an
//! integration test is missing for each would bury the warnings that matter.

use std::error::Error;
use std::path::Path;

use globset::GlobSet;

/// Directories that hold what is run from the command line, by the
/// convention of each ecosystem, as the directories that name them.
const TASK_DIRS: &[&[&str]] = &[
    &["mix", "tasks"],
    &["management", "commands"],
    &["bin"],
    &["scripts"],
    &["examples"],
    &["benches"],
];

/// Files that are the start of a program wherever they are, as the end of
/// their path: the binary of a Rust package and its build script, and what
/// Python runs a package, an installation or a Django project from.
const PROGRAMS: &[&str] = &[
    "src/main.rs",
    "build.rs",
    "__main__.py",
    "setup.py",
    "manage.py",
];

/// Tells the entry points among the files of a repository.
pub struct EntryPoints {
    configured: GlobSet,
}

impl EntryPoints {
    /// The conventional ones, plus the paths matching `patterns`: globs
    /// relative to the repository, as `[impact] entry_points` lists them.
    pub fn new(patterns: &[String]) -> Result<Self, Box<dyn Error>> {
        Ok(Self {
            configured: super::inert::globs(patterns, "[impact] entry_points")?,
        })
    }

    /// Whether `path` is where its ecosystem keeps what is run. A file
    /// there that other code uses is not an entry point for that alone.
    pub fn conventional(&self, path: &Path) -> bool {
        let dirs: Vec<&str> = path
            .parent()
            .into_iter()
            .flat_map(|dir| dir.components())
            .filter_map(|c| c.as_os_str().to_str())
            .collect();
        let in_tasks = TASK_DIRS
            .iter()
            .any(|task| dirs.windows(task.len()).any(|window| window == *task));
        in_tasks || PROGRAMS.iter().any(|program| path.ends_with(program))
    }

    /// Whether the repository declares `path` an entry point.
    pub fn configured(&self, path: &Path) -> bool {
        self.configured.is_match(path)
    }
}

#[cfg(test)]
#[path = "entry_test.rs"]
mod tests;