Commit Graph

49 Commits

Author SHA1 Message Date
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
Jeremiah Leary 1ddfeb2929
Issue#947: Rule generate_015 could produce invalid code. (#955)
* Issue#947:  Rule generate_015 could produce invalid code.

* Updating parameters for rules.

* Adding documentation links.
2024-03-09 18:39:34 -06:00
JHertz5 bf66308e32
Issue#1110 Added rules to enforce prefixes and suffixes on generate/loop parameter indentifiers (#1111)
* Issue#1110 Added new rules for prefix/suffix enforcement on loop/generate parameter identifiers.

* Issue#1110 Documentation updates for the new loop/generate rules.

* Issue#1110 Added unit tests for the new loop/generate rules.

* Issue#1110 Documentation updates.
2024-01-21 13:02:00 -06:00
Jeremiah Leary a31c83ac4d
Issue#975: Adding "remove" and "add" options to rule generate_011. (#989)
* Issue#975:  Adding "remove" and "add" options to rule generate_011.

* Fixing solution for remove option.
2023-08-07 18:34:50 -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
Jeremiah Leary d596686891
Updates for issue #780: (#781)
* Updates for issue #780:

Adding rule to enforce indenting of the `end` keyword:

  1)  Added documentation
  2)  Added test
  3)  Added rule generate_300

* Adding rule to ensure *end* keyword is on it's own line.

  1)  Added documentation
  2)  Added test
  3)  Added rule generate_019

* Adding test to enforce indent of elsif keyword:

  1)  Added documentation
  2)  Added test
  3)  Added rule if_generate_statement_300

* Fixing *fix* solution.

* Fixing rule documentation.

* Adding rule to enforce alignment of else keyword:

  1)  Added documentation
  2)  Added test
  3)  Added rule if_generate_statement_301

* Removing rule generate_300 as it is a duplicate of rule generate_007.
2022-05-16 18:34:27 -05:00
Jeremiah Leary a26a4d86e3
Updates for issue #689: (#737)
* Updates for issue #689:

Adding rule if_generate_statement_500.

Resolves #689

* Adding the following rules:

   if_generate_statement_501
   if_generate_statement_502
   if_generate_statement_503

* Adding the following rules:

  * generate_500
  * generate_501

* Adding the following rules:

  * for_generate_statement_500
  * for_generate_statement_501

* Adding the following rules:

  * case_generate_alternative_500
  * case_generate_statement_500
  * case_generate_statement_501
2022-02-20 07:47:14 -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 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 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
imd c022ce3709 spotted doc errors 2021-05-01 20:30:55 +01:00
imd 448c2e0d76 added generate suffi rule 2021-05-01 18:17:55 +01:00
Jeremiah Leary 446a3ebe31 Updates for issue #540
Adding icons to all rules.
2021-04-01 22:02:05 -05:00
Jeremiah Leary 0a1b5f2b1b Updates for issue #540
Adding icons to rules that are disabled.
2021-04-01 18:15:42 -05:00
Jeremiah Leary e49d7cc094 Updates for issue #540
Minor updates for configuring prefix and suffix rules.
2021-03-25 21:45:20 -05:00
Jeremiah Leary 1945f23b96 Updates for issue #540
Combining prefix and suffix configuration documentation.
2021-03-24 18:04:07 -05:00
Jeremiah Leary 1a37f9f7b3 Updates for issue #540:
Splitting Prefix and Suffix configuration documentation into individual Prefix and Suffix documentation.
2021-03-23 20:42:58 -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 a6aeea15d7 Updates for issue #540:
Fixing broken links.
2021-03-23 18:41:29 -05:00
Jeremiah Leary cf55625c3d Updates for issue #504:
Fixing links in documentation.
2021-02-03 19:00:53 -06:00
Jeremiah Leary 0ea8dd3407 Updates for issue #504:
Switching several rules to blank_line and previous_line:

  1)  Rules switched to blank_line
      component_016
      entity_016
      generic_001
      port_001
  2)  Rules switch to previous_line
      library_007
  3)  Updated documentation
2021-02-02 20:58:48 -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 e13adaf072 Updates for issue #429:
Replacing : with colon in rule descriptions.
2020-12-30 14:39:28 -06:00
Jeremiah Leary e604ad0d91 Updates for issue #501:
Cleaning up documentation.
2020-12-22 09:30:06 -06:00
Jeremiah Leary 17f61baf87 Updates for issue #487
Removing unused code.
2020-12-19 11:45:52 -06:00
Jeremiah Leary 4d4f92f5ad Updates for issue #489
Fixing documentation issues.
2020-12-14 09:16:46 -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 12d7d6f6ad Updating indent rules for generate statement body.
1)  Changed indent level of begin and end keywords
  2)  Updated rule generate_006
  3)  Added rule generate_018
  4)  Updated documentation
2020-11-15 22:13:54 -06:00
Jeremiah Leary 7ca45752bb Refactoring generate rules for new parser. 2020-10-04 16:20:08 -05:00
Martin Dörfelt b90d94cbcf added rules for generate and process label prefixes 2020-06-25 21:42:27 +02:00
Jeremiah Leary 3fb73a1e43 Updates for issue #392:
Adding support for case generate statements:

  1)  Updated case classifications to differentiate between generate and case statements
  2)  Updated documentation
  3)  Added tests for generate case statements
  4)  Added rule generate_016 to enforce indention on when statements
2020-05-09 21:59:17 -05:00
Michał Kruszewski 3afe6961ae Improve Generate Rules documentation. 2020-04-08 10:17:00 +02:00
Michał Kruszewski b6226ecb7d Set the default case to lowercase for all case rules. 2020-03-29 21:26:15 +02:00
Jeremiah C Leary bd5b882326 Updates for issue #288:
Updated generate case rules to allow for configuring upper or lower case.

  1)  Updated documentation
  2)  Updated tests
  3)  Updated rules generate_005 and generate_010 to allow for upper or lower case.
2019-12-01 09:16:49 -06:00
Jeremiah C Leary a0ccff78ab Adding documentation on how to change the default value for lowercase and uppercase rules. 2019-10-12 09:24:25 -05:00
Michał Kruszewski fbd038c681 Update docs. 2019-10-12 10:09:50 +02:00
Jeremiah C Leary a974530bb5 Updates for issue #204
Added rule to handle generate label and generate keyword not on the same line:

  1)  Added generate_015 to flag label and keyword not on the same line
  2)  Added tests
  3)  Added documentation
  4)  Improved classification of generates to detect label and keyword not on the same line

NOTE:  This is currently not fixable.
2019-03-02 08:57:01 -06:00
Jeremiah C Leary 0a428dc19e Updates for issue #199
Adding generate_014 rule:

  1)  Added test
  2)  Added rule
  3)  Added documentation
2019-02-05 18:27:48 -06:00
Jeremiah C Leary 071be18b73 Updates for issue #199
Adding generate_013 rule:

  1)  Added test
  2)  Added rule
2019-02-05 17:44:15 -06:00
Jeremiah C Leary 33282679f1 Updates for issue #199
1) Added documenation for generate rules 008 through 012
  2) Rule 008 added
     a)  Added test
     b)  Added rule
2019-02-05 16:56:20 -06:00
Jeremiah C Leary 341b12d5c6 Refactored generate rules and added documentation. 2017-12-17 08:42:33 -06:00