* 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#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.
* Issue#1009: Updating multiline alignment rules to accept booleans for parameters.
* Adding boolean to yes/no conversions for other rules.
* Converting rule after_002 to use yes/no strings for options.
* Updating base rule align_tokens_in_region_between_tokens_unless_between_tokens to use yes/no.
* Updating base rule align_tokens_in_region_between_tokens_skipping_lines_starting_with_tokens to accept yes/no.
* Updating base rule align_tokens_in_region_between_tokens to accept yes/no.
* Updating rule case_generate_statement_400 to accept yes/no.
* Updating rule concurrent_006 to accept yes/no.
* Fixing default value for generate_statement_ends_group in concurrent_006.
* Updating rule concurrent_008 to accept yes/no.
* Updating base rule align_tokens_in_region_between_tokens_when_between_tokens_unless_between_tokens to support yes/no
* Updating base rule align_tokens_in_region_between_tokens_unless_between_tokens to accept yes/no.
* Setting False options to 'no' in base rule align_tokens_in_region_between_tokens_unless_between_tokens.
* Updating block_comment rules to accept yes/no.
* Updating rule concurrent_400 to accept yes/no.
* Updating rule process_034 to accept yes/no.
* Updating rule process_035 to accept yes/no
* Updating rule process_400 to accept yes/no.
* Updating rule sequential_400 to accept yes/no.
* Updating rule subprogram_body_400 to accept yes/no.
* Updating rule concurrent_007 to accept yes/no.
* Updating rule library_003 to accept yes/no.
* Updating rule signal_012 to accept yes/no
* Updates for codeclimate issues.
* Moving similar alignment helper functions to utils file.
* Codeclimate updates.
* Updating option documentation to current standard.
* Changing default True option to 'yes'
* Updating configuration documentation to current standards.
* Updating configuration documentation to latest standard.
* Updating configuration rules to current standard.
* Replacing occurances of True/False with "yes"/"no"
* Updating configuration documentation to latest standard.
* Fixing documentation tests.
* Issue#992: Added rules to structure::optional rule group.
* Issue#992: Updated documentation to reflect new structure::optional rule group rules.
* Issue#992: Updated/added tests to check new structure::optional rule group rules.
* Issue#992: Removed test files.
* Issue#992: Removed erroneous newline.
* Issue#929: Fixing issue with moving label and the postponed keyword.
* Refactoring per code climate.
* Removing unused parameter.
* Adding rule process_039 to enforce postponed on same line as process.
* Issue #864, #887 : Adding rule declarative_part_400 to align := in signal, variable and constant declarations.
* Ensuring alignment rules are performed in order.
* Updating minor issues flagged by codeclimate.
* Changing blank_line_ends_group to True.
* 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.
* 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 #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 #562
Adding rule to align signal and variable assignment operators.
1) Updated documentation
2) Updated tests
a) Removed deprecated tests
b) Added process tests
3) Updated rules
a) Deprecated signal_005
b) Deprecated variable_assignment_005
c) Added rule process_400
* Updates for issue #562
Adding severity to test JSON output.
* Updates for issue #562
Formatting updates.
* Updates for issue #664
Colons in subprogram_declarative_parts were being aligned with process_declarative_parts.
1) Updated tests to expose the issue
2) Updated rule process_033 to exclude subprogram_declarative_parts
* Fixing codeclimate issue.
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
Updated base rule blank_line_above_line_starting_with_token to include comments and blank lines.
1) Updated tests
2) Removed existing options allow_comments and blank_line_above_comment
3) Added option method
4) Updated base rule to use method
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