Linter for FIXME-kommentarar — fixme_stil

Linter som sjekkar at FIXME-markørar i kommentarar er skrivne med store bokstavar, slik kodestilguiden vår krev.

Usage

fixme_stil_linter()

Value

Ein linter i tråd med lintr::Linter().

Details

Kodestilguiden seier at kommentarar om ting som må rettast opp, skal starta med FIXME. Skrivemåtar som fixme, Fixme og !fixme vert derfor melde som feil.

Linteren ser på heile kommentaren, ikkje berre starten av han, slik at òg markørar midt i ein kommentar vert fanga opp (til dømes # Forkortingar som read_csv() brukar (fixme: utvid)).

Merk at linteren berre ser på skrivemåten av markøren. Han seier ingenting om kor mange FIXME-ar ein har, eller om dei bør ryddast bort.

Examples

lintr::lint(
  text = "x = 1 # fixme: rett dette",
  linters = fixme_stil_linter()
)
#> <text>:1:9: style: [fixme_stil_linter] Skriv FIXME med store bokstavar, jf. kodestilguiden.
#> x = 1 # fixme: rett dette
#>         ^~~~~

# Ingen feil
lintr::lint(
  text = "x = 1 # FIXME Rett dette",
  linters = fixme_stil_linter()
)
#> ℹ No lints found.