search

tbroadley / spellchecker-cli

A command-line tool for spellchecking files.
MIT License
119 stars 16 forks source link

Ignore URLs #44

Open hkiang01 opened 4 years ago

hkiang01 commented 4 years ago

If I have a url like the following

https://kubernetes.github.io/ingress-nginx/user-guide/tls/#automated-certificate-management-with-kube-lego

and run the cli tool with:

spellchecker --files '**/*.md' --plugins spell --ignore "http.*"

I'll get a warnings like:

warning  `kubernetes.github.io` is misspelt
warning  `ingress-nginx` is misspelt
hkiang01 commented 4 years ago

One solution: surround the url with backticks, but the tool should be able to ignore these errors regardless

tbroadley commented 4 years ago

That makes sense - sounds like the tool should ignore URLs altogether. I'm not actively working on this project anymore, so I can't guarantee that I'll fix this in the near future. I would absolutely review a PR if you happen to feel like creating one!