Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lintr in CI #3

Closed
ErdaradunGaztea opened this issue Nov 3, 2023 · 1 comment
Closed

lintr in CI #3

ErdaradunGaztea opened this issue Nov 3, 2023 · 1 comment
Milestone

Comments

@ErdaradunGaztea
Copy link
Contributor

ErdaradunGaztea commented Nov 3, 2023

Kod powinien obowiązkowo przechodzić lint. Typowe wywołanie to lintr::lint("ścieżka/do/pliku.R") albo lintr::lint_dir("ścieżka/do/folderu").

Jeden lint, który może zwracać dużo uwag i który stoi w sprzeczności z formatowaniem, jakie domyślnie tworzy RStudio, jest:

[trailing_whitespace_linter] Trailing whitespace is superfluous.

Te jedne uwagi możemy ignorować.

Okazjonalnie możemy też zignorować zbyt długie linie:

[line_length_linter] Lines should not be more than 80 characters.

ale zbyt wiele zbyt długich linii negatywnie odciska się na czytelności kodu, więc jedynie dobrze uzasadnione przypadki mają prawo być pozostawione.

Zdarza się też, że nazwy kolumn używane jak zmienne w tidyverse nie są wychwytywane przez linta, co powoduje dużą liczbę kolejnego typu uwag:

[object_usage_linter] no visible binding for global variable ‘NSE_accessed_column’

Da się to zaimplementować tak, aby nie triggerowało tego sprawdzenia... ale myślę, że ucierpiałaby na tym przejrzystość kodu, więc też można wtedy zignorować.

@kamilsi kamilsi changed the title Stylistyka kodu lintr in CI Dec 20, 2023
@kamilsi kamilsi added this to the Test coverage milestone Feb 6, 2024
@kamilsi
Copy link
Contributor

kamilsi commented Feb 7, 2024

Closed with #42

@kamilsi kamilsi closed this as completed Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants