Commit Graph

2389 Commits

Author SHA1 Message Date
Jeremiah Leary 2f12bbd4dc
Issue #837 (#903): Adding listing of rules in rule groups. 2022-12-21 11:51:29 -06:00
Jeremiah Leary 715d8f4330 Preparing for release 3.14.0 2022-12-13 18:50:26 -06:00
Jeremiah Leary 7fc6404f49
#827 (#838): Updating comment_100 to be configurable.
* Updates for issue #827

Changing behavior of comment_100:

  1)  block comments are ignored
  2)  Exceptions added to ignore rule

* Fixing style issue.

* Adding rule comment_101 to enforce whitespace after a comment pattern.

* Merging comment_101 into comment_100.

* Allowing patterns to be configurable.

* Updating documentation to current standards.

* Updating note.

* Moving Note into description for each option.

* Fixing grammar.
2022-12-13 18:20:22 -06:00
Jeremiah Leary 6a4f748a87
Issue 850 (#861)
* Updates for issue #850

Adding rules to indent with keyword

  1)  Added documentation
  2)  Added tests
  3)  Added rules:
        concurrent_selected_signal_assignment_300
        selected_force_assignment_300
        selected_variable_assignment_300
        selected_waveform_assignment_300

* Adding the following rules:

  concurrent_selected_signal_assignment_500
  selected_force_assignment_500
  selected_variable_assignment_500
  selected_waveform_assignment_500

* Adding rules:

  concurrent_selected_signal_assignment_501
  selected_force_assignment
  selected_variable_assignment
  selected_waveform_assignment

* Adding rule:

  selected_force_assignment_502

* Fixing documentation.

* Adding rule selected_expressions_500

* Adding rule selected_waveforms_500.

* Adding rules:

  concurrent_selected_signal_assignment_100
  selected_force_assignment_100
  selected_variable_assignment_100
  selected_waveform_assignment_100

* Adding rules:

  concurrent_selected_signal_assignment_101
  selected_force_assignment_101
  selected_variable_assignment_101
  selected_waveform_assignment_101

* Adding rules:

  concurrent_selected_signal_assignment_102
  select_force_assignment_102
  select_variable_assignment_102
  select_waveform_assignment_102

* Adding rules:

  concurrent_selected_signal_assignment_103
  selected_force_assignment_103
  selected_varaible_assignment_103
  selected_waveform_assignment_103

* Adding rules:

  concurrent_selected_signal_assignment_104
  selected_force_assignment_104
  selected_variable_assignment_104
  selected_waveform_assignment_104

* Added rule selected_force_assignment_105.

* Adding rules:

  selected_expressions_100
  selected_waveforms_100

* Adding rules:

  selected_expressions_101
  selected_waveforms_101

* Adding structure base rule.

Adding rule selected_assignment_001

* Refactoring analysis functions to improve readability.

* Adding more options to rule selected_assignment_001.

* Adding documentation for selected_assignment rules.

* Adding rule selected_assignment_100.

* Adding rule selected_assignment_101.

* Adding rule selected_assignment_102.

* Adding rule selected_assignment_103.

* Adding rule selected_assignment_104.

* Adding rule selected_assignment_105.

* Adding rule selected_assignment_106.

* Adding rule selected_assignment_107.

* Removing unused file.

* Adding rule selected_assignment_500.

* Adding rule selected_assignment_501.

* Adding rule selected_assignment_502.

* Adding rule selected_assignment_503.

* Adding rule selected_assignment_300.

* Removing rules which were merged into selected_assignments.

  * concurrent_selected_signal_assignment
  * selected_force_assignment
  * selected_variable_assignment
  * selected_waveforms

* Updating indenting on selected with and semicolon keywords.

* Deprecating rule with_001.

* Adding rule selected_assignment_400.

Minor update to multiline_alignment_between_tokens base rule to support selected_assignment_400.

* Fixing yaml configuration.

* Fixing tags.

* Fixing last yaml example.

* Removing rule selected_assignment_001

* Removing unused directories.

* Fixing documentation links.

* Saving previous rule_001 to a temporary file.

* Adding rule selected_assignment_001

* Adding rule selected_assignment_002.

* Adding rule selected_assignment_003

* Adding rule selected_assignment_004.

* Removing subphase from rules.

* Adding rule selected_assingment_005.

* Adding rule selected_assignment_006.

* Fixing issue in base rule where processing order was not being preserved.

* Adding rule selected_assignment_007.

* Adding rule selected_assignment_008.

* Updated base rule to accept token pairs.

* Updating rule to use token pairs.

* Adding rule selected_assignment_009.

* Adding rule selected_assignment_010.

* Adding rule selected_assignment_011.

* Adding rule selected_assignment_012.

* Minor update to rule documentatin.
2022-12-13 18:06:54 -06:00
Jeremiah Leary d3b8e703e8
Issue 864 (#895)
* Issue #864, #887 : Adding rule declarative_part_400 to align := in signal, variable and constant declarations.

* Ensuring alignment rules are performed in order.

* Updating minor issues flagged by codeclimate.

* Changing blank_line_ends_group to True.
2022-12-13 18:05:24 -06:00
Jeremiah Leary 931b44fabd
#898 (#899): Updating installation instructions when using pip. 2022-12-09 12:08:33 -06:00
Jeremiah Leary cb2cca006a
#892 (#893): VSG would crash if code after last ) in array assignment
* Issue #892:  VSG would crash if code after last ) in array assignment was on a different line.

* Refactoring to improve readability.
2022-12-01 06:03:11 -06:00
Jeremiah Leary ead8c07780
#890 (#891) : Fixing parsing error for constants and signals with default assignments in subprogram parameters. 2022-11-29 07:25:56 -06:00
Jeremiah Leary 4ecbbec6de
#886 (#889) : Adding rule procedure_call_101
* Issue #886 : Adding rule procedure_call_101

* Removing duplicate base rule.
2022-11-29 07:10:45 -06:00
Jeremiah Leary 8994593af9
#884 (#885) : Rule procedure_call_401 was adding addition whitespace when not needed. 2022-11-29 05:41:07 -06:00
Jeremiah Leary 990565cf72
#878 (#879): Fixing whitespace_007 rule triggers in pragmas. 2022-11-21 07:34:36 -06:00
Jeremiah Leary 85b1348852
#876 (#877): Removing or enabling skipped tests. 2022-11-21 07:06:58 -06:00
Jeremiah Leary 65a8641c2e
#874 (#875): Suppressing stderr for argparse tests. 2022-11-19 09:54:31 -06:00
Jeremiah Leary c367786eea
#847 (#849) : Fixing globbing of files and configurations passed at command line under windows.
* Updates for issue #847

Fixing globbing in the -f command line option.

* Adding tests for cmd_line_args file.

* Updating tests to work during CI testing.
2022-11-19 06:55:29 -06:00
Jeremiah Leary 1da70d7fbe Fixing failing test. 2022-11-14 19:09:29 -06:00
Jeremiah Leary fe6c2cc160 Merge branch 'master' of https://github.com/jeremiah-c-leary/vhdl-style-guide 2022-11-14 19:06:16 -06:00
Jeremiah Leary 7a11838514
#859 (#862): Updating "Fix" output on rule block_400. 2022-11-14 18:40:31 -06:00
Jeremiah Leary 10e73f297c Adding theory of operation section. 2022-11-13 15:35:02 -06:00
Jeremiah Leary 6b01c4c6d1
#871 (#872): Updating documentation links.
* Issue #830:  Updating documentation links.

* Adding length rule link validation.

* Removing blank line at end of file.

* Fixing typo

* Updating links.

* Added test to check for underscores in links.

* Updating whitespace configuration links.

* Updating blank line links.

* Updating structure links.

* Updating naming rule links.

* Adding alignment configuration links.
2022-11-13 12:02:54 -06:00
JHertz5 0cf42a6ff6
#869 (#870): Corrected broken URL for rule if_030 in Configuring Blank Lines page.
Corrected broken URL for rule if_030 in Configuring Blank Lines page.

Co-authored-by: Jukka Hertzog <jukka.herzog@live.co.uk>
2022-11-13 07:30:50 -06:00
JHertz5 fbf52bae30
#867 (#868): Correction in concurrent procedure call configuration documentation.
Correction in concurrent procedure call configuration documentation.

Co-authored-by: Jukka Hertzog <jukka.herzog@live.co.uk>
2022-11-12 13:00:50 -06:00
Jeremiah Leary 85c260be42
#863 (#865): Invalid configurations will now stop processing of all file. 2022-11-12 07:42:34 -06:00
Jeremiah Leary 7ea23f0fd2 Preparing for relesae 3.13.1 2022-11-07 06:12:17 -06:00
Jeremiah Leary afab411088 Commenting out old release method. 2022-11-07 06:11:07 -06:00
Jeremiah Leary 4b16b817bb
Updates for issue #855 (#858)
Adding expection to case rules for values that are enclosed with double quotes.
2022-11-07 05:56:06 -06:00
Jeremiah Leary e408ec8997
Issue 854 (#857)
* Updates for issue #854

Fixing array detection logic in base rule multiline_array_alignment.

* Updating array detection logic in multiline_structure base rule.

* Refactoring to improve readability.
2022-11-07 05:55:40 -06:00
Jeremiah Leary dc57b0fd62
Updates for issue #851 (#860)
Adding tests to validate links to configuration documenation.
2022-11-04 14:02:58 -05:00
Jeremiah Leary e810689292
Issue 852 (#856)
* Updates for issue #852

Adding support the attributes in subtype indications.

  1)  Updated classifier subtype_indication to call type_mark
  2)  Updated get_sequence_of_tokens_matching

* Removing comments.
2022-11-04 09:01:33 -05:00
Jeremiah Leary 8d29a56f7c Preparing for release 3.13.0. 2022-10-23 07:05:28 -05:00
Jeremiah Leary cbc89e10a1 Updating tests to clean up after themselves. 2022-10-23 06:58:47 -05:00
Jeremiah Leary 6aea9e7e2c Adding structure::optional tag to rule architecture_010. 2022-10-21 19:09:11 -05:00
Jeremiah Leary cb98aebdcb
Updates for issue #846 (#848)
* Updates for issue #846

Rules whitespace_012 and whitespace_200 were duplicates.

   1) Moved whitespace_012 to whitespace_200.
   2) Deprecated whitespace_012

* Adding missing documentation.
2022-10-21 06:41:17 -05:00
Jeremiah Leary 1ec96d9b96 Adding announcement. 2022-10-20 19:14:41 -05:00
Jeremiah Leary f594818e21 Removing invalid link in whitespace_002 rule documentation. 2022-10-20 18:46:58 -05:00
Jeremiah Leary d66da9a6a8
Issue 549a (#839)
* Updates for issue #549

Refactoring concurrent_011 into base rule multiline_simple_structure.

* Refactoring concurrent_009 into base rule multiline_conditional_alignment.

* Fixing name and identifier.

* Refactoring rule constant_012 into base rule multiline_array_alignment.

* Adding rule variable_assignment_007.

* Adding rule variable_assignment_008

  1)  Refactored multiline_structure to be configurable
  2)  Added documentation
  3)  Added tests

* Adding rule variable_assignment_400.

* Adding rule variable_assignment_400.

* Updating Documentation

  1)  Adding files which were not being built
  2)  Fixed links

* Adding rule concurrent_012.

* Adding rule concurrent_401

* Adding rule sequential_008.

* Adding rule sequential_009.

* Adding rule sequential_401

* Adding rule sequential_402

* Fixing documentation

* Fixing table rendering.

* Changing multiline_alignment_between_tokens to not work on arrays.

* Updating rule concurrent_011 to not operate on arrays.

* Fixing documentation issues:

  1)  Renamed several rules to improve readability
  2)  Fixed warnings from sphynx
  3)  Fixing links

* Adding links to rules.

* Updating docstring with correct links to configuration documentation.

* Updating formatting to match current standards.

* Updating formatting to current standard.

* Changing depricated to deprecated.

* Removing unused documentation.

* Updating table to current standards.

* Updating to latest standard.

* Updating to current formatting standards.

* Updating multiline indent rule:

  1)  Updated documentation
  2)  Added align left no align paren on tests
  3)  Updated the following options:
      a)  align_left_yes_align_paren_yes
  4)  Updated docstrings to have correct links.

* Adding example for align_left_no_align_paren_yes.

* Updating documentation per comments.

* Updating documentation per comments.

* Removing option move_last_comment from multiline_structure base rule.
2022-10-20 18:24:42 -05:00
Jeremiah Leary 4cd006748b
Updates for issue #843 (#844)
Adding case rule for enumerates types in type definitions.

  1)  Added documentation
  2)  Added test case
  3)  Added rule type_500
2022-10-18 17:02:12 -05:00
Jeremiah Leary 01dcf62648
Updates for issue #842 (#845)
Adding prefix/suffix rules for loop labels:

  1)  Added documentation
  2)  Added test cases
  3)  Added rules
      a)  loop_statement_600
      b)  loop_statement_601
2022-10-18 17:01:15 -05:00
Jeremiah Leary cc1242ee3b Minor updates to documentation. 2022-10-12 07:51:48 -05:00
Jeremiah Leary 79baa53d76
Updates for issue #832 (#835)
* Updates for issue #832

Added parameter to allow generate statement keywords to end groups.

  1)  Added tests
  2)  Added generate_statements_ends_group option to base rule configuring_keyword_alignment_rules
  3)  Updated documentation

* Defaulting generate_statement_ends_group option to false.

* Making generate_statement_ends_group enabled by default.
2022-10-10 06:35:50 -05:00
Jeremiah Leary 9f65068692
Updates for issue #559: (#798)
* Updates for issue #559:

Adding documentation for configuring indent rules.

* Adding documentation:

  1)  Updated whitespace_002
  2)  Added whitespace_014
  3)  Added configuring tabs vs spaces

* Adding example documentation.
Fixing table.

* Updated documentation:

  1)  Removed whitespace_014
  2)  Updated whitespace_002 to only work on middle tabs
  3)  Removed configuring_tabs_vs_spaces document
  4)  Removed tabs as an option for indenting

* Updating token indent rules.

* Adding smart_tabs test for rule assert_statement_001

* Updating rule assert_400 to allow smart tabs.

* Refactoring assert_400 to improve readability.

* Refactoring to reduce complexity.

* Updates for rule case_011 and assert_400:

  1) Replaced align_consecutive_lines_after_line_starting_with_token_and_stopping_with_token with assert_400
  2) Updated rule assert_400 to inherit align rule
  3) Changed rule case_011 to use align rule

* Removing rule case_021.

The function of the rule is now covered by comment_010.

* Deprecating rule case_generate_alternative_300.

* Refactoring analyze to _analyze.

* Splitting configuration of rule assert_400 into its own page.

* Updating multiline_alignment_between_tokens to handle smart tabs.

* Deprecating rules if_032 and if_033.  They are covered by comment_010.

* Updated report_statement_400 to use align_consecutive_lines_after_line_starting_with_token_and_stopping_with_token.

* Updating rule process_028 to handle smart-tabs

 1) Updated tests
 2) Updated base rule align_left_token_with_right_token_if_right_token_starts_a_line

* Updating rule library_009 to handle smart-tabs

  1)  Updated tests
  2)  Updated base rule align_consecutive_lines_starting_with_a_comment_above_line_starting_with_token

* Minor formatting updates.

* Adding methods to support multiline alignment base class.

* Refactored rule constant_012 to split indent and alignment whitespace.

* Adding smart-tab support to rule constant_012.

* Removing old classify code.

* Removing debug print statement.

* Updating documentation for assert and report_statement rules.

* Updating rule concurrent_009 to support smart-tabs.

  1)  Added tests
  2)  Updated rule to support smart-tabs

* Updating documentation to match current implementation.

* Taking a different approach for multiline_alignment_between_tokens.

  1)  Reverted smart_tabs changes
  2)  Updated base rule to method employed on concurrent_009
  3)  Commented out smart_tab tests

* Updated missing meta data to Toi in rule constant_014

Fixed error in align_left_no_align_paren_no analyzer.

* Adding smart-tab support to base rule multiline_alignment_between_tokens.

* Updating alignment rules to support smart tabs.

  1)  Updated base rules
      a) vsg/rules/align_tokens_in_region_between_tokens.py
      b) vsg/rules/align_tokens_in_region_between_tokens_skipping_lines_starting_with_tokens.py
      c) vsg/rules/align_tokens_in_region_between_tokens_unless_between_tokens.py
  2)  Updated rule concurrent_008
  3)  Added tests

* Fixing issue with rule port_map_009 misfiring if the following token sequence occured:  comma, whitespace, carraige return.

* Updating solution for indent rules to give required tabs and spaces.
Fixing several bugs in indent implementation:
  1)  checking for smart-tabs instead of smart_tabs

* Updates for Codacy issues.

* Additional Codacy updates.

* Fixing style issues identified by CodeClimate.

* Additional style fixes identified by CodeClimate.

* Refactoring alignment rules:

  1)  Created utils file specifically for alignment rules
  2)  Refactored rules to move identical code into utils file

* Moving update_column_width into alignment_utils file.

* Moving functions into alignment_utils:
  1)  get_first_line_info
  2)  starts_with_paren

* Using functions in alignment_utils.

* Collapsing branches to improve readability.

* Refactoring to improve readability.
2022-10-07 08:01:03 -05:00
Jeremiah Leary 4ec07b476e
Updates for issue #831 (#836)
Files which fail to parse will will be included in JUnit output.

  1)  Added test
  2)  Output parse failures to JUnit files
2022-10-05 08:18:26 -05:00
Jeremiah Leary 24dce78940
Updates for issue #833 (#834)
Pragma comments were being update by rule comment_100 when they should not have been

  1)  Added tests
  2)  Updated classification of pragmas to the pragma itself
2022-10-05 06:14:01 -05:00
Jeremiah Leary 804044619b
Updates for issue #829 (#830)
Rule port_026 was not copying tokens which caused rule entity_017 to misbehave.

  1)  Updated tests
  2)  Updated rule port_026
2022-10-04 05:48:48 -05:00
Jeremiah Leary 3296fee4cc
Issue 536 (#793)
* Updates for issue #536:

Adding classification of aggregate open and close parenthesis.

* Adding rules to address aligning => operator in record assignments.

  1)  Added rules:
      * concurrent_400
      * sequential_400
  2)  Added tests
  3)  Added documentation

* Minor formatting updates.

* Adding import of aggregate to fix runtime error.
2022-09-25 13:11:21 -05:00
Jeremiah Leary 607e2b9fc3
Updates for issue #825 (#826)
Adding rules for conditional_waveforms and conditional_expressions.

  1)  Added documentation
  2)  Added tests
  3)  Added rules
2022-09-25 12:44:25 -05:00
Jeremiah Leary 9f2c4f580f Adding release process documentation. 2022-09-22 20:38:19 -05:00
Jeremiah Leary 5b375e7403 Preparing for release 3.12.2 2022-09-22 20:19:19 -05:00
Jeremiah Leary d9f4e72895
Updates for issue #821 (#824)
The else keyword in the when statement without a space before it would fail when_001.

  1)  Added tests to expose issue
  2)  Updated rule when_001 to handle no spaces before else keyword
2022-09-22 20:16:32 -05:00
Jeremiah Leary 231d37592f
Updates for issue #820: (#823)
Configuring whitespace to 0 would not enforce 0 whitespace.

  1)  Updated tests
  2)  Updated whitespace_between_tokens base rule
2022-09-22 08:24:17 -05:00
Jeremiah Leary 76a0201f26
Updates for issue #819 (#822)
Constraints with parenthesis would not properly classify.

  1)  Updated test to expose issue
  2)  Updated constraint classifer to properly handle parenthesis
2022-09-22 08:23:29 -05:00