sds / haml-lint / 29270290596

97%

push

github

Add corrected/correctable flags to offense output (#676)

## Summary

Brings haml-lint's output to parity with RuboCop's JSON format by adding
two per-offense flags:

- **`corrected`** — whether the offense was fixed by auto-correct
(already tracked internally, now surfaced).
- **`correctable`** — whether the offense *could* be auto-corrected
(new).

This mirrors what `rubocop -f json` reports for the same embedded Ruby
(e.g. `"corrected": false, "correctable": true`).

## Output examples

Given `- if some_var = value` in a template, `haml-lint -r json` now
emits per offense:

```json
{
  "severity": "warning",
  "message": "Lint/AssignmentInCondition: Use `==` if ...",
  "corrected": false,
  "correctable": true,
  "location": { "line": 1 },
  "linter_name": "RuboCop"
}
```

The default text reporter marks correctable-but-uncorrected lints with
`[Correctable]`, alongside the existing `[Corrected]`:

```
verify.haml:1 [W] [Correctable] RuboCop: Lint/AssignmentInCondition: Use `==` if you meant to do a comparison ...
verify.haml:2 [W] [Correctable] TrailingWhitespace: Line contains trailing whitespace
```

Running with `-a`, a fixed offense flips to `corrected: true` (and
`[Corrected]` in text):

```json
{ "message": "Line contains trailing whitespace", "corrected": true, "correctable": true, "location": { "line": 2 } }
```

## How

- `Lint` gains a `correctable` attribute alongside `corrected`.
- Base `record_lint` defaults `correctable` to the linter's
`supports_autocorrect?`, so every HAML linter is covered without editing
each file. A linter can pass `correctable: false` for offenses it can't
fix.
- The RuboCop linter threads RuboCop's own per-offense
`offense.correctable?`, correctly distinguishing cops that support
autofix from those that don't (rather than assuming the whole linter is
correctable).
- Syntax/processing errors stay `correctable: false`.

Co-authored-by: Shane da Silva <shane@dasilva.io>

7 of 8 new or added lines in 4 files covered. (87.5%)

3154 of 3235 relevant lines covered (97.5%)

23149.0 hits per line