cha-plugin-sdk-macros 0.6.0

Proc-macro internals for cha-plugin-sdk
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

package cha:plugin@0.1.0;

/// Data types shared between host and guest.
interface types {
    /// Severity level.
    enum severity {
        hint,
        warning,
        error,
    }

    /// Smell category.
    enum smell-category {
        bloaters,
        oo-abusers,
        change-preventers,
        dispensables,
        couplers,
        security,
    }

    /// Source location.
    record location {
        path: string,
        start-line: u32,
        end-line: u32,
        name: option<string>,
    }

    /// A single finding.
    record finding {
        smell-name: string,
        category: smell-category,
        severity: severity,
        location: location,
        message: string,
        suggested-refactorings: list<string>,
    }

    /// Function info from parsed source.
    record function-info {
        name: string,
        start-line: u32,
        end-line: u32,
        line-count: u32,
        complexity: u32,
        parameter-count: u32,
        parameter-types: list<string>,
        chain-depth: u32,
        switch-arms: u32,
        external-refs: list<string>,
        is-delegating: bool,
        is-exported: bool,
        comment-lines: u32,
        referenced-fields: list<string>,
        null-check-fields: list<string>,
        switch-dispatch-target: option<string>,
        optional-param-count: u32,
        called-functions: list<string>,
        cognitive-complexity: u32,
        body-hash: option<string>,
    }

    /// Class info from parsed source.
    record class-info {
        name: string,
        start-line: u32,
        end-line: u32,
        method-count: u32,
        line-count: u32,
        delegating-method-count: u32,
        field-count: u32,
        field-names: list<string>,
        is-exported: bool,
        has-behavior: bool,
        is-interface: bool,
        parent-name: option<string>,
        override-count: u32,
        self-call-count: u32,
        has-listener-field: bool,
        has-notify-method: bool,
    }

    /// Import info.
    record import-info {
        source: string,
        line: u32,
    }

    /// Typed option value for plugin configuration.
    variant option-value {
        str(string),
        int(s64),
        float(f64),
        boolean(bool),
        list-str(list<string>),
    }

    /// Full analysis context passed to the plugin.
    record analysis-input {
        path: string,
        content: string,
        language: string,
        total-lines: u32,
        functions: list<function-info>,
        classes: list<class-info>,
        imports: list<import-info>,
        options: list<tuple<string, option-value>>,
    }
}

/// The world that WASM plugins must implement.
world analyzer {
    use types.{analysis-input, finding};

    /// Return the plugin name (matches [plugins.<name>] in .cha.toml).
    export name: func() -> string;

    /// Return the plugin version (e.g. "1.0.0").
    export version: func() -> string;

    /// Return a short description of what the plugin detects.
    export description: func() -> string;

    /// Return the list of authors.
    export authors: func() -> list<string>;

    /// Run analysis and return findings.
    export analyze: func(input: analysis-input) -> list<finding>;
}