Commit Graph

10 Commits

Author SHA1 Message Date
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
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 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
Jeremiah Leary 5c3ee17445 Updates for issue #571
Adding the ability to also align variable assignments.

  1)  Updated documentation
  2)  Updated test
  3)  Updated rule to align <= and :=
2021-10-06 19:53:57 -05:00
Jeremiah Leary 1b755943c1 Updates for issue #609
Adding rule to align assignment operator within function and procedures.

  1)  Added documentation
  2)  Added test
  3)  Added rule subprogram_body_400
2021-09-25 21:37:40 -05:00