Any way for `pants` to ignore linting formatting checking an

Question

Any way for `pants` to ignore linting formatting checking an entire directory tree Our current build doesn t try and lint fmt check any directory trees that aren t XYZ and for migration I d like to keep this behavior Hopefully adding a handful of `skip ABC` in each `BUILD` isn t the way grimacing

bitter-ability-32190 · Answer

Still want to do other things like `run` and `test` though

hundreds-father-404 · Answer

The way to do that is `skip tool` field What s the hesitation Definitely curious how that can be improved Some ideas that have been thrown out 1 Make it easier to programmatically update BUILD files 2 Add an `overrides` inheritance mechanism <https docs google com document d 1bcQRJazx6ODKc0PZRUgPx bqHc6XurpBawTMD2zhtAk edit>

busy-vase-39202 · Answer

This passage isn t included in the the incremental adoption page so is easy to miss initially but <https www pantsbuild org docs python linters and formatters skipping a formatter or linter>

fast-nail-55400 · Answer

during migration maybe just add tags to the targets to which lint fmt check should apply and then just filter to those tags using ` tag`

bitter-ability-32190 · Answer

Stop gap might be telling those tools to ignore the files but that does mean we re still running the tools on those files

bitter-ability-32190 · Answer

gt What s the hesitation There s a lot of files dirs in the not linted locations grimacing But also there s a lot in the linted locations So opt out or opt in at the `BUILD` level is certainly doable and one time cost but oof

witty-crayon-22786 · Answer

< fast nail 55400> that s effectively what the `skip $tool` args do but natively

fast-nail-55400 · Answer

well they are the inversion of that since you d have to mark all of the targets that should be opted out right

witty-crayon-22786 · Answer

ah got it

bitter-ability-32190 · Answer

gt Definitely curious how that can be improved Pants has a config ignore maybe that can be extended per tool

bitter-ability-32190 · Answer

` pylint ignore= ` etc

bitter-ability-32190 · Answer

If y all are down that s an easy enough Feature Request to make and to add eyes

bitter-ability-32190 · Answer

might be just as much time as scrubbing my `BUILD` files to add the skip flags joy

hundreds-father-404 · Answer

Oh that s an interesting idea Ignore by path target both Target is slightly weird because you should arguably put the metadata near where it lives

bitter-ability-32190 · Answer

< hundreds father 404> probably gitignore style a la

witty-crayon-22786 · Answer

it is likely that we will at some point support filesystem hierarchical target metadata

bitter-ability-32190 · Answer

In layman s terms

witty-crayon-22786 · Answer

a way to define target fields in a parent directory and have it apply to children

witty-crayon-22786 · Answer

with metadata in child directories overriding parents

hundreds-father-404 · Answer

what that google doc refers to

witty-crayon-22786 · Answer

yea maybe unclear whether it will be typed `python sources` or untyped `override`

clean-city-64472 · Answer

We are doing this with mypy using its `ignore error` setting combined with ability to have config sections per module ` mypy my module ` I wonder if the other tools that are implicated have similar settings that make it easier to ignore entire directory trees

bitter-ability-32190 · Answer

< clean city 64472> All do but I ve found Some don t respect the skip ignore if the file is explicitly provided `isort` does this It s like you told me to ignore this dir but are explicitly asking me to sort this file so I ll sort it Pants will still be doing the work of invoking the tool IIUC which is less than ideal

hundreds-father-404 · Answer

And some tools like docformatter do not have the option We want with Pants to provide a consistent interface where reasonable for all your different tools regardless of language etc