Commit Graph

65 Commits

Author SHA1 Message Date
Jeremiah Leary 7adbcc0003
Issue#1176: Updating rule instantiation_005 to allow for adding or remmoving carriage returns. (#1180) 2024-06-19 05:18:52 -05:00
JHertz5 51a95c2096
Issue#1103: Adding structure rules for subprogram specifications. (#1108)
* Issue#1103 Added rule for multiline subprogram specification structure.

* Issue#1103 Added rule function_019.

* Issue#1103 Added rule procedure_013.

* Issue#1103 Restored inteface_list_semicolon to subprogram_specification rule.

* Issue#1103 Documentation updates.

* Issue#1103 Removal of superseded rules.

* Issue#1106 Added unittests for procedure_013.

* Issue#1106 Correction to subprogram specification strucutre to include other kinds of interface element

* Issue#1106 Added unittests for function_019.

* Issue#1106 Updated examples for rules function_019 and procedure_013.

* Issue#1106 Modified subprogram specification defaults to avoid changing existing styles.

* Issue#1103: Updated configuration documentation link for the multiline_subprogram_specification_structure class.

* Issue#1103: Updated default value for the `interface_element` attribute of `multiline_subprogram_specification_structure` rules to `add_new_line`

* Issue#1103: Corrected configuration documentation link for the multiline_subprogram_specification_structure class to be a string instead of a non-existent variable.

* Issue#1103: Corrected the link name for `configuring-procedure-call-statement-rules`.

* Issue#1103: Updated default value for the `interface_element` attribute of `multiline_subprogram_specification_structure` rules to `ignore`.

* Issue#1103: Updated default configuration of subprogram specification rules.

* Issue#1103: Updated JCL style with function_019 settings

* Adding picture to illustrate where options will take affect.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2024-01-27 09:35:04 -06:00
Jeremiah Leary 18c3c4b8e7
Issue#1074: procedure_call_003 now includes sequential procedure calls. (#1075)
* Issue#1074:  procedure_call_003 now includes sequential procedure calls.

* Updating documentation to differentiate between concurrent_procedure_call_statement and procedure_call_statement.
2023-12-21 08:34:44 -06:00
Jeremiah Leary 5c85734a07
Issue#1054: Adding classification of pragmas. (#1056)
* Issue#1054:  Adding classification of pragmas.

* fix 'keyError: regexp' by dStyle having parse regexp and dConfig not (#1058)

* Adding pragma configuration tests.

* Stopping pragma search if a match is found.

* Refactoring classifications of pragmas to improve performance.

---------

Co-authored-by: Gerard Sharp <43923557+SittingDuc@users.noreply.github.com>
2023-12-03 21:09:52 -06:00
Jeremiah Leary 7ba4904371
Issue#1053: Adding rule to check for reserved words. (#1055)
* Issue#1053:  Adding rule to check for reserved words.

* Removing unused token classes.

* Fixing documentation.
2023-12-01 07:41:39 -06:00
Jeremiah Leary 92503eee82
Issue#1030: Adding option to indent use_clauses depending on existence of library_clause. (#1031)
* Issue#1030:  Adding option to indent use_clauses depending on existence of library_clause.

* Updates for codeclimate.

* Adding tests for new configuration option.

* Adding documentation.

* Fixing syntax error in documentation.
2023-10-27 17:01:57 -05:00
Jeremiah Leary 4eac4c53c3
Issue#1008: Removing duplicate configuration documentation. (#1019) 2023-10-22 06:40:24 -05:00
Jeremiah Leary fb3160cb37
Issue#927: Adding checks for keywords in comments. (#934)
* Issue#927:  Adding checks for keywords in comments.

* Fixing spacing issue.
2023-04-11 10:48:39 -05:00
Jeremiah Leary 7fc6404f49
#827 (#838): Updating comment_100 to be configurable.
* Updates for issue #827

Changing behavior of comment_100:

  1)  block comments are ignored
  2)  Exceptions added to ignore rule

* Fixing style issue.

* Adding rule comment_101 to enforce whitespace after a comment pattern.

* Merging comment_101 into comment_100.

* Allowing patterns to be configurable.

* Updating documentation to current standards.

* Updating note.

* Moving Note into description for each option.

* Fixing grammar.
2022-12-13 18:20:22 -06:00
Jeremiah Leary cb98aebdcb
Updates for issue #846 (#848)
* Updates for issue #846

Rules whitespace_012 and whitespace_200 were duplicates.

   1) Moved whitespace_012 to whitespace_200.
   2) Deprecated whitespace_012

* Adding missing documentation.
2022-10-21 06:41:17 -05:00
Jeremiah Leary d66da9a6a8
Issue 549a (#839)
* Updates for issue #549

Refactoring concurrent_011 into base rule multiline_simple_structure.

* Refactoring concurrent_009 into base rule multiline_conditional_alignment.

* Fixing name and identifier.

* Refactoring rule constant_012 into base rule multiline_array_alignment.

* Adding rule variable_assignment_007.

* Adding rule variable_assignment_008

  1)  Refactored multiline_structure to be configurable
  2)  Added documentation
  3)  Added tests

* Adding rule variable_assignment_400.

* Adding rule variable_assignment_400.

* Updating Documentation

  1)  Adding files which were not being built
  2)  Fixed links

* Adding rule concurrent_012.

* Adding rule concurrent_401

* Adding rule sequential_008.

* Adding rule sequential_009.

* Adding rule sequential_401

* Adding rule sequential_402

* Fixing documentation

* Fixing table rendering.

* Changing multiline_alignment_between_tokens to not work on arrays.

* Updating rule concurrent_011 to not operate on arrays.

* Fixing documentation issues:

  1)  Renamed several rules to improve readability
  2)  Fixed warnings from sphynx
  3)  Fixing links

* Adding links to rules.

* Updating docstring with correct links to configuration documentation.

* Updating formatting to match current standards.

* Updating formatting to current standard.

* Changing depricated to deprecated.

* Removing unused documentation.

* Updating table to current standards.

* Updating to latest standard.

* Updating to current formatting standards.

* Updating multiline indent rule:

  1)  Updated documentation
  2)  Added align left no align paren on tests
  3)  Updated the following options:
      a)  align_left_yes_align_paren_yes
  4)  Updated docstrings to have correct links.

* Adding example for align_left_no_align_paren_yes.

* Updating documentation per comments.

* Updating documentation per comments.

* Removing option move_last_comment from multiline_structure base rule.
2022-10-20 18:24:42 -05:00
Jeremiah Leary 9f65068692
Updates for issue #559: (#798)
* Updates for issue #559:

Adding documentation for configuring indent rules.

* Adding documentation:

  1)  Updated whitespace_002
  2)  Added whitespace_014
  3)  Added configuring tabs vs spaces

* Adding example documentation.
Fixing table.

* Updated documentation:

  1)  Removed whitespace_014
  2)  Updated whitespace_002 to only work on middle tabs
  3)  Removed configuring_tabs_vs_spaces document
  4)  Removed tabs as an option for indenting

* Updating token indent rules.

* Adding smart_tabs test for rule assert_statement_001

* Updating rule assert_400 to allow smart tabs.

* Refactoring assert_400 to improve readability.

* Refactoring to reduce complexity.

* Updates for rule case_011 and assert_400:

  1) Replaced align_consecutive_lines_after_line_starting_with_token_and_stopping_with_token with assert_400
  2) Updated rule assert_400 to inherit align rule
  3) Changed rule case_011 to use align rule

* Removing rule case_021.

The function of the rule is now covered by comment_010.

* Deprecating rule case_generate_alternative_300.

* Refactoring analyze to _analyze.

* Splitting configuration of rule assert_400 into its own page.

* Updating multiline_alignment_between_tokens to handle smart tabs.

* Deprecating rules if_032 and if_033.  They are covered by comment_010.

* Updated report_statement_400 to use align_consecutive_lines_after_line_starting_with_token_and_stopping_with_token.

* Updating rule process_028 to handle smart-tabs

 1) Updated tests
 2) Updated base rule align_left_token_with_right_token_if_right_token_starts_a_line

* Updating rule library_009 to handle smart-tabs

  1)  Updated tests
  2)  Updated base rule align_consecutive_lines_starting_with_a_comment_above_line_starting_with_token

* Minor formatting updates.

* Adding methods to support multiline alignment base class.

* Refactored rule constant_012 to split indent and alignment whitespace.

* Adding smart-tab support to rule constant_012.

* Removing old classify code.

* Removing debug print statement.

* Updating documentation for assert and report_statement rules.

* Updating rule concurrent_009 to support smart-tabs.

  1)  Added tests
  2)  Updated rule to support smart-tabs

* Updating documentation to match current implementation.

* Taking a different approach for multiline_alignment_between_tokens.

  1)  Reverted smart_tabs changes
  2)  Updated base rule to method employed on concurrent_009
  3)  Commented out smart_tab tests

* Updated missing meta data to Toi in rule constant_014

Fixed error in align_left_no_align_paren_no analyzer.

* Adding smart-tab support to base rule multiline_alignment_between_tokens.

* Updating alignment rules to support smart tabs.

  1)  Updated base rules
      a) vsg/rules/align_tokens_in_region_between_tokens.py
      b) vsg/rules/align_tokens_in_region_between_tokens_skipping_lines_starting_with_tokens.py
      c) vsg/rules/align_tokens_in_region_between_tokens_unless_between_tokens.py
  2)  Updated rule concurrent_008
  3)  Added tests

* Fixing issue with rule port_map_009 misfiring if the following token sequence occured:  comma, whitespace, carraige return.

* Updating solution for indent rules to give required tabs and spaces.
Fixing several bugs in indent implementation:
  1)  checking for smart-tabs instead of smart_tabs

* Updates for Codacy issues.

* Additional Codacy updates.

* Fixing style issues identified by CodeClimate.

* Additional style fixes identified by CodeClimate.

* Refactoring alignment rules:

  1)  Created utils file specifically for alignment rules
  2)  Refactored rules to move identical code into utils file

* Moving update_column_width into alignment_utils file.

* Moving functions into alignment_utils:
  1)  get_first_line_info
  2)  starts_with_paren

* Using functions in alignment_utils.

* Collapsing branches to improve readability.

* Refactoring to improve readability.
2022-10-07 08:01:03 -05:00
Jeremiah Leary bc85de813c
Updates for issue #791 (#799)
* Updates for issue #791

Adding rule procedure_call_401

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

* Adding documentation for rule procedure_call_003.

* Fixing element name in configuration.

* Initial tests for rule procedure_call_003.

* Changing options.

* Fixing option table.

* Adding rule procedure_call_003

  1)  Added base rule multiline_procedure_call_structure
  2)  Added tests
  3)  Added rule

Fixed bug in vhdlFile.utils.find_previous_non_whitespace_token

* Removing unused functions.

* Moving identical code to common module.

* Minor formatting updates.

* Moving identical functions to fix.py

* Moving indentical functions to other modules.

* Moving indentical functions to a single module.

* Removing unused functions.

* Removing unused variables.

* Refactoring whitecase adjustment.

* Adjusting rule procedure_call_400 to include the open parenthesis.

* Removing unused imports and variables.
2022-07-29 06:48:07 -05:00
Jeremiah Leary 7225df8b9d
Updates for issue #539 (#751)
* Updates for issue #539

Adding multiline structural rule for rule signal_016.

  1)  Added test cases
  2)  Update rule signal_016
  3)  Updated documentation

* Adding test for arrays.

* Adding functions to combine slices into a single object

* Adding array_first_paren_new_line option.

* Removing unused code.

* Adding tests for the following parameter options:

  1)  array_first_paren_new_line (yes/no)
  2)  first_paren_new_line (yes/no)

* Adding documentation for configuring multiline constraint rules.

* Minor grammar updates.

* Updating per feedback:

  1)  Made symbols in table with a transparent background
  2)  Minor grammar updates
  3)  Fixed indenting in code examples

* Adding correct red penta star png file.

* Upated third example to correctly show behavior.

* Updated figure with correct indenting.
Fixed indenting in example 2.

* Adjusting indent on example 3 and example 4.

* Initial rewrite to classify constraints.

* Converting variable_declaration to call subtype_indication.classify.

* Changing constant_declaration to use subtype_indication.classify

* Changing unbounded_array_definition to use subtype_indication.classify

* Changing subtype_declaration to use subtype_indication.classify

* Changed interface_variable_declaration to call subtype_indication.classify

* Changing the following to use subtype_indication.classify:

  interface_constant_declaration
  interface_file_declaration
  interface_signal_declaration
  interface_unkown_declaration

* Changing the following to use subtype_indication.classify:

  constrained_array_definition

* Changing the following to use subtype_indication.classify

  element_subtype_definition

* Changing the following to use subtype_indication.classify:

  alias_declaration

* removing commented out line.

* Changing the following to use subtype_indication.classify:

  file_declaration

* Changing the following to use subtype_indication.classify

  access_type_definition

* Removing subtype_indication.classify_until

* Initial commit of rule signal_017

  * Implemented record_constraint_open_paren = add_new_line

* Minor refactoring.

* Extracted the following functions:

  _check_add_new_line
  _token_at_beginning_of_line

* Adding the following options to rule signal_017

  *  record_constraint_open_paren :: remove_new_line

* Adding the following options:

  record_constraint_close_paren :: add_new_line
  record_constraint_close_paren :: remove_new_line

* Adding the following options:

  record_constraint_comma :: remove_new_line

* Adding the following option:

  record_constraint_element :: add_new_line
  record_constraint_element :: remove_new_line

* Adding the following option:

  * array_constraint :: all_in_one_line

* Fixing issue with array_constraint::all_in_one_line not detecting multiline array_constraints.

* Adding the following options:

  array_constraint :: one_line_per_dimension

* Adding rule signal_400 to handle indenting of multiline signal constraints.

* Fixing issues for Codacy.

* Refactoring to reduce complexity and improve readability.

* Adding links to new rules.

* Refactoring to improve readability.

* Refactoring to improve readability.

* Fixing style issues.

* Updating for style issues.

* Updating formatting issues.

* Removing unused file.

* Removing commented out debug statements.

* Minor formatting updates.

* Adding metadata attribute and methods.

* Refactoring _check_array_contraint_one_line_per_dimension function to improve readability.

* Refactoring _check_array_constraint_all_in_one_line function to improve readability.

* Refactoring _create_violation to just take oToi as a parameter.

* Adding exception logic.

* Refactoring to improve readability.

* Refactored analyze_exception_one to improve readability.

* Refactoring the following functions:

  * _check_array_constraint_all_in_one_line
  * _check_array_constraint_one_line_per_dimension

* Refactoring the following functions:

  *  add_index_constraint_open_parenthesis
  *  add_index_constraint_close_parenthesis
  *  add_record_constraint_open_parenthesis
  *  add_record_constraint_close_parenthesis

* Refactoring to improve readability.

* Minor formatting updates.

* Adjusting signal_400 to remove extra level of indent.

* Updates for rule signal_400:

  1)  Modified base rule multiline_alignment_between_tokens to support signal_400
  2)  Added tests for the four variants of options.

* Fixing style issues.

* Simplifying _check_new_line_after_comma function.

* Deprecating rule signal_016.

* Removing unused base rule multiline_declaration_structure.

* Style and minor refactorings.

* Moving filtering of toi's from _analyze to _get_tokens_of_interest.

* Extracted update_open_paren_counter from _classify_assignment

* Extracted update_close_paren_counter form _classify_assignment

* Refactoring _fix_violation to reduce complexity

* Refactored _create_violation:

  1)  Placed violation information into oToi object

* Refactoring to reduce complexity.

* Adding rule constant_017

* Adding rule variable_017

* Updating links to rules.

* Adding rule variable_400.

* Minor cleanup of documentation.

* Adding default values for options.

* Minor updates for formatting:
2022-07-08 08:26:29 -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 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 3e5648c5b4
Rule port_007 updated to check spaces before and after. (#712)
* Rule port_007 updated to check spaces before and after.

* Refactoring base rule spaces_before_and_after_tokens_when_bounded_by_tokens.

* Attempting to get test to pass.

* Fixing minor issues.

* Refactoring to improve readability.

* Refactoring to improve readability.

* Updates for code coverage:

  1)  Improved testing
  2)  Removed unused test input

* Updating rule port_008 to cover spaces before and after out keyword.

* Converting rule port_009 to check for spaces before and ader inout keyword.

* Adding updated documentation for rule port_009.

* Deprecating rule port_005.
2022-02-04 18:32:41 -06:00
Jeremiah Leary 68c8ff7241
Implementing issue #709 (#713)
* Changing rule port_map_004 to allow for moving the closing parenthesis to the same line as the last part assignment.

* Skipping JSON test as a fix was already performed on another branch.

* Removed trailing spaces.

* Converted generic_map_004 to use move_token base rule.

* Adding rule instantation_035.

* Refactoring to improve readability.

* Updating documentation.

* Updated rule generic_010 to allow for parenthesis to be on same line or next line.
Added rule generic_021 to enforce semicolon next to closing parenthesis.

* Refactoring to improve readability.

* Updating rule port_014 to allow for moving the closing parenthesis to the previous line.
Adding rule port_027 to force semicolon to be next to closing parenthesis.
2022-02-04 18:25:10 -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 caa57319ea Attempting to fix ReadTheDocs build. 2021-10-28 07:17:26 -05:00
Jeremiah Leary 630adf7966 Attempting to fix documentation generation. 2021-10-27 09:18:00 -05:00
Jeremiah Leary e9fc9d8913 Updates for issue #653:
Adding additional documentation for configuring indents.
2021-10-27 08:20:23 -05:00
Jeremiah Leary 2954d95115 Updates for issue #540:
Adding icons to denote phases, severity levels and disabled.
2021-03-31 21:26:57 -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 984b4245f4 Updates for issue #499
Adding rule concurrent_011 to handle structural formatting of concurrent statements.

  1)  Added documentation
  2)  Added tests
  3)  Added rule concurrent_011
2021-03-07 21:04:33 -06:00
Jeremiah Leary a4199663df Updates for issue #499:
Updating documentation to include configuring information.
2021-03-07 20:13:03 -06:00
Jeremiah Leary a04ac0abe7 Updates for issue #450:
Split documentation for multiline rules into indent and structure.
2021-02-22 17:22:47 -06:00
Jeremiah Leary 0a50b02d0c Updates for issue #450:
Adding intial documentation for configuring multiline rules.
2021-02-22 17:22:47 -06:00
Jeremiah Leary 69b157fa91 Adding configuring previous line documentation. 2021-01-16 14:33:40 -06:00
Emil Vanherp 73420cdca2
remove trailing whitespace 2021-01-11 21:55:56 +01:00
Jeremiah Leary be88d4a462 Updates for issue #445
Adding ability for the user to adjust the indenting algorithm.

  1)  Added documentation
  2)  Refactored indent algorithm
      a)  Changed algorithm to use a YAML configuration file
  3)  Added indent dictionary to -oc output
  4)  Updated tests to use new YAML configuration file
2020-12-20 18:06:07 -06:00
Jeremiah Leary 5cd7afd6f4 Updates for issue #373
Adding rules to analyze block comments.

  1)  Added documentation
  2)  Added tests
  3)  Added rules
      a) block_comment_001
      b) block_comment_002
      c) block_comment_003
  4)  Added new extract method
      a) get_consecutive_lines_starting_with_token
2020-12-19 19:48:40 -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 30bfcad756 Updates for issue #410
Adding rule to enfore component or entity instantiations:

  1)  Added documentation
  2)  Added tests
  3)  Added rule instantiation_034
2020-12-08 15:01:36 -06:00
Jeremiah Leary d4f08e36eb Updates for issue #408
Adding check for length of file.

  1) Documentation updates
     a)  Added documentation for rule length_002
     b)  Added section in configuring length rules to cover length_002
  2) Added tests
  3) Added rule length_002
2020-12-08 10:23:26 -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 2effb76817 More documentation fixes. 2020-07-18 16:11:47 -05:00
Emil Vanherp fcc4359afe fix invalid yaml in docs 2020-07-16 14:39:51 +02:00
Jeremiah Leary 3328f3c2fe Updates for issue #426:
Moved multiple configuration documentation from usage.rst to it's own file and then it is called by configuring.rst.
2020-06-22 21:30:30 -05:00
Jeremiah C Leary b2c2228ba1 Updates for issue #344
Added ability to set rule individual rule configurations.

  1)  Updated documentation
  2)  Updated parsing of configuration files to handle individual rule configurations.
2020-02-28 07:24:26 -06:00
Michał Kruszewski 2f08a64bda Refactor keyword alignment rules. 2020-02-24 21:14:44 +01:00
Jeremiah C Leary 777661841a Fixing headers in documentation. 2020-02-23 19:55:26 -06:00
Jeremiah C Leary 4c962c9bc6 Updates for issue #339:
The configuration of a single rule can be requested:

  1)  Added tests
  2)  Updated documentation
  3)  Updated code
2020-02-22 17:53:31 -06:00
Jeremiah C Leary 144473f164 Updates for issue #271
Adding rule length_001 to check for line length violations:

  1)  Added documentation
  2)  Added tests
  3)  Added rule length_001
2019-11-10 14:53:48 -06:00
Jeremiah C Leary 8abcf7877b Updating documentation for rule signal_015. 2019-11-10 06:51:34 -06:00
Jeremiah C Leary 15308e63fc Resolving warnings in documentation.
issue #269
2019-10-17 07:10:31 -05:00