* Issue#1096: Changing indentStyle to indent_style and indentSize to indent_size.
* Adding tests for rule deprecated options
* Adding test for global deprecated option.
* Adding test for groups.
* Added recursive function to check all leaves for deprecated options.
* Raise exception if indentSize or indentStyle detected in a configuration.
* Adding smart_tab tests.
* Fixing indent_type to indent_style.
* 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>
* Adding tokeninzing, tokens and classifying documentation.
* Minor grammar updates.
* Fixing build issues.
* Adding clarifying notes about status of documentation.
* 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.
* Issue#1112 Added unit test for configuring disabled rules doc list of rules.
* Issue#1112 Updated list of rules in configuring disabled rules doc.
* Issue#1112 Cleared duplicate instances of lActual.
* Update configuring_disabled_rules.rst
Adding missing rules.
---------
Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
* Issue#1110 Added new rules for prefix/suffix enforcement on loop/generate parameter identifiers.
* Issue#1110 Documentation updates for the new loop/generate rules.
* Issue#1110 Added unit tests for the new loop/generate rules.
* Issue#1110 Documentation updates.
* Issue#1082 Added rules assert_100, assert_101, and assert_102 for whitespace in assert statements.
* Issue#1082 Added documentation for rules assert_100, assert_101, and assert_102.
* Issue#1082 Added tests for rules assert_100, assert_101, and assert_102.
* Issue#1082 Added missing comma to uppercase and lowercase rules page.
* Issue#1082 Added rules assert_500, assert_501, and assert_502 for keyword case in assert statements.
* Issue#1082 Added documentation for rules assert_500, assert_501, and assert_502.
* Issue#1082 Added tests for rules assert_500, assert_501, and assert_502.
* Issue#1086 Updated the configuring_multiline_indent_rules page to use the rule configuration example that is relevant to the VHDL examples given later on.
* Issue#1086 Updated the configuring_multiline_indent_rules page to correct the VHDL examples.
* Issue#1086 Updated the configuring_multiline_indent_rules page to remove trailing whitespace.
* Issue#1084 Corrected error in docstring for iteration_scheme_501.
* Issue#1084 Updated iteration_scheme_rules_page to match autogenerated doc.
* Adding test for iteration_scheme documentation.
---------
Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
* Issue#1074: procedure_call_003 now includes sequential procedure calls.
* Updating documentation to differentiate between concurrent_procedure_call_statement and procedure_call_statement.
* Issue#1061: Updates for pragma use cases
Pragmas are now treated as comments:
* Pragmas are now a subclass of comments
* Move rules will not move tokens if it crosses a pragma
* Fixing issue with expression classification causing infinite loop.
* 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>
* Issue#924: Adding ability to check for camelCase and PascalCase.
* Updating solution for camelCase and PascalCase.
* Removing unused base rule.
* Adding support for prefixes, suffixes and case exceptions.
* Refactored case_utils.py to reduce number of functions.
* Adding function mapping dictionaries to reduce the number of functions.
* Removing compare function.
* Add linesep configuration option
Platform independent line ends are important to avoid conflicts.
Resolves: #1010
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
* Perform atomic write to files
Do not overwrite file as we may corrupt the file if something fails, instead
write into temporary location and move the result into the final destination.
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
* Synchronize README command-line usage
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
* Support files as positional argument
Tools such as pre-commit and other tools expects the tools to accept the
input files as positional argument and not as options.
Let's support the two variants.
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
* Support shallow git clone without tags
pre-commit uses shallow clone without tags, as this is not used to publish the
artifact, let's assume version '0' in this case.
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
* Add pre-commit hooks support
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
---------
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
* Issue#1033:
* Removing unused classifier.
* Removing rule conditional_selected_signal_assignment_400
* Rule was conflicting with rule selected_assignment_400.
* Fixing issue with selected_assignments being considered an array.
* 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.
* Issue#1006: Corrected code blocks in vim.rst.
* Issue#1006: Moved title to allow it to be found by reference.
* Issue#1006: Removed unused and incorrect link from links.rst.
* Issue#1006: Removed trailing whitespace from structure_optional_rule_group.rst
* Issue#1006: Corrected underline lengths in whitespace_rule_groups.rst
* 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.
* Support file configuration without scanning the file
Currently per file configuration is specified under `file_list`, the
`file_list` has side effect of scanning the file regardless of what files
provided in command-line.
Configuration should be able to specify per file configuration without adding
the file to the scan.
New implementation will look for the file under `file_rules` and merge it to
the existing `file_list` configuration to keep backward compatibility.
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
* Adding tests for the new file_rules configuration option.
* Updating documentation for file_rules
* Removing trailing lines.
* Refactored configure_rules to improve readability.
---------
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
Current implementation searches the file as provided by user or glob, this
name may be platform specific.
New implementation will always use '/' as separator, enabling the same
configuration to be used in any platform.
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
* 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.
* adds basic functionality to send file to stdin
* updates usage docs to reflect stdin and adds new vim editor configs
* Adds better handling with stdin. Safer checks
* removes output over stdout for vhdl file since that's out of scope
* shortens cmd line args line to pass that check on codeclimate
* removes trailing white space
* changes is to == to prevent warning
* updates vim rst to have the null ls config ignore stderr
When editing a file sometimes things can cause VSG to fail and print to
stderr. If this happens, without ignoring stderr it will create an error
message in nvim, which was obnoxious