[Feature]: show me the rule ID when I run `te bpa run`

[justinjbird]

Pre-flight checks

• I have searched existing issues and discussions and could not find a duplicate.

Problem / use case

When I run te bpa run and get an output of violations, I have to run te bpa rules --list to work out the id I need to run te bpa run --fix --rule <rule id> this is complicated further by having to match by the rule text. Providing me the id would avoid this.

Proposed solution

When I run te bpa run and get an output of violations, I want the output to display the ID of the rule that was violated so that I don't have to run te bpa rules --list

Alternatives considered

No response

Who would use this?

Humans (interactive use)

Additional context

No response

[mlonsk]

Hi @justinjbird
Thank you for writing in about this. I can definitely see how this behavior is unproductive, and it would be beneficial to include the ID in the initial output so you can work with it right away. I have reclassified it as a bug, and we will look into how we prioritize this for a future release.

[gronnerup]

Re-classifying this as a feature enhancement and set issue to in-progress. It will be including in the next release.

[gronnerup]

Hi @justinjbird,

We will add the RULE_ID as a column in the text table. This will be added between the Severity and Rule column.

Meanwhile note that there is a workaround for getting the rule id included in the output. JSON output already includes this and this also goes for the CSV output.