harn-lint 0.10.30

Linter for the Harn programming language
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

//! Internal tracking records used by [`Linter`][crate::linter::Linter]
//! during the walk. These are crate-internal and should not leak into
//! the public API.

use std::collections::HashSet;

use harn_lexer::Span;

/// A variable declaration tracked during linting.
pub(crate) struct Declaration {
    pub(crate) name: String,
    pub(crate) span: Span,
    pub(crate) is_mutable: bool,
    /// True for simple `let x = ...` / `const x = ...` bindings, false for
    /// destructuring patterns. The `unused-variable` autofix only rewrites
    /// identifiers when true, since destructuring renames would need
    /// per-field spans we don't currently track.
    pub(crate) is_simple_ident: bool,
}

/// An import tracked during linting.
pub(crate) struct ImportInfo {
    pub(crate) names: Vec<String>,
    /// Names rejected by canonical module resolution. Suppressing their
    /// derivative unused-import warning also avoids an unsafe autofix.
    pub(crate) invalid_names: HashSet<String>,
    pub(crate) span: Span,
    /// True for `pub import { ... } from "..."`. The selectively listed
    /// names are part of the module's public surface, so the
    /// `unused-import` lint must not flag them as unused even if no
    /// local code references them.
    pub(crate) is_pub: bool,
}

impl ImportInfo {
    pub(crate) fn is_unused(
        &self,
        name: &str,
        value_references: &HashSet<String>,
        type_references: &HashSet<String>,
    ) -> bool {
        !self.invalid_names.contains(name)
            && !value_references.contains(name)
            && !type_references.contains(name)
    }
}

/// A parameter declaration tracked during linting.
pub(crate) struct ParamDeclaration {
    pub(crate) name: String,
    pub(crate) span: Span,
}

/// A function declaration tracked for unused-function detection.
pub(crate) struct FnDeclaration {
    pub(crate) name: String,
    pub(crate) span: Span,
    pub(crate) is_pub: bool,
    pub(crate) is_method: bool,
}

/// A type declaration tracked for unused-type detection.
pub(crate) struct TypeDeclaration {
    pub(crate) name: String,
    pub(crate) span: Span,
    pub(crate) kind: &'static str,
    /// `pub` declarations are part of the module's export surface: importers
    /// may reference them even when nothing in this file does, so the
    /// unused-type lint skips them (mirroring `unused-function` for `pub fn`).
    pub(crate) is_pub: bool,
}