jeremiah-c-leary / vhdl-style-guide

Style guide enforcement for VHDL
GNU General Public License v3.0
192 stars 39 forks source link

generate_011 does not have the `action` configuration option #975

Closed JHertz5 closed 1 year ago

JHertz5 commented 1 year ago

Environment v3.16.0

Describe the bug The rule generate_011 configures an optional VHDL item, and is part of the structure::optional group. However, it does not have an action configuration like the other optional item rules. This means that, even though generate_011 is part of this group, it isn't affected by setting this action configuration for the group.

To Reproduce Steps to reproduce the behavior:

  1. Run vsg -rc generate_011
  2. See that output does not include the action: '[add|remove]' option

Expected behavior I expect generate_011 to have this configuration item so that it can be configured along with the rest of the group.

Screenshots None

Additional context None

jeremiah-c-leary commented 1 year ago

Afternoon @JHertz5 ,

I pushed an update for this issue to the issue-975 branch. When you get a chance could you validate it works on your end.

Thanks,

--Jeremy

JHertz5 commented 1 year ago

Hi @jeremiah-c-leary. Thank you so much! I have taken a look. It is working excellently, except for the following error message when the rule is configured to remove the label:

================================================================================
File:  test.vhd
================================================================================
Phase 1 of 7... Reporting
Total Rules Checked: 157
Total Violations:    1
  Error   :     1
  Warning :     0
----------------------------+------------+------------+--------------------------------------
  Rule                      |  severity  |  line(s)   | Solution
----------------------------+------------+------------+--------------------------------------
  generate_011              | Error      |          7 | Remove Add generate label
----------------------------+------------+------------+--------------------------------------
NOTE: Refer to online documentation at https://vhdl-style-guide.readthedocs.io/en/latest/index.html for more information.

The solution message says "Remove Add generate label, where I would expect it to only say "Remove generate label".

I have added a review to the pull request to suggest a fix, I hope that is ok.

JHertz5 commented 1 year ago

@jeremiah-c-leary Thanks, the update has resolved that issue. It all looks good to me!

jeremiah-c-leary commented 1 year ago

Sweet,

I will merge this to master.

--Jeremy