Commit Graph

26 Commits

Author SHA1 Message Date
Jeremiah Leary 6b01c4c6d1
#871 (#872): Updating documentation links.
* Issue #830:  Updating documentation links.

* Adding length rule link validation.

* Removing blank line at end of file.

* Fixing typo

* Updating links.

* Added test to check for underscores in links.

* Updating whitespace configuration links.

* Updating blank line links.

* Updating structure links.

* Updating naming rule links.

* Adding alignment configuration links.
2022-11-13 12:02:54 -06: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 a8df0436d4 Fixing grammar in documentation. 2022-05-02 06:40:29 -05:00
Jeremiah Leary a66b65632a
Updates for issue #746 (#748)
* Updates for issue #746

Moved library_600 to library_500.
Added exceptions for invalid configurations.

* Removing whitespace.
2022-04-10 20:09:20 -05:00
Jeremiah Leary f663ccfec8 Fixing linking for library rules. 2022-02-05 16:50:43 -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 f643aaa143
Updates for issue #688 (#706)
Adding rule library_600 to enforce capitalization of library logical names.

  1)  Added test
  2)  Added documentation
  3)  Added rule library_600
  4)  Disabled rule in jcl style
2022-01-31 04:54:29 -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 4f652b3c4d Minor documentation updates. 2021-10-06 15:52:38 -05:00
Jeremiah Leary 446a3ebe31 Updates for issue #540
Adding icons to all rules.
2021-04-01 22:02:05 -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 58b1ad0492 Updates for issue #504:
Changing rules enforcing a blank line below to also allow for removal of line below.

  1)  Updated documentation
  2)  Updated tests
  3)  Updated base rule blank_line_below_line_ending_with_token
2021-01-29 19:43:33 -06:00
Emil Vanherp 73420cdca2
remove trailing whitespace 2021-01-11 21:55:56 +01:00
Jeremiah Leary eb31465fb5 Updates for issue #491:
Adding allow_library_clause option to rule library_003 to allow consecutive library clauses.

   1)  Added tests
   2)  Added option allow_library_clause to rule library_003
   3)  Updated documentation
2020-12-17 11:51:16 -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 ba5ae10b8e Updates for issue #393:
Adding two new library rules:

  1)  Added rules library_010 and library_011
  2)  Added tests
  3)  Added documentation
2020-07-26 14:48:02 -05:00
Jeremiah Leary abe3cb3418 Updates for issue #393:
Refactoring of library and base rules:

  1)  Most library rules refactored to use new base item rules
  2)  Base item rules refactored to use the region method on vhdlFile
  3)  Tests updated
  4)  Documentation updated
2020-07-26 12:54:43 -05:00
Michał Kruszewski b6226ecb7d Set the default case to lowercase for all case rules. 2020-03-29 21:26:15 +02:00
Michał Kruszewski 1ba47f234c Move comment rule 001 to library rule 009. 2020-03-29 09:21:15 +02: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 4c6a52b123 Adding documentation.
Refactored several rules.
2017-12-10 08:33:17 -06:00