Commit Graph

59 Commits

Author SHA1 Message Date
Jeremiah Leary 710f857db1
Merge branch 'master' into issue-1364 2024-12-29 17:32:06 -06:00
JHertz5 a2519e4b1a Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
JHertz5 0c1f693430 Issue#1364: Updated documentation for rules function_014 and procedure_505. 2024-12-21 18:14:12 +00:00
JHertz5 61d74dbe83 Merge remote-tracking branch 'origin/master' into issue-1251 2024-11-10 01:51:11 +00:00
Jukka Hertzog 44544d3060
Issue#1253: Added rule to enforce case of `pure` and `impure` keywords. (#1259)
* Issue#1253: Added rule function_510.

* Issue#1253: Added tests for rule function_510.

* Issue#1253: Updated documentation for rule function_510.

* Issue#1253: Updated documentation for rule function_510.

* Issue#1253: Changed rule function_510 to function_509 to avoid conflict with other in-progress branches.

* Issue#1253: Updated test script.

* Issue#1253: Adjusted whitespace in test files for consistency with other tests.

* Issue#1253: Split rules to act on pure and impure separately.
2024-11-09 14:14:49 -06:00
JHertz5 d6dee6d00c Merge remote-tracking branch 'origin/master' into issue-1251 2024-10-24 07:55:44 +01:00
JHertz5 2c60191df3
Issue#1252: Rules for enforcing case on function and procedure parameter directions (#1260)
* Issue#1252: Added rules function_509 and procedure_510.

* Issue#1252: Changed rule function_509 to function_510.

* Issue#1252: Added tests for rules function_509 and procedure_510.

* Issue#1252: Updated documentation for rules function_510 and procedure_510.
2024-10-20 17:07:07 -05:00
JHertz5 150c4d6700
Issue#1263: Rules for enforcing case on parameter class in functions and parameters (#1264)
* Issue#1263: Added rules function_511 and procedure_511.

* Issue#1263: Added tests for rules function_511 and procedure_511.

* Issue#1263: Removed duplicate token in rules function_511 and procedure_511.

* Issue#1263: Updated docstring for rules function_511 and procedure_511.

* Issue#1263: Updated docs for rules function_511 and procedure_511.
2024-10-20 10:52:38 -05:00
JHertz5 a559813a85 Issue#1251: Updated docs for function_508 and procedure_509. 2024-10-16 19:39:28 +01:00
JHertz5 de8ab379a1 Issue#1251: Updated docstrings and docs for rules function_507, procedure_508, and procedure_call_502. 2024-10-15 19:50:27 +01:00
Jeremiah Leary 95fabcf752
Issue#1196: Adding rules to check for subprogram designators. (#1197) 2024-07-12 03:14:37 -05:00
Jeremiah Leary a972c42c4c
Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
Alon Bar-Lev baf22da660 style: apply end-of-file-fixer
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16: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 51a95c2096
Issue#1103: Adding structure rules for subprogram specifications. (#1108)
* Issue#1103 Added rule for multiline subprogram specification structure.

* Issue#1103 Added rule function_019.

* Issue#1103 Added rule procedure_013.

* Issue#1103 Restored inteface_list_semicolon to subprogram_specification rule.

* Issue#1103 Documentation updates.

* Issue#1103 Removal of superseded rules.

* Issue#1106 Added unittests for procedure_013.

* Issue#1106 Correction to subprogram specification strucutre to include other kinds of interface element

* Issue#1106 Added unittests for function_019.

* Issue#1106 Updated examples for rules function_019 and procedure_013.

* Issue#1106 Modified subprogram specification defaults to avoid changing existing styles.

* Issue#1103: Updated configuration documentation link for the multiline_subprogram_specification_structure class.

* Issue#1103: Updated default value for the `interface_element` attribute of `multiline_subprogram_specification_structure` rules to `add_new_line`

* Issue#1103: Corrected configuration documentation link for the multiline_subprogram_specification_structure class to be a string instead of a non-existent variable.

* Issue#1103: Corrected the link name for `configuring-procedure-call-statement-rules`.

* Issue#1103: Updated default value for the `interface_element` attribute of `multiline_subprogram_specification_structure` rules to `ignore`.

* Issue#1103: Updated default configuration of subprogram specification rules.

* Issue#1103: Updated JCL style with function_019 settings

* Adding picture to illustrate where options will take affect.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2024-01-27 09:35:04 -06:00
Jeremiah Leary 3d02e0b2c5
Issue-945: Adding rules for return_statement production (#1020) 2023-10-22 06:44:48 -05:00
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 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 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 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 6e58ab4a89 Attempting to fix ReadTheDocs build. 2021-10-28 08:00:34 -05:00
Jeremiah Leary 3610020b78 Attempting to fix ReadTheDocs build. 2021-10-28 07:32:04 -05:00
imd 16a6265d52 tidied docs 2021-06-20 15:11:45 +01: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 6a3d1c8562 create function_300 tests 2021-06-02 11:59:36 +01:00
Jeremiah Leary 446a3ebe31 Updates for issue #540
Adding icons to all rules.
2021-04-01 22:02:05 -05:00
Jeremiah Leary c902c29c4a Updates for Issue #540
Adding rules for which configurations apply.
2021-03-23 20:20:05 -05:00
Jeremiah Leary cf55625c3d Updates for issue #504:
Fixing links in documentation.
2021-02-03 19:00:53 -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 ae8ee436e9 Updates for issue #504:
Updating links to configuring previous line rules.
2021-01-25 19:55:41 -06:00
Jeremiah Leary 69233c8e14 Updates for issue #504:
Updating documentation for all rules which will use the new previous line rule.
2021-01-21 19:40:08 -06:00
Emil Vanherp 73420cdca2
remove trailing whitespace 2021-01-11 21:55:56 +01: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 fad6f180b6 Updates to address additional style tests:
1)  Updated blank line above/below rules to default to not allow comments
      a)  Set several tests which already allowed comments to allow comments
      b)  Updated documentation
      c)  Added documentation for configuring blank line rules
  2)  Fixed generate_011
      a)  Now handles all three types of generates
      b)  Handles nested generates
2020-11-21 17:00:16 -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 c7d7005bdd Updates for issue #434:
Adding ability to configure grouping by comments and blank lines.

  1)  Added tests
  2)  Updated documentation
  3)  Updated code based on keyword_alignment_rule
2020-06-30 14:16:41 -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
Jeremiah Leary 7cc3215323 Minor documentation updates. 2020-06-23 20:15:46 -05:00
Michał Kruszewski a61f9ad504 Add rules for checking case of "end function". 2020-06-23 14:05:47 +02:00
Michał Kruszewski 1e0c2d48c4 Improve Function Rules documentation. 2020-04-07 10:44:19 +02:00