check_project locally screens also explicit local folders

[w-jan]

check_project() checks the entire project. This is a logical step to keep the entire project tidy. Very good ! When I run check_project() locally, it also checks folders in .gitignore, which will therefore remain local. Is there a way to exclude this specific folder(s)? Thanks a lot for giving a solution !

[ThierryO]

Currently only check_spelling() has infrastructure to ignore certain files. All other checks handle all files. The GHA sees only the files under version control. Locally it handles also files in .gitignore or untracked files. Personally, I either fix problems in these files or ignore the issues.

[w-jan]

Thank you ThierryO, It was an answer I'd kind of expected ;-). I was hoping something could be done under the hood (as default). In my case, it's a lot of work to get that copied code state of the art, and it's now taking up a lot of lintr's time.

[ThierryO]

Applying check_lintr() to an existing code base can be a pain in the ass. Been there, done that. That's why I recommend to start using checklist when starting a new project.

[ElsLommelen]

If it is one specific file and mainly lintr causes the problems, maybe ignoring the lintr of this file with #nolint start and #nolint end could be a solution here?

[w-jan]

yes indeed, that helps a lot. Thank you

[ThierryO]

You should keep the usage of #nolint start and #nolint end to a minimum. It is safer to add #nolint only specific lines of code.

[ElsLommelen]

Yes, I have not explicitly mentioned, but this is only meant for this local file that you want to ignore. In other cases, it is more safely to explicitly mute the linter you want to remove by adding for instance #nolint: line_lengt_linter if the code in this specific case cannot be split over 2 lines for some reason. When just ignoring everything, there is of course no advantage anymore in using these tests. ;-)

[hansvancalster]

Maybe https://lintr.r-lib.org/reference/exclude.html works for excluding files or directories? I'm not sure checklist will allow it.

[ElsLommelen]

I'm sure for packages checklist doesn't allow to make up your own style in this way, but I don't know for sure about projects... It mainly depends on settings in your R-installation, and I would not start changing that as well for just a (temporary?) copied file. So feel free to test this suggestion, but just accept if this doesn't work. ;-)

[w-jan]

yes, checklist allows it. thank you for the info !

[ThierryO]

I'm sure for packages checklist doesn't allow to make up your own style in this way, but I don't know for sure about projects...

check_lintr() is a bit more flexible than it used to be.

1. If your organisation has defined a .lintr file (INBO does), then it will always use that file.
2. check_lintr() uses the .lintr from your repository when there is no .lintr at the organisation level.
3. Fall back to the build in .lintr from checklist when there is no local or organisational .lintr.

[ElsLommelen]

Good to know! But how does it work exacly, when do you get the organisation .lintr? If you are adding the organisation name to your checklist package, checklist project or flandersqmd website? Or only when using INBO style in Dutch (and not Flanders style)? (From your explanation I don't understand exactly which setup choice(s) triggers the addition of the organisation .lintr.)

[ThierryO]

See https://inbo.github.io/checklist/articles/organisation.html#using-the-organisations-default-org_list