get-woke / woke

Detect non-inclusive language in your source code.
https://docs.getwoke.tech
MIT License
457 stars 61 forks source link

Pinpoint the location of 'findings' when you report there are 'findings'. #274

Open kdvolder opened 1 year ago

kdvolder commented 1 year ago

Is your feature request related to a problem? Please describe. Woke output is very annoying because it tells you it found a 'bad' word but gives no clues about where.

Describe the solution you'd like Print the name of the file and line number where you found a violation. That would be very helpful to find said violation without trying to search every file in your project.

Describe alternatives you've considered Scan every file in the project manually but that is cumbersome (it's why we use a tool like woke... so we wouldn't have to do this in the first place).

Additional context

This is a sample output I get:

Running woke ...
  Error: `Kill` may be insensitive, use `stop`, `halt` instead
  Error: files with findings: 1
  2023-07-[26](https://github.com/vmware-tanzu/tanzu-developer-tools-for-intellij/actions/runs/5674096690/job/15377009012?pr=260#step:25:29)T22:01:43Z FTL error="files with findings: 1"
  Error: Process completed with exit code 1.

So... it tells me there is 1 file with findings. That begs the question what file? Also if the file is large, a line number would be helpful as well.

github-actions[bot] commented 1 year ago

👋 Thanks for submitting your first issue!

Please be sure to read and follow our Code of Conduct and Contributing guide.

⭐️ Is your org or open source project using woke? If so, we'd love for you to be included in the 'Who uses woke' list at https://github.com/get-woke/woke/blob/main/docs/about.md#who-uses-woke.