ruff_server 0.0.10

This is an internal component crate of Ruff
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

use std::path::Path;

use ruff_linter::settings::LinterSettings;
use ruff_workspace::resolver::{match_any_exclusion, match_any_inclusion};
use ruff_workspace::{FileResolverSettings, FormatterSettings};

use crate::edit::LanguageId;

/// Return `true` if the document at the given [`Path`] should be excluded from linting.
pub(crate) fn is_document_excluded_for_linting(
    path: &Path,
    resolver_settings: &FileResolverSettings,
    linter_settings: &LinterSettings,
    language_id: Option<LanguageId>,
) -> bool {
    is_document_excluded(
        path,
        resolver_settings,
        Some(linter_settings),
        None,
        language_id,
    )
}

/// Return `true` if the document at the given [`Path`] should be excluded from formatting.
pub(crate) fn is_document_excluded_for_formatting(
    path: &Path,
    resolver_settings: &FileResolverSettings,
    formatter_settings: &FormatterSettings,
    language_id: Option<LanguageId>,
) -> bool {
    is_document_excluded(
        path,
        resolver_settings,
        None,
        Some(formatter_settings),
        language_id,
    )
}

/// Return `true` if the document at the given [`Path`] should be excluded.
///
/// The tool-specific settings should be provided if the request for the document is specific to
/// that tool. For example, a diagnostics request should provide the linter settings while the
/// formatting request should provide the formatter settings.
///
/// The logic for the resolution considers both inclusion and exclusion and is as follows:
/// 1. Check for global `exclude` and `extend-exclude` options along with tool specific `exclude`
///    option (`lint.exclude`, `format.exclude`).
/// 2. Check for global `include` and `extend-include` options.
/// 3. Check if the language ID is Python, in which case the document is included.
/// 4. If none of the above conditions are met, the document is excluded.
fn is_document_excluded(
    path: &Path,
    resolver_settings: &FileResolverSettings,
    linter_settings: Option<&LinterSettings>,
    formatter_settings: Option<&FormatterSettings>,
    language_id: Option<LanguageId>,
) -> bool {
    if let Some(exclusion) = match_any_exclusion(
        path,
        resolver_settings,
        linter_settings.map(|s| &*s.exclude),
        formatter_settings.map(|s| &*s.exclude),
    ) {
        tracing::debug!("Ignored path via `{}`: {}", exclusion, path.display());
        return true;
    }

    if let Some(inclusion) = match_any_inclusion(path, resolver_settings) {
        tracing::debug!("Included path via `{}`: {}", inclusion, path.display());
        false
    } else if let Some(LanguageId::Python) = language_id {
        tracing::debug!("Included path via Python language ID: {}", path.display());
        false
    } else if let Some(LanguageId::Markdown) = language_id
        && formatter_settings.is_some()
    {
        tracing::debug!("Included path via Markdown language ID: {}", path.display());
        false
    } else {
        tracing::debug!(
            "Ignored path as it's not in the inclusion set: {}",
            path.display()
        );
        true
    }
}