Commit Graph

677 Commits

Author SHA1 Message Date
Jeremiah Leary 1430bcbd5d
Issue#976: Added prefix and suffix rules for function designators. (#987) 2023-08-07 18:34:01 -05:00
Jeremiah Leary 3697765cb0
Issue#952: Adding consistent case check for enumerated types. (#956) 2023-08-06 17:37:53 -05:00
JHertz5 e6f25f5332
Issue#981 Corrected None to "" in block comment example configurations. (#986)
* Issue#981 Corrected None to "" in block comment example configurations.

* Issue#981 Updated empty string's double quotes to single quotes for consistency.

---------

Co-authored-by: JHertz5 <jukka.herzog@live.co.uk>
2023-08-06 12:20:21 -05:00
JHertz5 a24651383e
Issue#970: Correcting title on Whitespace Rule Group page. (#972)
Co-authored-by: JHertz5 <jukka.herzog@live.co.uk>
2023-08-06 11:50:27 -05:00
JHertz5 21978ad81f
Issue#973: Correcting typo in code example on Configuring Rule Groups page. (#974)
Co-authored-by: JHertz5 <jukka.herzog@live.co.uk>
2023-08-06 11:13:19 -05:00
JHertz5 dce9d58639
Issue#979 Corrected links in pages within rule_groups directory. (#980)
Co-authored-by: JHertz5 <jukka.herzog@live.co.uk>
2023-08-06 07:20:46 -05:00
Jeremiah Leary 6a6390715c Issue#977: Fixing broken link in disabled rules documentation. 2023-08-06 06:50:20 -05:00
Jeremiah Leary 6ac68da4e9 Issue#977: Fixing broken link in configuration disabled rules documentation. 2023-08-06 06:44:53 -05:00
Jeremiah Leary ba1fe3d3a6
Issue#910: Implemented fix logic for rule constant_007. (#957) 2023-05-14 04:52:32 -05:00
Jeremiah Leary bab5fbd1f4
Issue#929: Fixing issue with moving label and the postponed keyword. (#933)
* 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.
2023-04-20 06:46:52 -05:00
Jeremiah Leary 1f15511992
Issue#918: Adding rules for function and procedure optional keywords. (#939)
* 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.
2023-04-19 07:01:22 -05:00
Jeremiah Leary 05b7693fc3
Issue#907: Removing rule procedure_412 (#941) 2023-04-13 07:46:27 -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 2f12bbd4dc
Issue #837 (#903): Adding listing of rules in rule groups. 2022-12-21 11:51:29 -06: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 6a4f748a87
Issue 850 (#861)
* Updates for issue #850

Adding rules to indent with keyword

  1)  Added documentation
  2)  Added tests
  3)  Added rules:
        concurrent_selected_signal_assignment_300
        selected_force_assignment_300
        selected_variable_assignment_300
        selected_waveform_assignment_300

* Adding the following rules:

  concurrent_selected_signal_assignment_500
  selected_force_assignment_500
  selected_variable_assignment_500
  selected_waveform_assignment_500

* Adding rules:

  concurrent_selected_signal_assignment_501
  selected_force_assignment
  selected_variable_assignment
  selected_waveform_assignment

* Adding rule:

  selected_force_assignment_502

* Fixing documentation.

* Adding rule selected_expressions_500

* Adding rule selected_waveforms_500.

* Adding rules:

  concurrent_selected_signal_assignment_100
  selected_force_assignment_100
  selected_variable_assignment_100
  selected_waveform_assignment_100

* Adding rules:

  concurrent_selected_signal_assignment_101
  selected_force_assignment_101
  selected_variable_assignment_101
  selected_waveform_assignment_101

* Adding rules:

  concurrent_selected_signal_assignment_102
  select_force_assignment_102
  select_variable_assignment_102
  select_waveform_assignment_102

* Adding rules:

  concurrent_selected_signal_assignment_103
  selected_force_assignment_103
  selected_varaible_assignment_103
  selected_waveform_assignment_103

* Adding rules:

  concurrent_selected_signal_assignment_104
  selected_force_assignment_104
  selected_variable_assignment_104
  selected_waveform_assignment_104

* Added rule selected_force_assignment_105.

* Adding rules:

  selected_expressions_100
  selected_waveforms_100

* Adding rules:

  selected_expressions_101
  selected_waveforms_101

* Adding structure base rule.

Adding rule selected_assignment_001

* Refactoring analysis functions to improve readability.

* Adding more options to rule selected_assignment_001.

* Adding documentation for selected_assignment rules.

* Adding rule selected_assignment_100.

* Adding rule selected_assignment_101.

* Adding rule selected_assignment_102.

* Adding rule selected_assignment_103.

* Adding rule selected_assignment_104.

* Adding rule selected_assignment_105.

* Adding rule selected_assignment_106.

* Adding rule selected_assignment_107.

* Removing unused file.

* Adding rule selected_assignment_500.

* Adding rule selected_assignment_501.

* Adding rule selected_assignment_502.

* Adding rule selected_assignment_503.

* Adding rule selected_assignment_300.

* Removing rules which were merged into selected_assignments.

  * concurrent_selected_signal_assignment
  * selected_force_assignment
  * selected_variable_assignment
  * selected_waveforms

* Updating indenting on selected with and semicolon keywords.

* Deprecating rule with_001.

* Adding rule selected_assignment_400.

Minor update to multiline_alignment_between_tokens base rule to support selected_assignment_400.

* Fixing yaml configuration.

* Fixing tags.

* Fixing last yaml example.

* Removing rule selected_assignment_001

* Removing unused directories.

* Fixing documentation links.

* Saving previous rule_001 to a temporary file.

* Adding rule selected_assignment_001

* Adding rule selected_assignment_002.

* Adding rule selected_assignment_003

* Adding rule selected_assignment_004.

* Removing subphase from rules.

* Adding rule selected_assingment_005.

* Adding rule selected_assignment_006.

* Fixing issue in base rule where processing order was not being preserved.

* Adding rule selected_assignment_007.

* Adding rule selected_assignment_008.

* Updated base rule to accept token pairs.

* Updating rule to use token pairs.

* Adding rule selected_assignment_009.

* Adding rule selected_assignment_010.

* Adding rule selected_assignment_011.

* Adding rule selected_assignment_012.

* Minor update to rule documentatin.
2022-12-13 18:06:54 -06:00
Jeremiah Leary d3b8e703e8
Issue 864 (#895)
* 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.
2022-12-13 18:05:24 -06:00
Jeremiah Leary 931b44fabd
#898 (#899): Updating installation instructions when using pip. 2022-12-09 12:08:33 -06:00
Jeremiah Leary 4ecbbec6de
#886 (#889) : Adding rule procedure_call_101
* Issue #886 : Adding rule procedure_call_101

* Removing duplicate base rule.
2022-11-29 07:10:45 -06:00
Jeremiah Leary fe6c2cc160 Merge branch 'master' of https://github.com/jeremiah-c-leary/vhdl-style-guide 2022-11-14 19:06:16 -06:00
Jeremiah Leary 7a11838514
#859 (#862): Updating "Fix" output on rule block_400. 2022-11-14 18:40:31 -06:00
Jeremiah Leary 10e73f297c Adding theory of operation section. 2022-11-13 15:35:02 -06:00
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
JHertz5 0cf42a6ff6
#869 (#870): Corrected broken URL for rule if_030 in Configuring Blank Lines page.
Corrected broken URL for rule if_030 in Configuring Blank Lines page.

Co-authored-by: Jukka Hertzog <jukka.herzog@live.co.uk>
2022-11-13 07:30:50 -06:00
JHertz5 fbf52bae30
#867 (#868): Correction in concurrent procedure call configuration documentation.
Correction in concurrent procedure call configuration documentation.

Co-authored-by: Jukka Hertzog <jukka.herzog@live.co.uk>
2022-11-12 13:00:50 -06:00
Jeremiah Leary afab411088 Commenting out old release method. 2022-11-07 06:11:07 -06:00
Jeremiah Leary dc57b0fd62
Updates for issue #851 (#860)
Adding tests to validate links to configuration documenation.
2022-11-04 14:02:58 -05:00
Jeremiah Leary 6aea9e7e2c Adding structure::optional tag to rule architecture_010. 2022-10-21 19:09:11 -05: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 f594818e21 Removing invalid link in whitespace_002 rule documentation. 2022-10-20 18:46:58 -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 4cd006748b
Updates for issue #843 (#844)
Adding case rule for enumerates types in type definitions.

  1)  Added documentation
  2)  Added test case
  3)  Added rule type_500
2022-10-18 17:02:12 -05:00
Jeremiah Leary 01dcf62648
Updates for issue #842 (#845)
Adding prefix/suffix rules for loop labels:

  1)  Added documentation
  2)  Added test cases
  3)  Added rules
      a)  loop_statement_600
      b)  loop_statement_601
2022-10-18 17:01:15 -05:00
Jeremiah Leary cc1242ee3b Minor updates to documentation. 2022-10-12 07:51:48 -05:00
Jeremiah Leary 79baa53d76
Updates for issue #832 (#835)
* Updates for issue #832

Added parameter to allow generate statement keywords to end groups.

  1)  Added tests
  2)  Added generate_statements_ends_group option to base rule configuring_keyword_alignment_rules
  3)  Updated documentation

* Defaulting generate_statement_ends_group option to false.

* Making generate_statement_ends_group enabled by default.
2022-10-10 06:35:50 -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 3296fee4cc
Issue 536 (#793)
* Updates for issue #536:

Adding classification of aggregate open and close parenthesis.

* Adding rules to address aligning => operator in record assignments.

  1)  Added rules:
      * concurrent_400
      * sequential_400
  2)  Added tests
  3)  Added documentation

* Minor formatting updates.

* Adding import of aggregate to fix runtime error.
2022-09-25 13:11:21 -05:00
Jeremiah Leary 607e2b9fc3
Updates for issue #825 (#826)
Adding rules for conditional_waveforms and conditional_expressions.

  1)  Added documentation
  2)  Added tests
  3)  Added rules
2022-09-25 12:44:25 -05:00
Jeremiah Leary 9f2c4f580f Adding release process documentation. 2022-09-22 20:38:19 -05:00
Jeremiah Leary 4da9b34583
Updates for issue #813 (#814)
* Updates for issue #813

Adding ability to classify configurations:

  1) Added additional tokens
  2) Added classifiers
  3) Updated test

* Adding unspecified token in between end for and semicolon.
This token is not in the LRM spec, but apparently some compilers allow it.

* Refactoring to improve readability.
2022-08-13 08:14:30 -05:00
Jeremiah Leary 625ae4a93b
Updates for issue #596 (#787)
* Updates for issue #596

Adding feature to output quality report.

  1)  Added tests
  2)  Added quality_report command line argument
  3)  Output quality report

* Removing extra blank line.

* Removing unused import

* Adding documentation for integration with CI servers.

* Refocusing CI documentation to the output which is generated.

* Improving documentation:

  1)  Made JUnit example smaller
  2)  Minor grammar updates

* Adding link from table to heading.

* Adding link from table to content in page.
2022-08-01 21:04:35 -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 b76065664b
Updates for issue #796 (#797)
Changing rule process_029 to be disabled by default.

  1)  Updated documentation
  2)  Updated rule
  3)  Updated tests
2022-07-15 06:35:21 -05:00
Jeremiah Leary 0152791dd8
Issue 800 (#804)
* Updates for issue #800

Adding rule case_generate_alternative_501 to enforce case on others keyword.

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

* Adding rule case_generate_statement_400 to align assignment tokens

  1)  Added documentation
  2)  Added test
  3)  Added rule
2022-07-15 06:25:45 -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 d596686891
Updates for issue #780: (#781)
* Updates for issue #780:

Adding rule to enforce indenting of the `end` keyword:

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

* Adding rule to ensure *end* keyword is on it's own line.

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

* Adding test to enforce indent of elsif keyword:

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

* Fixing *fix* solution.

* Fixing rule documentation.

* Adding rule to enforce alignment of else keyword:

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

* Removing rule generate_300 as it is a duplicate of rule generate_007.
2022-05-16 18:34:27 -05:00
jobtijhuis-philips 08400ece64
Fix broken links to Subprogram Body Rules (#786)
* Fix broken links to Subprogram Body Rules

* Fix spelling error in contributing page
2022-05-16 18:31:23 -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
Jeremiah Leary 72a0336fd9 Adding problems tab to VSCode documentation. 2022-05-11 20:03:15 -05:00