Commit Graph

140 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 f9c2653e54 style: apply codespell
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:34 +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
Alon Bar-Lev 599b2443ef docstring: remove unsupported escape sequences
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 18:48:25 +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 4ff8b6a0e0
Issue#1107: Adding option to process_028 to allow for alignment of close parenthesis. (#1116) 2024-01-24 06:56:17 -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 23b63ebfcc
Issue#1088: Rule process_400 was ignoring conditional signal assignments. (#1093) 2024-01-07 11:05:04 -06:00
Jeremiah Leary 6dfc1eee95
Issue#1066: Fixing default style of rule process_021 (#1067) 2023-12-14 08:09:43 -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
JHertz5 92d966de5c
Issue#992: Added all optional item rules to `structure::optional` rule group. (#993)
* Issue#992: Added rules to structure::optional rule group.

* Issue#992: Updated documentation to reflect new structure::optional rule group rules.

* Issue#992: Updated/added tests to check new structure::optional rule group rules.

* Issue#992: Removed test files.

* Issue#992: Removed erroneous newline.
2023-09-08 15:41:39 -05:00
Jeremiah Leary bab5fbd1f4
Issue#929: Fixing issue with moving label and the postponed keyword. (#933)
* Issue#929:  Fixing issue with moving label and the postponed keyword.

* Refactoring per code climate.

* Removing unused parameter.

* Adding rule process_039 to enforce postponed on same line as process.
2023-04-20 06:46:52 -05: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 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
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 b76065664b
Updates for issue #796 (#797)
Changing rule process_029 to be disabled by default.

  1)  Updated documentation
  2)  Updated rule
  3)  Updated tests
2022-07-15 06:35:21 -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 46be87cf6f
Updates for issue #784: (#785)
* Updates for issue #784:

Adding rules to align colons in attribute specifications:

  1)  Added documentation
  2)  Added tests
  3)  Added the following rules

      architecture_400
      block_402
      package_402
      process_401
      subprogram_body_401

* Minor formatting updates.

* Formatting updates.
2022-05-16 18:25:58 -05:00
Jeremiah Leary 82d30998a3
Updates for issue #777 (#779)
* Updates for issue #777

Adding rule to enforce case of predefined attributes.

  1)  Added documentation
  2)  Added test
  3)  Added rule attribute_500

* Fixing comments.

* Removing extra blank lines.
2022-05-08 08:56:47 -05:00
Jeremiah Leary a8df0436d4 Fixing grammar in documentation. 2022-05-02 06:40:29 -05:00
Jeremiah Leary ad87ea65ee Changing links to configuration documentation into ReST substitations.
Re-ordered configuration documentation entries so they are alphabetical.
2022-02-05 15:13:48 -06:00
Jeremiah Leary a820c8a30f Updates for issue #704 and #720:
Fixing broken links from rules back to configuration documentation.
2022-02-05 10:04:55 -06:00
Jeremiah Leary 3dd48d9464
Updates for issue #624 (#708)
* Updates for issue #624

Adding documentation for new loop rules.

* Updating another alternative output for json export.

* Temporarily reducing documentation for loop statements.

* Updating test to use correct json file for comparison.

* Adding rule loop_statement_500.

* Adding rule loop_statement_501.

* Adding rule loop_statement_502.

* Added rule loop_statement_301.

* Adding rule loop_statement_100.

* Adding rule loop_statement_101.

* Adding rule loop_statement_102.

* Refactoring base rule single_space_before_token.

* Refactoring to improve readability.
Minor formatting updates.

* Minor formatting fixes.

* Refactoring base rule single_space_after_token to improve readability.

* Refactoring to improve readability.

* Adding rule loop_statement_001.

* Added rule loop_statement_002.

* Adding rule loop_statement_003.

* Adding rule loop_statement_004
Adding rule loop_statement_201

* Adding rule loop_statement_202.

* Adding rule loop_statement_203.
Fixing documentation for rule loop_statement_201.

* Minor formatting changes.

* Moved rule for_loop_002 to loop_statement_302.
Minor grammar updates in documentation.

* Moving rule for_loop_003 to loop_statement_503.

* Clarifying documentation on rule loop_statement_503.

* Moved rule for_loop_005 to loop_statement_104:

* Refactoring to improve readability.

* Adding rule loop_statment_504.

* Adding rule loop_statement_005.

* Adding rule loop_statement_007.

* Adding rule loop_statement_006.

* Refactoring to improve readability.

* Deprecated rule while_loop_002 as it was a duplicate of rule loop_statement_302.

* Fixing solution text.

* Adding rule iteration_scheme_500.

* Adding rule iteration_scheme_501.

* Adding rule iteration_scheme_100.

* Adding rule iteration_scheme_101.

* Moved rule while_loop_001 to rule iteration_scheme_300.

* Moving rule for_loop_001 to iteration_scheme_301.

* Adding rule loop_statement_200.

* Adjusting number of tokens grabbed to fix error.
2022-02-05 06:15:47 -06:00
Jeremiah Leary 388d21873c
Updates for issue #661: (#718)
* Updates for issue #661:

Adding rule alias_declaration_500.

* Adding rule alias_declaration_501.

* Adding rule alias_declaration_502.

* Adding rule alias_declaration_001.

* Adding test for alias_declaration documentation.

* Adding rule alias_declaration_100.

* Adding rule alias_declaration_101.

* Adding rule alias_declaration_102.

* Updating rules architecture_029 and block_400 to align alias designators.

* Updating rule package_019 to align alias designators.

* Updating rule package_body_400 to align alias designators.

* Updating rule process_031 to align alias designators.

* Updating rule function_015 to align alias designators.

* Updating rule procedure_010 to align alias designators.

* Update rule architecture_026 to align alias declaration is keyword or colon.

* Updating the following rules to align alias elements:

    block_401
    function_012
    package_400
    procedure_401
    process_033

Adding the following rule to align alias elements:

    package_body_401

* Minor formatting updates.

* Adding rule alias_declaration_300.

* Adding rule alias_declaration_600.

* Adding rule alias_declaration_601.

* Adding rule alias_declaration_503.

* Updating rule generate_400 to align alias designators.

* Updated rule generate_401 to align alias declaration colon and is keyword.

* Updated rule generate_402 to align alias designators.

* Updated rule generate_403 to align alias declaration colon and is keyword.

* Updated rule generate_404 to align alias designators.

* Updated rule generate_405 to align alias colon and is keyword.

* Fixing documentation on rule alias_declaration_101.
2022-02-04 18:16:08 -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
Jeremiah Leary 5ed551cf53
Updates for issue #664 (#666)
* Updates for issue #664

Colons in subprogram_declarative_parts were being aligned with process_declarative_parts.

  1)  Updated tests to expose the issue
  2)  Updated rule process_033 to exclude subprogram_declarative_parts

* Fixing codeclimate issue.
2021-11-08 06:05:16 -06:00
Jeremiah Leary 91db3f001f Updates for issue #644
Additional changes:

  1)  Added new base rule token_case_with_prefix_suffix
  2)  Changed required rules to use new base rule
  3)  Refactored shared logic into package
2021-10-25 06:25:00 -05:00
imd e39c2cb547 Merge branch 'master' into issue-576 2021-05-01 22:22:50 +01:00
Jeremiah Leary ab405f726f Updates for issue #573
Fixing losing of code tags when inserting tokens.
2021-05-01 16:09:21 -05:00
imd d84b6e1346 added process suffix rule 2021-05-01 20:47:51 +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 742f8d8573 Updates for Codacy:
Removing trailing whitespace.
2021-03-13 07:44:41 -06:00
Jeremiah Leary a97d9f092f Updates for Codacy issues:
1)  Removing trailing whitespace
  2)  Removing unused code
2021-03-10 08:23:50 -06:00
Emil Vanherp 103d028568
remove unused imports 2021-02-10 23:53:34 +01:00
Jeremiah Leary e8859a9074 Updates for issue #504:
Changing option names for previous_line and blank_line rules:

  1)  require_blank changed to require_blank_line
  2)  no_blank changed to no_blank_line
2021-02-03 19:20:29 -06:00
Jeremiah Leary be6a672b05 Updates for issue #504:
Scrubbed blank line above and below rules and converted several to blank/no_blank only.

  1)  Updated documentation
  2)  Updated tests
  3)  Updated rules
2021-01-30 20:28:22 -06:00
Jeremiah Leary c117fa55f6 Updates for issue #504:
Renaming blank_line_above_line_starting_with_token to previous_line to make room for dedicated blank_line_above_line_starting_with_token base rule.
2021-01-30 14:28:16 -06:00
Jeremiah Leary 44f69ffd3c Updates for issue #504:
Updating configurable element from method to style.

  1)  Updated documentation
  2)  Updated tests
  3)  Updated configurable item
2021-01-25 19:24:52 -06:00
Jeremiah Leary 04cc85c114 Updates for issue #504:
Updated base rule blank_line_above_line_starting_with_token to include comments and blank lines.

  1)  Updated tests
  2)  Removed existing options allow_comments and blank_line_above_comment
  3)  Added option method
  4)  Updated base rule to use method
2021-01-23 13:20:01 -06:00
Jeremiah Leary 5a959acb17 Updates for issue #456
Adding ability to add or remove optional keywords.

  1)  Updated base rules to allow for removal of keywords
  2)  Changed default of instantiation_033 to add the keyword
  3)  Updated tests
  4)  Updated documentation
2020-12-12 10:49:44 -06:00
Jeremiah Leary dd60fbfb42 Rule process_018 was not flagging the first process if it did not have a label. 2020-12-07 12:53:06 -06:00
Jeremiah Leary 4721ae0322 Updates for Codacy flagged issues. 2020-12-04 13:27:19 -06:00
Jeremiah Leary 6a2a41b6c4 Refactoring rules to match current methodology:
1)  Refactored removed fix method and updated _fix_violation method
  2)  Refactored analyze method into _get_tokens_of_interest and _analyze methods
2020-12-04 10:57:24 -06:00
Jeremiah Leary 39dce36ec8 Additional Codacy Updates. 2020-11-24 18:19:42 -06:00
Jeremiah Leary a0a9813d89 Codacy fixes. 2020-11-24 17:14:00 -06:00
Jeremiah Leary 4d33270510 Updating rule process_032 to handle various formats of labels. 2020-11-23 17:17:21 -06:00
Jeremiah Leary 8773a06582 Adding solution to rule process_032. 2020-11-23 16:24:04 -06:00