search

PrincetonUniversity / blocklint

MIT License
7 stars 7 forks source link

Add option to skip specific files #14

Closed jaedoucette closed 3 years ago

jaedoucette commented 3 years ago

-> Blocklint currently operates over all files in a specified directory, or over an explicit list of files.

-> In some projects, binary files or other files that are not utf-8 encoded may be present in the directory blocklint should operate over.

-> Users would like some way to indicate that certain files should not be checked

-> Users would also like blocklint to fail gracefully if a non utf-8 encoded file is read.

-> This commit introduces a skip-file argument that is a comma separated list of paths that should not be processed by blocklint. Alternatively a config file may specify such a list of paths spread over multiple lines.

-> Additionally, a new exception is caught in process_file. This was added because a user complained that blocklint errors out with an uninterpretable message when accidentally run on a binary file. I think the desired behavior for this case is to silently skip the file.

jaedoucette commented 3 years ago

A group of users was unable to adopt blocklint successfully because of the issue addressed in this PR. Hoping we can merge this relatively quickly to address their issue.

troycomi commented 3 years ago

Looks great! Thanks for the hard work!

jaedoucette commented 3 years ago

Thanks for the quick merge @troycomi !

Is there an estimated release date for this version to PyPI that I can communicate back to the users who raised this to me? Alternatively, can I help to cut a new release?

troycomi commented 3 years ago

Done, sorry a little slow today!

jaedoucette commented 3 years ago

Fantastic, thanks for your work on this @troycomi ! Really appreciate having this tool!