Commit Graph

55 Commits

Author SHA1 Message Date
Jeremiah Leary 1430bcbd5d
Issue#976: Added prefix and suffix rules for function designators. (#987) 2023-08-07 18:34:01 -05:00
Jeremiah Leary 1f15511992
Issue#918: Adding rules for function and procedure optional keywords. (#939)
* Issue#918:  Adding rules for function and procedure optional keywords.

* Combining left and right base rules.

* Refactoring to improve readability.

* Fixing issue with keyword not being inserted.
2023-04-19 07:01:22 -05: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 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
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
imd 6a3d1c8562 create function_300 tests 2021-06-02 11:59:36 +01:00
Emil Vanherp a158fd2ac9
Distinguish between file errors
* Don't exit on file not found or other OSErrors, but continue (revert
from fc34afd4d0339e0b17d8f46e3bf527461beccf1a)
* Empty file, file not found, no permission and other
OSErrors are now reported differently.
2021-01-22 15:21:41 +01:00
Emil Vanherp 0971ca194c
Move read_vhdlfile to vhdlFile/utils
And exit with exit code 1 on file not found or any other OSError
2021-01-22 15:21:41 +01:00
Jeremiah Leary be88d4a462 Updates for issue #445
Adding ability for the user to adjust the indenting algorithm.

  1)  Added documentation
  2)  Refactored indent algorithm
      a)  Changed algorithm to use a YAML configuration file
  3)  Added indent dictionary to -oc output
  4)  Updated tests to use new YAML configuration file
2020-12-20 18:06:07 -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 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 2d672df79d Major refactor to remove the use of line.py to improve performance. 2020-11-09 20:49:45 -06:00
Jeremiah Leary 0a69106717 Refactoring function rules for new parser. 2020-10-03 23:00:54 -05:00
Jeremiah Leary a95bd04873 Replacing older parser with newer one:
1)  Called out parsers from classify_new instead of classify
  2)  Updated invalid test inputs
  3)  Updated test results
  4)  Removed unused files
2020-09-19 07:46:35 -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 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 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 fb4c5ca972 Updates for issue #335:
Updated rules based on the single_space_after_rule and multiple_spaces_after_rule base rules:

  1)  Updated rules to use violations list for the fix phase
  2)  Updated tests
2020-02-15 16:12:47 -06:00
Jeremiah C Leary 53969af391 Updates for issue #335
Updated rules based on rules.line_below_rule to use the violations attribute to fix violations.

  1)  Updated base rule rules.line_below_rule
  2)  Updated tests
2020-02-15 15:36:42 -06:00
Jeremiah C Leary 128b080f49 Updates for issue #335
Updated rules based on the line_above_rule.

  1)  Updated line_above_rule
  2)  Updated tests
2020-02-15 15:13:57 -06:00
Michał Kruszewski 7666fae485 Make case_rule to use violations attribute for fixing errors. 2020-02-15 16:51:01 +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 c184c07592 Updating tests to improve code coverage. 2019-10-18 06:41:38 -05:00
Jeremiah C Leary bb7b44e0ec Adding tests to improve code coverage. 2019-10-16 22:16:31 -05:00
Jeremiah C Leary 08e3680b70 Updates for Codacy:
1)  Removed trailing whitespace
  2)  Removed unused general tests
2019-03-31 10:03:00 -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 1948b70444 Updates for Codacy issues:
Removing trialing whitespaces.
2019-03-10 12:19:16 -05:00
Jeremiah C Leary 183b9f5c18 Updates for issue #193
The class vhdlFile now takes a list instead of a file name.
This removes the responsibility of reading the file from the vhdlFile class.
Which allows for better integration into other tools.
2019-02-24 12:49:25 -06:00
Jeremiah C Leary a142f78ef2 Updates for issue #133:
1)  Updated classification of functions.
  2)  Updated tests
2017-12-30 12:27:23 -06:00
Jeremiah C Leary 41510950d9 Updates for issue #128
1)  Function parameters are no longer classified as signals or constants
  2)  Functions in packages are now classified
  3)  Updated tests
2017-12-26 07:23:56 -06:00
Jeremiah C Leary 464004cae6 Fixing style issues for Codacy. 2017-12-25 15:09:09 -06:00
Jeremiah C Leary 86ec8e697e Updates for issue #84
1) Added function_008 and function_009
  2) Added tests
  3) Added documentation
2017-12-25 12:45:01 -06:00
Jeremiah C Leary b055aa9b1f Removing unused imports to address Codacy issues. 2017-12-24 07:32:32 -06:00
Jeremiah C Leary 9d59246cea Style updates for Codacy. 2017-12-23 21:47:07 -06:00
Jeremiah C Leary 09d9de4473 Updates for issue #79
1)  Added function_006 to enforce a blank line above functions
  2)  Added function_007 to enforce a blank line below functions
2017-12-02 18:49:10 -06:00
Jeremiah C Leary b5d0803a7e Updates for issues #60 and #76
1)  Classifying "impure" functions as normal functions
  2)  Fixed issue with code being deleted in if statements when trying to split lines.
2017-11-25 10:50:01 -06:00
Jeremiah C Leary 382c2136eb Updates for issue #30
1)  Added fixes for function rules.
2017-11-23 07:21:33 -06:00
Jeremiah C Leary 12a585171c Updates for issue #52:
1)  Fixed easy code coverage issues.
2017-11-22 06:45:06 -06:00