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 6a4f748a87
Issue 850 (#861)
* Updates for issue #850

Adding rules to indent with keyword

  1)  Added documentation
  2)  Added tests
  3)  Added rules:
        concurrent_selected_signal_assignment_300
        selected_force_assignment_300
        selected_variable_assignment_300
        selected_waveform_assignment_300

* Adding the following rules:

  concurrent_selected_signal_assignment_500
  selected_force_assignment_500
  selected_variable_assignment_500
  selected_waveform_assignment_500

* Adding rules:

  concurrent_selected_signal_assignment_501
  selected_force_assignment
  selected_variable_assignment
  selected_waveform_assignment

* Adding rule:

  selected_force_assignment_502

* Fixing documentation.

* Adding rule selected_expressions_500

* Adding rule selected_waveforms_500.

* Adding rules:

  concurrent_selected_signal_assignment_100
  selected_force_assignment_100
  selected_variable_assignment_100
  selected_waveform_assignment_100

* Adding rules:

  concurrent_selected_signal_assignment_101
  selected_force_assignment_101
  selected_variable_assignment_101
  selected_waveform_assignment_101

* Adding rules:

  concurrent_selected_signal_assignment_102
  select_force_assignment_102
  select_variable_assignment_102
  select_waveform_assignment_102

* Adding rules:

  concurrent_selected_signal_assignment_103
  selected_force_assignment_103
  selected_varaible_assignment_103
  selected_waveform_assignment_103

* Adding rules:

  concurrent_selected_signal_assignment_104
  selected_force_assignment_104
  selected_variable_assignment_104
  selected_waveform_assignment_104

* Added rule selected_force_assignment_105.

* Adding rules:

  selected_expressions_100
  selected_waveforms_100

* Adding rules:

  selected_expressions_101
  selected_waveforms_101

* Adding structure base rule.

Adding rule selected_assignment_001

* Refactoring analysis functions to improve readability.

* Adding more options to rule selected_assignment_001.

* Adding documentation for selected_assignment rules.

* Adding rule selected_assignment_100.

* Adding rule selected_assignment_101.

* Adding rule selected_assignment_102.

* Adding rule selected_assignment_103.

* Adding rule selected_assignment_104.

* Adding rule selected_assignment_105.

* Adding rule selected_assignment_106.

* Adding rule selected_assignment_107.

* Removing unused file.

* Adding rule selected_assignment_500.

* Adding rule selected_assignment_501.

* Adding rule selected_assignment_502.

* Adding rule selected_assignment_503.

* Adding rule selected_assignment_300.

* Removing rules which were merged into selected_assignments.

  * concurrent_selected_signal_assignment
  * selected_force_assignment
  * selected_variable_assignment
  * selected_waveforms

* Updating indenting on selected with and semicolon keywords.

* Deprecating rule with_001.

* Adding rule selected_assignment_400.

Minor update to multiline_alignment_between_tokens base rule to support selected_assignment_400.

* Fixing yaml configuration.

* Fixing tags.

* Fixing last yaml example.

* Removing rule selected_assignment_001

* Removing unused directories.

* Fixing documentation links.

* Saving previous rule_001 to a temporary file.

* Adding rule selected_assignment_001

* Adding rule selected_assignment_002.

* Adding rule selected_assignment_003

* Adding rule selected_assignment_004.

* Removing subphase from rules.

* Adding rule selected_assingment_005.

* Adding rule selected_assignment_006.

* Fixing issue in base rule where processing order was not being preserved.

* Adding rule selected_assignment_007.

* Adding rule selected_assignment_008.

* Updated base rule to accept token pairs.

* Updating rule to use token pairs.

* Adding rule selected_assignment_009.

* Adding rule selected_assignment_010.

* Adding rule selected_assignment_011.

* Adding rule selected_assignment_012.

* Minor update to rule documentatin.
2022-12-13 18:06:54 -06: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 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 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 c1b23e74b9 Updates for issue #560
Cleanup of headers in rule documentation:

  1)  Removed (depricated) tags from headers
  2)  Removed headers indicating which phase the rule was run in
  3)  Fixed header levels
2021-05-05 06:42:37 -05:00
Jeremiah Leary 446a3ebe31 Updates for issue #540
Adding icons to all rules.
2021-04-01 22:02:05 -05: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 C Leary 071010fb3e Updates for rule #73
1)  Added rule with_001
  2)  Added tests
  3)  Added documentation
2017-12-14 08:42:39 -06:00