slopguard-rules 0.1.20

Builtin rule definitions for slopguard
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

id: ai-intermediate-row-struct
language: rust
severity: warning
category: correctness
message: >-
  Struct named *Row may be a redundant intermediate. AI often adds a
  stringly-typed Row struct that duplicates a typed one.
note: >-
  An intermediate Row struct whose fields are String copies of a typed
  struct's fields adds a lossy conversion layer for no benefit. Map directly
  into the typed struct.
rule:
  kind: struct_item
  has:
    kind: type_identifier
    regex: 'Row'
ai_check:
  prompt: |
    You are auditing a Rust struct whose name contains "Row" in {{filename}}.

    A redundant intermediate Row struct has String (or otherwise loosely typed)
    fields that duplicate the fields of another struct nearby, forcing a lossy
    conversion (parse/format) for no benefit. A legitimate Row struct maps a
    database row with types that genuinely differ from the domain struct, or has
    no typed counterpart at all.

    Context: {{rule_context}}

    Code (the struct plus surrounding structs and impls):
    {{code}}

    Decide whether this Row struct is a redundant stringly-typed duplicate of
    another struct. Set is_issue to true only when its fields duplicate a typed
    struct and the indirection adds no value.
ignores:
  - "**/fixtures/**"
tests:
  should_match:
    - |
      struct UserRow {
          id: String,
          name: String,
      }
    - |
      pub struct OrderRowData {
          total: String,
      }
  should_not_match:
    - |
      struct User {
          id: i64,
          name: String,
      }
    - |
      struct Config {
          name: String,
      }
    - |
      fn row() -> i32 { 0 }