* Issue#1251: Added rules function_507, procedure_508, and procedure_call_502.
* Issue#1251: Updated docstrings and docs for rules function_507, procedure_508, and procedure_call_502.
* Issue#1251: Updated docstrings and docs for rule groups.
* Issue#1251: Updated docstrings and docs for rule groups.
* Issue#1251: Updated expected test output.
* Issue#1251: Updated expected test output.
* Issue#1251: Added tests for rules function_507, procedure_508, and procedure_call_502.
* Issue#1251: Added rules function_508 and procedure_509.
* Issue#1251: Updated docs for function_508 and procedure_509.
* Issue#1251: Updated rule group docs for function_508 and procedure_509.
* Issue#1251: Minor consistency improvement.
* Issue#1251: Removed unused imports.
* Issue#1251: Corrected rules function_507 and procedure_508 to act on interface file declarations
* Issue#1251: Improved tests for function_507 and procedure_508
* Issue#1251: Updated get_function_subprogram_body and get_procedure_subprogram_body to handle nested declarations
* Issue#1251: Updates to consistent_subprogram_parameter_token_case. Still doesn't exclude nested regions unfortunately, but at least handles them perhaps satisfactorily.
* Issue#1251: Added tests for function_508 and procedure_509.
* Issue#1251: Removed unused code.
* Issue#1251: Formatting
* Issue#1251: Updated style tests.
* Issue#1251: Cleanup in consistent_subprogram_parameter_token_case
* Issue#1251: Fixed crash in case of subprogram with no interfaces.
* Issue#1251: Updated test file to exercise corner case
* Issue#1251: Updated test file to exercise corner case
* Issue#1251: Updated test file to exercise corner case
* Issue#1251: Updated test file to exercise corner case
* Issue#1251: Removed consistent case changes, to be split into a different PR.
* Issue#1253: Added rule function_510.
* Issue#1253: Added tests for rule function_510.
* Issue#1253: Updated documentation for rule function_510.
* Issue#1253: Updated documentation for rule function_510.
* Issue#1253: Changed rule function_510 to function_509 to avoid conflict with other in-progress branches.
* Issue#1253: Updated test script.
* Issue#1253: Adjusted whitespace in test files for consistency with other tests.
* Issue#1253: Split rules to act on pure and impure separately.
* Issue#1263: Added rules function_511 and procedure_511.
* Issue#1263: Added tests for rules function_511 and procedure_511.
* Issue#1263: Removed duplicate token in rules function_511 and procedure_511.
* Issue#1263: Updated docstring for rules function_511 and procedure_511.
* Issue#1263: Updated docs for rules function_511 and procedure_511.
* Issue#1117 Modifed initialisation of the `Rule` class's `identifier` property to reduce duplication.
* Issue#1117 Modifed initialisation of the `Rule` class's `unique_id` property to make the `identifier` input redundant.
* Issue#1117: Updated Rule.name attribute to be initialised from the class's `__module__` variable.
Modified `deprecated_rule` to not initialise `name` and `identifier` attributes.
Modified rule_localized_001 to force the local rule's `name` since this can't be extracted from the module.
Modified test_rule to force Rule's `name`, `identifier` and `unique_id` in some tests.
* Issue#1117: Removed now-redundant name and identifier input arguments on rule `__init__` methods.
Updated rule_localized_001 to force the rule's name.
Update the local rules documentation.
* Issue#1117: Removed unused exception in get_rule_name.
* Issue#1117: Updates after merging master.
* Converting match case to if statement to support python pre version 3.10Converting match case to if statement to support python pre version 3.10.
---------
Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
* 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>
* Issue#1081: Adding configuration option for constant_400
* Adding options to concurrent_400 and sequential_400.
* Refactored base rules to improve readability.
* Merging base rules:
align_tokens_in_region_between_tokens_unless_between_tokens merged into align_tokens_in_region_between_tokens
* Adding ignore_single_line_aggregates to rule constant_400
* Removing commented out code.
* Refactoring align_tokens_in_region_between_token_when_between_tokens_unless_between_tokens.
* Removing unused alignment options due to refactor.
* Rule could not determine the difference between subprogram_body and subprogram_declaration.
* Removing blank lines.
* Issue#950: Rule procedure_012 fails if function nested in procedure
* Issue#918: Adding rules for function and procedure optional keywords.
* Combining left and right base rules.
* Refactoring to improve readability.
* Fixing issue with keyword not being inserted.
* Updates for issue #852
Adding support the attributes in subtype indications.
1) Updated classifier subtype_indication to call type_mark
2) Updated get_sequence_of_tokens_matching
* Removing comments.
* 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.
* Updates for issue #730
Adding rules to handle case for use_clause selected names.
1) Added new tokens to use_clause
2) selected names now parsed with new tokens
3) Added rules:
a) use_clause_500
b) use_clause_501
c) use_clause_502
d) use_clause_503
4) Added tests
Resolves#730
* Refactoring to reduce duplication.
Removing trailing whitespace.
* Changing exceptions to case_exceptions.
1) case::name rules allow case_exceptions by default
2) Updated instantiated_unit to split entity_name with a library name
3) Rule instantiation_028 simplified
4) Removed unused test file
* Refactoring to reduce complexity.
* Refactoring to improve readability.
* Fixed isue with procedure_506 crashing VSG due to missing variable.
* Fixing missing call to lowercase list.
* Adding the following rules:
context_ref_500
context_ref_501
Deprecated the following rules:
context_ref_004
* Placing common code into a single file.
* Removing trailing whitespace.
* Refactoring to reduce the number of parameters.
* 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.
* 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.
* Updates for issue #639
Addressing issue where function and procedure rules were identical.
1) Updated documentation
a) Added documentation for subprogram_body rules
b) Updated deprecated rule documentation
2) Updated tests
a) Removed deprecated rule tests
b) Added subprogram_body rules
c) Updated function and procedure rules to show the issue
3) Updated rules to ensure function rules operate on functions and procedure rules operate on procedures
a) function_013, procedure_008
b) function_015, procedure_010
c) function_012, procedure_401
d) function_502, procedure_502
e) function_004, procedure_503
f) function_013, procedure_504
g) function_506, procedure_506
4) Moved function and procedure rules to subprogram_body rules
a) function_201, procedure_201 --> subprogram_body_201
b) function_202, procedure_202 --> subprogram_body_202
c) function_203, procedure_203 --> subprogram_body_203
d) function_204, procedure_204 --> subprogram_body_204
e) function_007, procedure_205 --> subprogram_body_205
5) Deprecated rules
a) function_201, procedure_201
b) function_202, procedure_202
c) function_203, procedure_203
d) function_204, procedure_204
e) function_007, procedure_205
* Adding files which were missing from previous commit.
* Removing unused file.
* Updates for CodeClimate.
* Refactored filter_token_pairs to improve readability.
* Refactoring get_tokens_bounded_by_unless_betweent to improve readability.
* Removing unused code in get_tokens_bounded_by_unless_between function.
* Removing unused import.
Additional changes:
1) Added new base rule token_case_with_prefix_suffix
2) Changed required rules to use new base rule
3) Refactored shared logic into package