Commit Graph

49 Commits

Author SHA1 Message Date
Alon Bar-Lev c22a86025f style: apply black
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev 5b4bae04aa style: apply isort
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev b8c49b5946 style: python encoding
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev b4d5c4e5d6 cleanup: use super() to call parent
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 18:48:35 +02:00
JHertz5 431cdb92c5
Issue#1117 Modifed initialisation of the `Rule` class's `name` and `identifier` attributes to reduce duplication. (#1118)
* Issue#1117 Modifed initialisation of the `Rule` class's `identifier` property to reduce duplication.

* Issue#1117 Modifed initialisation of the `Rule` class's `unique_id` property to make the `identifier` input redundant.

* Issue#1117: Updated Rule.name attribute to be initialised from the class's `__module__` variable.
Modified `deprecated_rule` to not initialise `name` and `identifier` attributes.
Modified rule_localized_001 to force the local rule's `name` since this can't be extracted from the module.
Modified test_rule to force Rule's `name`, `identifier` and `unique_id` in some tests.

* Issue#1117: Removed now-redundant name and identifier input arguments on rule `__init__` methods.
Updated rule_localized_001 to force the rule's name.
Update the local rules documentation.

* Issue#1117: Removed unused exception in get_rule_name.

* Issue#1117: Updates after merging master.

* Converting match case to if statement to support python pre version 3.10Converting match case to if statement to support python pre version 3.10.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2024-02-04 15:23:23 -06:00
Jeremiah Leary 1ba9088374
Issue#1081: Adding configuration option for constant_400 (#1094)
* Issue#1081:  Adding configuration option for constant_400

* Adding options to concurrent_400 and sequential_400.

* Refactored base rules to improve readability.

* Merging base rules:

  align_tokens_in_region_between_tokens_unless_between_tokens merged into align_tokens_in_region_between_tokens

* Adding ignore_single_line_aggregates to rule constant_400

* Removing commented out code.

* Refactoring align_tokens_in_region_between_token_when_between_tokens_unless_between_tokens.

* Removing unused alignment options due to refactor.
2024-01-21 13:55:08 -06:00
Jeremiah Leary 64882762e3
Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018)
* Issue#1009:  Updating multiline alignment rules to accept booleans for parameters.

* Adding boolean to yes/no conversions for other rules.

* Converting rule after_002 to use yes/no strings for options.

* Updating base rule align_tokens_in_region_between_tokens_unless_between_tokens to use yes/no.

* Updating base rule align_tokens_in_region_between_tokens_skipping_lines_starting_with_tokens to accept yes/no.

* Updating base rule align_tokens_in_region_between_tokens to accept yes/no.

* Updating rule case_generate_statement_400 to accept yes/no.

* Updating rule concurrent_006 to accept yes/no.

* Fixing default value for generate_statement_ends_group in concurrent_006.

* Updating rule concurrent_008 to accept yes/no.

* Updating base rule align_tokens_in_region_between_tokens_when_between_tokens_unless_between_tokens to support yes/no

* Updating base rule align_tokens_in_region_between_tokens_unless_between_tokens to accept yes/no.

* Setting False options to 'no' in base rule align_tokens_in_region_between_tokens_unless_between_tokens.

* Updating block_comment rules to accept yes/no.

* Updating rule concurrent_400 to accept yes/no.

* Updating rule process_034 to accept yes/no.

* Updating rule process_035 to accept yes/no

* Updating rule process_400 to accept yes/no.

* Updating rule sequential_400 to accept yes/no.

* Updating rule subprogram_body_400 to accept yes/no.

* Updating rule concurrent_007 to accept yes/no.

* Updating rule library_003 to accept yes/no.

* Updating rule signal_012 to accept yes/no

* Updates for codeclimate issues.

* Moving similar alignment helper functions to utils file.

* Codeclimate updates.

* Updating option documentation to current standard.

* Changing default True option to 'yes'

* Updating configuration documentation to current standards.

* Updating configuration documentation to latest standard.

* Updating configuration rules to current standard.

* Replacing occurances of True/False with "yes"/"no"

* Updating configuration documentation to latest standard.

* Fixing documentation tests.
2023-10-22 06:46:42 -05: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 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 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 beffaf25a3
Updates for issue #802 (#803)
Adding conditional_waveform_assigment to rule sequential_001.

  1)  Added tests
  2)  Updated indent rules
  3)  Updated rule sequential_001
2022-07-15 06:22:22 -05:00
Jeremiah Leary c203f3bc64
Updates for Issue 775 (#782)
* Updates for issue #775

Adding configurable whitespace rule:

  1)  Added preliminary documentaton
  2)  Added test
  3)  Updated whitespace rule to allow for configurations of more than one space

* Extracting functions from _analyze method.

* Adding feature to handle min and max not equal.

* Extracting function from analyze methods.

* Combined min and max values into a single option.

* Adding greater than and greater than or equal to options.

* Migrating rule entoty_007 to use whitespace_between_tokens.

* Migrating rule entity_002 to use whitespace_between_tokens.

* Migrating rule entity_011 to whitespace_between_tokens.

* Migrating rule entity_013 to whitespace_between_tokens.

* Adding link to configuring whitespace rules.

* Converting single_space_between_tokens rules to whitespace_between_tokens rules.

* Removing unused base rule single_space_between_tokens

* Refactoring single_space_between_token_pairs to extend whitespace_between_tokens.

* Adding link to individual rules.

* Renaming single_space_between_token_pairs to whitespace_between_token_pairs.

* Updating documentation.

* Refactoring single_space_after_token to extend white_space_between_tokens.

* Renaming single_space_after_token to whitespace_after_token.

* Updating documentation.

* Migrating single_space_before_token_if_on_same_line_as_token to extend whitespace_between_tokens.

* Changing name of single_space_before_token_if_on_same_line_as_token to whitespace_before_token_if_on_same_line_as_token.

* Removing unused rule.

* Removing n_spaces_after_tokens and replacing it with whitespace_after_tokens.

* Removing rule single_space_before_token.

  1)  Replaced with whitespace_before_token
  2)  whitespace_before_token now extends whitespace_between_tokens

* Refactoring whitespace_before_token rule.
Updating documentation.

* Making single_space_between_token_pairs_bounded_by_tokens extend whitespace_between_tokens.

* Refactoring to improve usability.

* Refactoring whitespace_before_tokens_in_between_tokens to improve usability.

* Formatting updates.

* Refactoring to improve readability.

* Adding [0-9][0-9]*+ as a configuration option for number_of_spaces.
2022-06-03 08:03:11 -05:00
Jeremiah Leary eed0069050
Updates for issue #680 (#714)
* Updates for issue #680

Alignment of sequential assignments would take two passes to complete.

  1)  Isolated issue to process_004 being ran before process_400
  2)  Updated test
  3)  Set sequential_004 to run after process_400

* Fixed issue where process_029 was running after if_002 and removing the parenthesis.

  1)  Moved if_002 to subphase 2.
2022-02-05 06:26:23 -06:00
Jeremiah Leary f8f5f77c58
Updates for issue #651 (#662)
* Updates for issue #651

Initial attempt at adding rule groups.

  1)  Updated documentation
  2)  Added indent group
  3)  Added tests

* Addressing CodeClimate issues.

* Additional code climate updates.

* Renaming depricated to deprecated.

Adding tests to improve code coverage.

* Adding length group and updating documentation.

* Adding indent labels to rule documentation.

* Adding blank_line group.

* Minor documentation update.

* Adding more rules to the blank_line group.

* Adding blank_line label to blank line rules in documentation.

* Adding whitespace rule group

* Adding case group.

* Adding structure rule group:

  1)  Addings structure rule group object
  2)  Updated base rules which should utilize the rule group

* Adding more base rules to the whitespace rule group.

* Adding more base rules to the case rule group.

* Adding naming rule group:

  1)  Added naming rule group
  2)  Assigned base rules to the naming rule group

* Adding alignment rule group:

  1)  Added alignment rule group
  2)  Added base rules to alignment rule group

* Assigning more rules to rule groups.

* Adding last rule to a rule group.
Fixing error introduced into whitespace_001

* Assigning sub groups to architecture rules.

* Updating after rules documentation to add rule group.

* Adding rule group to assert rule documentation

* Updating attribute_declaration rules rule group.

* Adding program to generate rule documentation:

  1)  Added bin/vsg_rule_doc_gen
  2)  Added tests
  3)  Copied existing documentation into rule doc strings for the following rule classes:
      a)  after
      b)  architecture
      c)  assert_statement
      d)  attribute
      e)  attribute_declaration
      f)  attribute_specification
      g)  block
  4)  Partially update deprecated rules to they could be processed

* Converting block_comment documentation.

* Converting case_rule documentation.

* Converting comment rule documentation.

* Converting component documentation to doc strings.

* Converting concurrent rule documentation to doc strings.

* Convert constant docs to doc strings.

* Converting context rule doc to doc strings.

* Fixing failing tests.

* Converting context reference doc to doc strings.

* Converting entity doc rules to doc strings.

* Converting entity_specification rule doc to doc strings.

* Converting exit_statement rule doc to doc strings.

* Converting file_statement rule docs into doc strings.

* Converting for_loop rule doc to doc strings.

* Converting function rule doc to doc strings.

* Converting generate rules doc to doc strings.

* Converting generic rule doc to doc strings.

* Converting generic_map rule doc to doc strings.

* Converting if rule docs to doc strings.

* Converting instantiation rule doc to doc strings.

* Converting length rule doc to doc strings.

* Converting library rule doc to doc strings.

* Convert loop_statement rule doc to doc strings.

* Converting package rule docs to doc strings.

* Converting package_body rule doc to doc strings.

* Converting port rule doc to doc strings.

* Converting port_map rules doc to doc strings.

* Converting procedure rule doc to doc strings.

* Converting procedure_call rule doc to doc strings.

* Converting process rule doc to doc strings.

* Converting range rule doc to doc strings.

* Converting report_statement rule doc to doc strings.

* Converting sequential rule doc to doc strings.

* Converting signal rule doc to doc strings.

* Converting source_file rule doc to doc strings.

* Converting subprogram_body rule doc to doc strings.

* Converting subtype rule doc to doc strings.

* Converting type rule doc to doc strings.

* Converting variable rule doc to doc strings.

* Converting variable_assignment rule doc to doc strings.

* Converting wait rule doc to doc strings.

* Converting when rule doc to doc strings.

* Converting while_loop rule doc to doc strings.

* Converting whitespace rule doc to doc strings.

* Converting with rule doc to doc strings.

* Fixing tests due to further refinements of rule groups.

* Removing generated doc files after tests.

* Updating documentation to include rule group information.

* Removing trailing whitespace.

* Minor formatting fixes for documentation.

* Fixing issues for codacy.

* Skipping currently failing tests so I can address coding issues.

* Removing unused libraries.

* Minor formatting issues resolved.

* WIP:  Setting desired test input.

NOTE:  tests fail as I need to implement fixes.

* Improving testing of rule groups.

* Enhancing test so it will pass.

* Updates for codacy.
2022-01-01 17:46:43 -06:00
Jeremiah Leary 9526fc776e
Updates for issue #562 (#697)
* Updates for issue #562

Adding rule to align signal and variable assignment operators.

  1)  Updated documentation
  2)  Updated tests
      a)  Removed deprecated tests
      b)  Added process tests
  3)  Updated rules
      a)  Deprecated signal_005
      b)  Deprecated variable_assignment_005
      c)  Added rule process_400

* Updates for issue #562

Adding severity to test JSON output.

* Updates for issue #562

Formatting updates.
2021-12-11 09:18:17 -06:00
imd ba71ce516e added loop ends group attribute 2021-06-10 22:21:40 +01:00
imd 8c12c428b3 test defaults 2021-06-10 21:09:04 +01:00
Jeremiah Leary 0b8b0a2d55 Updates for issue #538
Keywords in solutions are now consistently noted with *'s.
2021-03-16 07:54:11 -05:00
Jeremiah Leary 1cc326e628 Updates for issue #259
Multiple sequential signal assignments on a single line should not exist.

  1)  Added documentation for rule sequential_007
  2)  Added tests
  3)  Added rule sequential_007
2020-12-08 09:17:15 -06:00
Jeremiah Leary 4721ae0322 Updates for Codacy flagged issues. 2020-12-04 13:27:19 -06:00
Jeremiah Leary d41c520e5b Refactoring rule sequential_002 to use single_space_after base rule. 2020-11-27 10:13:00 -06:00
Jeremiah Leary a0a9813d89 Codacy fixes. 2020-11-24 17:14:00 -06:00
Jeremiah Leary f19235e0af Refactoring rule sequential_004 for new parser. 2020-11-01 10:33:46 -06:00
Jeremiah Leary aa1398da77 Refactoring variable_assignment rules for new parser. 2020-10-18 17:43:36 -05:00
Jeremiah Leary 702d6c4235 Refactoring sequential rules for new parser. 2020-10-17 12:17:02 -05:00
Jeremiah C Leary 6b4a45791d Updates for issue #362
Changing utils.get_violation_linenumber to utils.get_violation_line_number.
2020-04-01 21:11:38 -05:00
Jeremiah C Leary b9abdf8a57 Updates for issue #362:
Updated rules to use consistent violation dictionary:

  1)  Updated check.indent_of_comments_above to use the violation dictionary
  2)  Updated rules to use the violation dictionary
  3)  Updated tests
2020-03-31 20:09:51 -05:00
Michał Kruszewski 0f0ec0f47c Refactor keyword alignment rules - part 2. 2020-03-17 11:22:25 +01:00
Michał Kruszewski 2f08a64bda Refactor keyword alignment rules. 2020-02-24 21:14:44 +01:00
Jeremiah C Leary b3904f6b8b Updates for issue #335
Updated sequential rules to use violation dictionary for violation list.

  1)  Updated code
  2)  Updated tests
2020-02-16 21:36:13 -06:00
Jeremiah C Leary e49349fc76 Codeclimate updates. 2019-04-10 21:28:55 -05:00
Jeremiah C Leary 016f65d6b0 Updates for issue #226
Refactoring the following rules for code coverage:

   architecture_024
   instantiation_010
   port_011
   process_018
   process_031
   sequential_004
2019-04-10 20:21:11 -05:00
Jeremiah C Leary 6a04dae1c3 Updates for issue #181
1)  Adding vsg off checking to rules which override the base rule class analysis method.
2019-03-10 11:50:46 -05:00
Jeremiah C Leary 7cb56ab8f0 Updates for issue #181
Addition refactoring of existing rules to support implementing in file tags.
2019-03-09 18:34:41 -06:00
Jeremiah C Leary 5ff634025c Updates for issue #181
Refactoring more rules to support implementing in file tags.
2019-03-09 16:42:31 -06:00
Ryan Fitzsimon 79456cf1a2 Use explicit relative imports
Implicit relative imports are not supported in Python 3 (see pep-0404).

Using explicit relative imports also helps avoid name clashes.
2018-08-31 11:24:13 +10:00
Jeremiah C Leary 9e44f00950 Refactored sequential rules and added documentation. 2017-12-23 10:38:04 -06:00
Jeremiah C Leary 1df3c7b8f1 Refactoring indent rules for code climate. 2017-12-16 10:50:38 -06:00
Jeremiah C Leary bf92c91551 Updates for codestyle. 2017-12-08 19:48:15 -06:00
Jeremiah C Leary 0d933f04df Updates for code climate:
1)  Refactored code with suggestions from code climate
  2)  Moved change_word from fix.py to utilities.py
2017-12-02 06:59:54 -06:00
Jeremiah C Leary ef5e02b64a Refactoring for code climate.
1) Fixed style issues
 2) Refactored complex functions
2017-12-01 18:26:05 -06:00
Jeremiah C Leary 7ed5a6c5dd Updates for issue #90
1)  moved enforce_one_space_after_word and enforce_one_space_before_word to fix.py
2017-11-28 20:41:11 -06:00
Jeremiah C Leary 723ed891f7 Updates for issue #90
1)  moved _fix_multiline_alignment to fix.py
2017-11-28 20:14:01 -06:00
Jeremiah C Leary 6dd1bca851 Updates for issue #90
1)  moved _fix_keyword_alignment to fix.py
2017-11-28 20:09:42 -06:00
Jeremiah C Leary 3302988886 Updates for issue #90
1)  Moved _fix_indent to fix.py
2017-11-28 19:59:48 -06:00
Jeremiah C Leary b7a568d537 Updates for issue #90
1)  Moved _check_multiline_alignment to check.py
2017-11-28 19:32:53 -06:00
Jeremiah C Leary eee146f5c4 Updates for issue #90
1)  Moving _check_keyword_alignment to check.py
2017-11-28 19:26:34 -06:00
Jeremiah C Leary a4304575fc Refactoring for code climate:
1)  Added check.py to hold all checks.
      checks from rule.py will be moved here
  2)  Moved _check_indent to check.indent
2017-11-26 16:13:21 -06:00
Jeremiah C Leary 19f0ccdd58 Refactoring sequential rules to aid in maintainability. 2017-11-26 12:54:13 -06:00