Commit Graph

69 Commits

Author SHA1 Message Date
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 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 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
jobtijhuis-philips 08400ece64
Fix broken links to Subprogram Body Rules (#786)
* Fix broken links to Subprogram Body Rules

* Fix spelling error in contributing page
2022-05-16 18:31:23 -05:00
Jeremiah Leary a8df0436d4 Fixing grammar in documentation. 2022-05-02 06:40:29 -05:00
Jeremiah Leary 267b17e72a
Updates for issue #730 (#741)
* Updates for issue #730

Adding rules to handle case for use_clause selected names.

  1)  Added new tokens to use_clause
  2)  selected names now parsed with new tokens
  3)  Added rules:
      a)  use_clause_500
      b)  use_clause_501
      c)  use_clause_502
      d)  use_clause_503
  4)  Added tests

Resolves #730

* Refactoring to reduce duplication.
Removing trailing whitespace.

* Changing exceptions to case_exceptions.

1)  case::name rules allow case_exceptions by default
2)  Updated instantiated_unit to split entity_name with a library name
3)  Rule instantiation_028 simplified
4)  Removed unused test file

* Refactoring to reduce complexity.

* Refactoring to improve readability.

* Fixed isue with procedure_506 crashing VSG due to missing variable.

* Fixing missing call to lowercase list.

* Adding the following rules:

  context_ref_500
  context_ref_501

Deprecated the following rules:

  context_ref_004

* Placing common code into a single file.

* Removing trailing whitespace.

* Refactoring to reduce the number of parameters.
2022-04-19 19:21:20 -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 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 69050f8d7c
Issue 639 (#698)
* Updates for issue #639

Addressing issue where function and procedure rules were identical.

  1)  Updated documentation
      a)  Added documentation for subprogram_body rules
      b)  Updated deprecated rule documentation
  2)  Updated tests
      a)  Removed deprecated rule tests
      b)  Added subprogram_body rules
      c)  Updated function and procedure rules to show the issue
  3)  Updated rules to ensure function rules operate on functions and procedure rules operate on procedures
      a)  function_013, procedure_008
      b)  function_015, procedure_010
      c)  function_012, procedure_401
      d)  function_502, procedure_502
      e)  function_004, procedure_503
      f)  function_013, procedure_504
      g)  function_506, procedure_506
  4)  Moved function and procedure rules to subprogram_body rules
      a)  function_201, procedure_201 --> subprogram_body_201
      b)  function_202, procedure_202 --> subprogram_body_202
      c)  function_203, procedure_203 --> subprogram_body_203
      d)  function_204, procedure_204 --> subprogram_body_204
      e)  function_007, procedure_205 --> subprogram_body_205
  5)  Deprecated rules
      a)  function_201, procedure_201
      b)  function_202, procedure_202
      c)  function_203, procedure_203
      d)  function_204, procedure_204
      e)  function_007, procedure_205

* Adding files which were missing from previous commit.

* Removing unused file.

* Updates for CodeClimate.

* Refactored filter_token_pairs to improve readability.

* Refactoring get_tokens_bounded_by_unless_betweent to improve readability.

* Removing unused code in get_tokens_bounded_by_unless_between function.

* Removing unused import.
2021-12-12 07:13:09 -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 8edac1b5a3 use merge terminology 2021-06-20 14:57:47 +01:00
imd b5925e9691 depircated function_002/003 2021-06-20 14:55:44 +01:00
imd 149e9d19b4 added rule 100 2021-06-20 14:44:49 +01:00
imd cb01baee12 added function_101 2021-06-20 08:56:21 +01:00
imd 121ff94492 added function_502/506 2021-06-18 18:13:39 +01:00
imd e6e0f00b2e added function_201/202/203/204 2021-06-18 17:45:35 +01:00
imd e134d91c3e new function_300 rule works 2021-06-02 12:22:05 +01:00
Jeremiah Leary fd8d67e0c8 Updates for issue #568
Alignment of colons were occuring before alignment of identifier.

  1)  Changed rule function_012 to run in subphase 2 after the alignment of the identifier
2021-04-29 08:51:31 -05: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 cd64cdeae0 Updates for issue #474
Adding rule function_017 to handle the case of function designators.

  1)  Added documentation
  2)  Added test
  3)  Added rule function_017
2020-12-04 17:03:00 -06:00
Jeremiah Leary f9982dac4d Refactoring rules to improve consistent case performance.
1)  Adding more exclusions to each rule
2020-12-04 09:20:22 -06:00
Jeremiah Leary 55edb03ed7 Hardning updates for existing code examples:
1)  Added single_space_before_token to handle case_rule_005
  2)  Added insert_carriage_return.......
  3)  Improved existing tests
2020-11-15 09:51:21 -06:00
Jeremiah Leary cccf9b7d7c Updates during jcl style validation.
1)  Added rule function_016 to handle return statements in functions
      a)  Updated documentation
      b)  Created tests
      c)  Added rule
  2)  Updated rules to match existing jcl style output
2020-11-14 17:07:48 -06:00
Jeremiah Leary 64f4871faf Refactoring procedure rules for new parser. 2020-10-14 21:54:37 -05:00
Jeremiah Leary 0a69106717 Refactoring function rules for new parser. 2020-10-03 23:00:54 -05:00
Jeremiah Leary 7a3fcf9883 Updates for issue #434:
Adding rules to align declaration identifiers:

  1)  Updated documentation
  2)  Removed the following rules
      file_003, constant_003, attribute_003, signal_003, subtype_003, type_003 and variable_003
  3)  Added new rules:
      architecture_029, function_015, package_019, procedure_010 and process_037
  4)  Added tests for new rules
  5)  Updated classifiers to support new rules
2020-06-30 11:36:01 -05:00
Michał Kruszewski a61f9ad504 Add rules for checking case of "end function". 2020-06-23 14:05:47 +02: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
Jeremiah C Leary 95f3580c92 Updates for issue #341:
Removing rule function_011 which is not being used.
2020-02-25 07:37:24 -06:00
Michał Kruszewski 2f08a64bda Refactor keyword alignment rules. 2020-02-24 21:14:44 +01:00
Jeremiah C Leary cb53ad4c91 Updates for issue #335
Updated function rules to use violation dictionary for violation list.

  1)  Updated code
  2)  Updated tests
2020-02-16 19:22:53 -06:00
Jeremiah C Leary ddc32f8ed9 Updates for issue #335:
Updated tests using the indent base rule to use dictionaries for the violation list.

  1)  Updated code
  2)  Updated tests
2020-02-16 08:27:55 -06:00
Jeremiah C Leary 86c708a986 Minor formatting updates for Codacy issues. 2020-01-02 11:58:48 -06:00
Michał Kruszewski 49aa53ab61 Replace extract_word function with extract_words. 2019-12-28 11:39:32 +01:00
Jeremiah C Leary c603a9b5dc Updates for issue #288:
Updated function case rules to allow for configuration of either upper or lower case.

  1)  Updated documentation
  2)  Added tests
  3)  Updated rule function_005 so it can be either upper or lower case
2019-12-01 08:12:17 -06:00
Jeremiah C Leary 5cb0a35cc9 Updates for issue #287:
Fixed two issues:

  1)  VSG was misclassifying function parameters as variables.
  2)  VSG was not setting an indent level for the end of a function.
2019-11-27 07:13:29 -06:00
Jeremiah C Leary a374867c40 Refactoring fix.upper_case and fix.lower_case to remove unneccessary input. 2019-10-16 21:36:30 -05:00
Michał Kruszewski 9f1389c8e8 Fix printing solution for case rules. 2019-10-15 15:57:01 +02:00
Michał Kruszewski c962881e7a Make _extract abstract method for case_rule class. 2019-10-07 20:30:27 +02:00
Michał Kruszewski 957ef8702d Refactor extracting VHDL keywords. 2019-10-07 19:46:17 +02:00
Michał Kruszewski 215dae1647 Make function rule 004 use case_rule as a base. 2019-10-07 17:57:57 +02:00
Michał Kruszewski 33995b81bb Make constatnt rule 011 use case_rule as a base. 2019-10-07 11:53:04 +02:00
Michał Kruszewski 761f5fc938 Make extract_type_name function return list. 2019-10-02 09:34:59 +02:00
Jeremiah C Leary 599a0bb45b Codeclimate updates. 2019-04-10 21:23:17 -05:00
Jeremiah C Leary f2da8b4fe0 Updates for issue #224
Adding consistency case checks for function names.

  1)  Added documentation
  2)  Added tests
  3)  Added rule function_010
2019-03-31 09:10:41 -05:00
Jeremiah C Leary 5cacc551ef Updates for issue #221:
Fixing function_003 violation for functions without parameters.

  1)  Added test to detect bug
  2)  Updated rule to only check if there are any parameters on the function.
2019-03-23 19:47:20 -05:00
Jeremiah C Leary f42e698c31 Updates for issue #219
Changed utilities to utils.
2019-03-23 07:43:53 -05:00