Commit Graph

50 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
Jeremiah Leary 6aea9e7e2c Adding structure::optional tag to rule architecture_010. 2022-10-21 19:09:11 -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 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
bae-pabr 1b3853a0c4
fix typo in example ('disabled' -> 'disable') (#732)
* fix typo in example ('disabled' -> 'disable')

* fix typo in example ('disabled' -> 'disable')

also update doc string in the rule file (must match the restructured text documentation)
2022-02-10 08:17:09 -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 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 3cc5ac6849
Issue 554a (#659)
* Updates for issue #554

Adding rule to ensure case of ports match in architecture body.

  1)  Added tests
  2)  Added rule architecture_601

* Updates for issue #554

Checking actual_part from component instantiations:

  1)  Added documentation
  2)  Expanded testing to include component instantiations
  3)  Updated rule architecture_601

* Updates for issue #554

Refactoring to improve readability.

* Updates for issue #554

Minor formatting updates.

* Updates for issue 554

Addressing Codacy issues.

* Updates for issue #554

Additional updates for Codacy.
2021-11-03 08:18:40 -05: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 2b76330f28 Minor grammar updates. 2021-05-12 07:42:48 -05:00
Jeremiah Leary bd977a40f6 Updates for issue #560
Additional header updates which were missed on previous commit.
2021-05-05 06:54:00 -05:00
Jeremiah Leary 446a3ebe31 Updates for issue #540
Adding icons to all rules.
2021-04-01 22:02:05 -05:00
Jeremiah Leary 97de796930 Updates for issue #540
Adding icons for architecture rules.
2021-04-01 18:35:50 -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 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 0d0e35c986 Updates for issue #446:
Updating documentation for rules entity_600 and architectecture_600 to fix minor errors.
2020-12-31 10:07:05 -06:00
Jeremiah Leary 8d8169dbe3 Updates for issue #446:
Adding rules to check for consisent capitalization of generic identifiers.

  1)  Added documentation
  2)  Added tests
  3)  Added rules
      a) entity_600
      b) architecture_600
2020-12-28 13:49:21 -06:00
Jeremiah Leary b3b245afbc Updates for issue #487
Adding rule to check for blank lines after an architecture body.

  1)  Added documentation
  2)  Added test
  3)  Added rule architecture_200
2020-12-19 11:51:54 -06:00
Jeremiah Leary 685494b2ac Updates for issue #487:
Adding links to architecture_rules.
Fixing copyright date.
2020-12-18 18:54:54 -06: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 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 b0971f5501 Refactored rule architecture_002 for new parser.
1)  Removed rule architecture_002
   2)  Added rules:
         architecture_030
         architecture_031
         architecture_032
         architecture_033
   3)  Updated documentation
2020-09-26 10:21:53 -05: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 02b3835381 Updates for issue #432:
Adding rule architecture_029 to align idenifiers in signal, constant, variable, file, type and subtype declarations.

  1)  Updated documentation
  2)  Added tests
  3)  line class updates
      a)  Added new architecture attribute
      b)  Added new method to update the line attributes from tokens
  4)  Added rule architecture_029
2020-06-25 09:58:49 -05:00
Michał Kruszewski 3b1942f80d Split architecture_009. 2020-06-23 10:12:32 +02:00
Michał Kruszewski acaddc02cb Improve architecture rules documentation. 2020-04-06 09:44:41 +02:00
Michał Kruszewski b6226ecb7d Set the default case to lowercase for all case rules. 2020-03-29 21:26:15 +02:00
Michał Kruszewski 0f0ec0f47c Refactor keyword alignment rules - part 2. 2020-03-17 11:22:25 +01:00
Michał Kruszewski 2f08a64bda Refactor keyword alignment rules. 2020-02-24 21:14:44 +01:00
Jeremiah C Leary 0f4f0ba88b Updates for issue #337
Updated rule architecture_005 to move the "of" keyword to the same line as the architecture keyword.

  1)  Updated tests
  2)  Updated code
  3)  Updated documentation
2020-02-21 22:23:28 -06:00
Michał Kruszewski 985ea8da9c Make architecture rules inherit from case rule. 2020-01-20 20:59:49 +01:00
Jeremiah C Leary 950c19dd26 Updates for issue #288:
The follow case rules were made configurable:

  architecture_004
  architecture_019
  architecture_020
  architecture_021

  1)  Updated documentation
  2)  Updated tests
  3)  Updated rules
2019-11-30 10:29:26 -06:00
Jeremiah C Leary 1b869ff8af Updates for issue #288:
Updated rules architecture_013 and architecture_014 so their case can be user defined.

  1)  Updated documentation
  2)  Added tests
  3)  Updated rules architecture_013 and architecture_014
2019-11-30 08:40:33 -06:00
Jeremiah C Leary 9b7e7b179f Updates for issue #288:
Updated rule architecture_011 to allow the user to set the case for the architecture name.

  1)  Updated documentation
  2)  Added test
  3)  Updated rule arechitecture_011
2019-11-30 08:09:10 -06:00
Jeremiah C Leary 0b4c10ee5c Updates for issue #265:
Adding rule architecture_025 to enforce naming of architectures.

  1)  Added tests
  2)  Added documentation
  3)  Added rule architecture_025
2019-10-12 21:04:43 -05:00
Jeremiah C Leary b93b63ea03 Adding documentation for architecture rules. 2017-12-11 19:25:04 -06:00
Jeremiah C Leary 95f9cd4608 Updating documentation for architecture rules. 2017-12-10 21:05:15 -06:00
Jeremiah C Leary a606421723 Updates for issue #43
1)  Added fix for architecture_006
  2)  Refactored entity_005
  3)  Added documentation
2017-12-07 20:04:11 -06:00
Jeremiah C Leary 6788348eb5 Restructuring documentation to improve presentation. 2017-12-05 08:35:45 -06:00
Jeremiah C Leary d9bb061050 Updates for issue #104
1)  Created new attribute on the line class that holds line contents with comments.
      This will allow the classifiers to ignore anyting in comments.
  2)  Updated documentation:
      a)  Added instantiation_014 documentation
      b)  Updated architecture documentation
      Still trying out different options.
2017-12-03 21:10:30 -06:00