andreoliwa / nitpick

Enforce the same settings on multiple projects
https://nitpick.readthedocs.io/
MIT License
399 stars 25 forks source link

Allow ignoring some deviations from nitpick style #485

Open sergei-ivanov opened 2 years ago

sergei-ivanov commented 2 years ago

Problem

As a nitpick user, I would like to be able to ignore some deviations from the common style.

We are using a common in-house nitpick style, but some projects do have fully documented, legitimate little deviations from the style. For example, a slightly different dependency constraint, or different tool or logging behaviour. I cannot see an easy way to tell nitpick to ignore those deviations. And it is not practical to define a local style override for just a single value. As a result, nitpick fix turns from being helpful to being destructive.

Possible solution

I would like to have support for meaningful comments like # nitpick:ignore that will force Nitpick to ignore the commented lines.