Module: MilkTea::Linter::FixEngine

Defined in:
lib/milk_tea/tooling/linter/fix_engine.rb

Class Method Summary collapse

Class Method Details

.apply_fix_edits(lines, edits) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 27

def apply_fix_edits(lines, edits)
  edits.sort_by { |e| [-e.start_line, -e.start_char] }.reverse_each do |edit|
    if edit.start_line == edit.end_line
      line = lines[edit.start_line]
      next unless line

      lines[edit.start_line] = +"#{line[0...edit.start_char]}#{edit.new_text}#{line[edit.end_char..]}"
    else
      prefix = (l = lines[edit.start_line]) ? l[0...edit.start_char] : ""
      suffix = (l = lines[edit.end_line]) ? l[edit.end_char..] : ""
      lines[edit.start_line..edit.end_line] = ["#{prefix}#{edit.new_text}#{suffix}"]
    end
  end
  lines
end

.edits_for_rule(code, lines, warning) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 10

def edits_for_rule(code, lines, warning)
  case code
  when "prefer-let"             then prefer_let_edits(lines, warning)
  when "redundant-ignored-match-binding" then redundant_ignored_match_binding_edits(lines, warning)
  when "prefer-let-else"        then prefer_let_else_edits(lines, warning)
  when "prefer-var-else"        then prefer_var_else_edits(lines, warning)
  when "redundant-bool-compare" then redundant_bool_compare_edits(lines, warning)
  when "redundant-cast"        then redundant_cast_edits(lines, warning)
  when "redundant-else"         then redundant_else_edits(lines, warning)
  when "redundant-return"       then redundant_return_edits(lines, warning)
  when "redundant-type-annotation" then redundant_type_annotation_edits(lines, warning)
  when "unused-import"          then unused_import_edits(lines, warning)
  when "trailing-list-comma"    then trailing_list_comma_edits(lines, warning)
  else []
  end
end

.edits_to_lsp_text_edits(edits, uri) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 43

def edits_to_lsp_text_edits(edits, uri)
  edits.map do |edit|
    {
      range: {
        start: { line: edit.start_line, character: edit.start_char },
        end:   { line: edit.end_line,   character: edit.end_char },
      },
      newText: edit.new_text,
    }
  end
end

.prefer_let_edits(lines, warning) ⇒ Object

── per-rule edit generators ──────────────────────────────────────────



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 57

def prefer_let_edits(lines, warning)
  return [] unless warning.line

  line_idx = warning.line - 1
  original = lines[line_idx]
  return [] unless original&.match?(/\bvar\b/)

  new_line = original.sub(/\bvar\b/, "let")
  [FixEdit.new(start_line: line_idx, start_char: 0, end_line: line_idx + 1, end_char: 0, new_text: new_line)]
end

.prefer_let_else_edits(lines, warning) ⇒ Object 



81
82
83
84
85
86
87
88
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 81

def prefer_let_else_edits(lines, warning)
  return [] unless warning.line

  fix = Linter.build_prefer_let_else_fix(lines, warning.line - 1, symbol_name: warning.symbol_name)
  return [] unless fix

  [FixEdit.new(start_line: fix[:start_line_idx], start_char: 0, end_line: fix[:end_line_idx] + 1, end_char: 0, new_text: fix[:new_text])]
end

.prefer_var_else_edits(lines, warning) ⇒ Object 



90
91
92
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 90

def prefer_var_else_edits(lines, warning)
  prefer_let_else_edits(lines, warning)
end

.redundant_bool_compare_edits(lines, warning) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 94

def redundant_bool_compare_edits(lines, warning)
  return [] unless warning.line && warning.column && warning.length

  line_idx = warning.line - 1
  line = lines[line_idx]
  return [] unless line

  start_char = warning.column - 1
  end_char = start_char + warning.length
  return [] if start_char.negative? || end_char > line.length

  expr_text = line[start_char...end_char]
  replacement = Linter.redundant_bool_compare_replacement(expr_text)
  return [] unless replacement

  [FixEdit.new(start_line: line_idx, start_char:, end_line: line_idx, end_char:, new_text: replacement)]
end

.redundant_cast_edits(lines, warning) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 201

def redundant_cast_edits(lines, warning)
  return [] unless warning.line && warning.column

  line_idx = warning.line - 1
  line = lines[line_idx]
  return [] unless line

  start = warning.column - 1
  return [] unless start >= 0 && start < line.length

  # The warning column points at the cast target type. Delete the
  # `TargetType<-` prefix, keeping the inner expression as-is. This
  # covers both bare (`ulong<-x`) and parenthesized (`uint<-(a - b)`)
  # forms; type refs never contain `<`, so the first `<-` at/after the
  # column is the cast arrow.
  arrow = line.index("<-", start)
  return [] unless arrow

  type_ref = line[start...arrow]
  return [] unless type_ref.match?(/\A[A-Za-z_][A-Za-z0-9_\[\]\.,\s@]*\z/)

  # When the cast is inside an `unsafe:` expression, also remove the
  # `unsafe: ` wrapper. Look backward from the cast for `unsafe:`.
  new_start = start
  unsafe_keyword = line.rindex("unsafe:", new_start)
  if unsafe_keyword
    prefix = line[unsafe_keyword...new_start]
    if prefix.match?(/\Aunsafe:\s*\z/)
      new_start = unsafe_keyword
    end
  end

  [FixEdit.new(start_line: line_idx, start_char: new_start, end_line: line_idx, end_char: arrow + 2, new_text: "")]
end

.redundant_else_edits(lines, warning) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 112

def redundant_else_edits(lines, warning)
  return [] unless warning.line

  diag_idx = warning.line - 1
  return [] if diag_idx.negative?

  if lines[diag_idx]&.match?(/\A\s*else:\s*\z/)
    else_idx = diag_idx
    first_body_idx = else_idx + 1
  else
    first_body_idx = diag_idx
    return [] if first_body_idx < 1

    else_idx = (0...first_body_idx).to_a.reverse.find { |i| lines[i]&.match?(/\A\s*else:\s*\z/) }
  end
  return [] unless else_idx
  return [] if first_body_idx >= lines.length

  else_indent = lines[else_idx].match(/\A(\s*)/)[1]
  body_indent = "#{else_indent}    "

  body_end_idx = first_body_idx
  (first_body_idx...lines.length).each do |i|
    l = lines[i]
    if l.chomp.empty? || l.start_with?(body_indent)
      body_end_idx = i
    else
      break
    end
  end

  new_body = lines[first_body_idx..body_end_idx].map { |l| l.sub(/\A    /, "") }.join
  [FixEdit.new(start_line: else_idx, start_char: 0, end_line: body_end_idx + 1, end_char: 0, new_text: new_body)]
end

.redundant_ignored_match_binding_edits(lines, warning) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 68

def redundant_ignored_match_binding_edits(lines, warning)
  return [] unless warning.line && warning.column

  line_idx = warning.line - 1
  line = lines[line_idx]
  return [] unless line

  span = Linter.redundant_ignored_match_binding_span(line, column: warning.column)
  return [] unless span

  [FixEdit.new(start_line: line_idx, start_char: span[:start_char], end_line: line_idx, end_char: span[:end_char], new_text: "")]
end

.redundant_return_edits(lines, warning) ⇒ Object 



147
148
149
150
151
152
153
154
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 147

def redundant_return_edits(lines, warning)
  return [] unless warning.line

  line_idx = warning.line - 1
  return [] unless lines[line_idx]&.match?(/\A\s*return\s*\z/)

  [FixEdit.new(start_line: line_idx, start_char: 0, end_line: line_idx + 1, end_char: 0, new_text: "")]
end

.redundant_type_annotation_edits(lines, warning) ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 179

def redundant_type_annotation_edits(lines, warning)
  return [] unless warning.line

  line_idx = warning.line - 1
  line = lines[line_idx]
  return [] unless line

  name_len = warning.length
  col = warning.column - 1
  return [] if col.negative? || col + name_len > line.length

  after_name = col + name_len
  rest = line[after_name..]
  return [] unless rest

  type_match = rest.match(/\s*:\s*\S+/)
  return [] unless type_match

  new_line = +"#{line[0...after_name]}#{rest[type_match.end(0)..]}"
  [FixEdit.new(start_line: line_idx, start_char: 0, end_line: line_idx + 1, end_char: 0, new_text: new_line)]
end

.trailing_list_comma_edits(lines, warning) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 165

def trailing_list_comma_edits(lines, warning)
  return [] unless warning.line && warning.column

  line_idx = warning.line - 1
  line = lines[line_idx]
  return [] unless line

  char_idx = warning.column - 1
  return [] if char_idx.negative? || char_idx >= line.length
  return [] unless line[char_idx] == ","

  [FixEdit.new(start_line: line_idx, start_char: char_idx, end_line: line_idx, end_char: char_idx + 1, new_text: "")]
end

.unused_import_edits(lines, warning) ⇒ Object 



156
157
158
159
160
161
162
163
 
# File 'lib/milk_tea/tooling/linter/fix_engine.rb', line 156

def unused_import_edits(lines, warning)
  return [] unless warning.line

  line_idx = warning.line - 1
  return [] unless lines[line_idx]&.match?(/\A\s*import\b/)

  [FixEdit.new(start_line: line_idx, start_char: 0, end_line: line_idx + 1, end_char: 0, new_text: "")]
end