search

get-alex / alex

Catch insensitive, inconsiderate writing
https://alexjs.com
MIT License
4.8k stars 207 forks source link

Option to suppress `Cannot process specified file: it’s ignored` error #348

Open mfisher87 opened 4 months ago

mfisher87 commented 4 months ago

Subject of the feature

I would like to be able to ignore or suppress the Cannot process specified file: it’s ignored error because I want to run AlexJS with pre-commit (https://pre-commit.com).

I'm using this hook: https://github.com/mfisher87/alexjs-pre-commit-mirror

Problem

The way pre-commit automates running programs is by passing changed files to that program. If, for example, I ignore *.csv in .alexignore, then run pre-commit after changing foo.csv, pre-commit will call alex foo.csv, and AlexJS will complain and cause the check to fail even though everything is fine:

data/acadia.csv
  1:1  error  Cannot process specified file: it’s ignored

Expected behaviour

I'd like to pass an arg, for example --suppress-ignored-file-error, to convert this error to a warning, or to suppress it entirely.

Alternatives

wooorm commented 4 months ago

There’s a silentlyIgnore option for the engine, which is used in the CLI. A PR adding a --silently-ignore flag that turns that on is welcome!

mfisher87 commented 4 months ago

Thanks for that useful context! I'll try and make some time, but I do have a long backlog right now. If anyone else is looking for this feature, don't wait on me. I'll post here when I am able to get started.