Commit Graph

757 Commits

Author SHA1 Message Date
Jeremiah Leary 3e3f22d999 Fixing documentaton link. 2024-07-12 03:38:33 -05:00
Jeremiah Leary 631d39c246
Issue#1186: Additional whitespace rules added. (#1192)
* Issue#1186:  Additional whitespace rules added.

* Fixing style issues.
2024-07-12 03:19:06 -05:00
Jeremiah Leary 95fabcf752
Issue#1196: Adding rules to check for subprogram designators. (#1197) 2024-07-12 03:14:37 -05:00
Jeremiah Leary aa7f10bd29
Issue#1171: Adding rule whitespace_100 to enforce single spacing around relational operators. (#1172) 2024-07-09 20:39:45 -05:00
Jeremiah Leary a457814398
Issue#1190: Adding <= and < options to whitespace rules. (#1193)
* Issue#1190:  Adding <= and < options to whitespace rules.

* Fixing issue when <=1 is used and there are no spaces.
2024-07-09 05:31:21 -05:00
Jeremiah Leary f0d3dd7da6
Issue#1182: Adding regex option to prefix and suffix rules. (#1185)
* Issue#1182:  Adding regex option to prefix and suffix rules.

* Fixing style issues.
2024-06-26 21:20:40 -05:00
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
Jeremiah Leary 0389ff93f2
Issue#1178: Adding rule component_022 to add or remove optional component_simple_name. (#1179) 2024-06-14 07:04:07 -05:00
Jeremiah Leary a972c42c4c
Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
Jeremiah Leary 66d47f1040
Issue#1145: Fixing invalid JSON test files and documentation. (#1165) 2024-04-13 06:08:47 -05:00
Jeremiah Leary 043aed9a8d
Issue#1163: Fixing documentation on use clause indenting configuration. (#1164) 2024-04-04 20:16:45 -05:00
Jeremiah Leary a980504671
Issue#1119: Adding documentation for contributers (#1162)
* Issue#1119:  Adding documentation for contributers.

* Adding project board documentation.

* Additional documentation:

  1.  Adding documentation about vsg_parser
  2.  Minor grammer updates

* Adding Theory of operation to documentation.

* Adding Development section.

* Minor updates.

* Updates from pre-commit.

* Fixing link.
2024-04-04 06:52:42 -05:00
Jeremiah Leary 0220e49b96
Issue#1156: Changed prefix/suffix exceptions to allow for regular expressions. (#1159) 2024-04-02 06:47:51 -05:00
Jeremiah Leary dcc09162be
Issue#1146: Fixing invalid escaped characters in documentation and tests. (#1152) 2024-03-28 07:00:59 -05:00
Alon Bar-Lev 161c8950e3 docs: update installation methods
build system was modified to tox, documentation should have been updated.

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-27 20:17:12 -05:00
Jeremiah Leary 799c54b9a8
Issue#1150: Fixing minor documentation issues. (#1151) 2024-03-26 19:46:14 -05:00
Alon Bar-Lev baf22da660 style: apply end-of-file-fixer
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev c22a86025f style: apply black
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev 5b4bae04aa style: apply isort
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev 525c2319cd style: apply tab removal
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev 6aca7f56d5 style: remove trailing spaces
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev d5c1c0f44e style: cleanup executables
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev d1ec866dea style: apply json
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev f9c2653e54 style: apply codespell
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:34 +02:00
Alon Bar-Lev 451af45ded build: PEP 517 build with tox
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:34 +02:00
Alon Bar-Lev 8f9dc637ee tests: move out of vsg
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 18:48:35 +02:00
Alon Bar-Lev b4d5c4e5d6 cleanup: use super() to call parent
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 18:48:35 +02:00
Alon Bar-Lev 599b2443ef docstring: remove unsupported escape sequences
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 18:48:25 +02:00
Alon Bar-Lev fb2ecb5b9f cleanup: dos2unix 2024-03-23 12:11:19 +02:00
Alon Bar-Lev 14feb18176 cleanup: remove unused files
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 12:11:17 +02:00
Jeremiah Leary 6694078942
Issue#1143: Documentation updates (#1144)
* option all-phases to all_phases
  * fixed rev in pre-commit documentation
2024-03-19 06:12:26 -05:00
Jeremiah Leary 1ddfeb2929
Issue#947: Rule generate_015 could produce invalid code. (#955)
* Issue#947:  Rule generate_015 could produce invalid code.

* Updating parameters for rules.

* Adding documentation links.
2024-03-09 18:39:34 -06:00
Matteo Delton 7bffafae0e
Fix typo and quote relativeFile (#1129)
"autodetect" is not accepted, while "autoDetect" is
Without quotes, an error is thrown if relativeFile contains spaces
2024-02-21 06:42:49 -06:00
dependabot[bot] 288a58d95e
Bump readthedocs-sphinx-search from 0.1.1 to 0.3.2 in /docs (#1099)
Bumps [readthedocs-sphinx-search](https://github.com/readthedocs/readthedocs-sphinx-search) from 0.1.1 to 0.3.2.
- [Changelog](https://github.com/readthedocs/readthedocs-sphinx-search/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/readthedocs/readthedocs-sphinx-search/compare/0.1.1...0.3.2)

---
updated-dependencies:
- dependency-name: readthedocs-sphinx-search
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-02-19 07:24:07 -06:00
Jeremiah Leary 3007a13c11
Issue#1096: Changing indentStyle to indent_style and indentSize to indent_size (#1115)
* 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.
2024-02-18 15:17:56 -06:00
JHertz5 4296031761
Issue#1127: Corrected formatting for code block in "Configuring Multiline Indent Rules" page. (#1128) 2024-02-15 21:17:44 -06:00
JHertz5 431cdb92c5
Issue#1117 Modifed initialisation of the `Rule` class's `name` and `identifier` attributes to reduce duplication. (#1118)
* 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>
2024-02-04 15:23:23 -06:00
Jeremiah Leary 308bde1d2c
Issue#880 Adding tokeninzing, tokens and classifying documentation.
* Adding tokeninzing, tokens and classifying documentation.

* Minor grammar updates.

* Fixing build issues.

* Adding clarifying notes about status of documentation.
2024-02-01 20:57:43 -06: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 4ff8b6a0e0
Issue#1107: Adding option to process_028 to allow for alignment of close parenthesis. (#1116) 2024-01-24 06:56:17 -06:00
Jeremiah Leary 1ba9088374
Issue#1081: Adding configuration option for constant_400 (#1094)
* 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.
2024-01-21 13:55:08 -06:00
JHertz5 f03c32e02a
Issue#1112 Corrected list of disabled rules and added unit test to verify list. (#1113)
* 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>
2024-01-21 13:30:18 -06:00
JHertz5 bf66308e32
Issue#1110 Added rules to enforce prefixes and suffixes on generate/loop parameter indentifiers (#1111)
* 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.
2024-01-21 13:02:00 -06:00
JHertz5 17bb03443a
Issue#1106 Corrections to procedure call docs. (#1109) 2024-01-21 12:42:40 -06:00
Jeremiah Leary dd644d442d
Issue#551: Fixing scoping of consistent token case rules. (#1052)
* Issue#551:  Fixing scoping of consistent token case rules.

Issue#755:
Issue#998:
Issue#1023

* Updating additional consistent case rules:

  1)  architecture_600
  2)  entity_600
2024-01-21 12:36:29 -06:00
JHertz5 c409e81998
Issue#1104 Corrected "superceeced" typo. (#1105) 2024-01-20 12:41:23 -06:00
JHertz5 e41bdd8855
Issue#1082: Adding assert rules to match report statement rules functionality. (#1083)
* 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.
2024-01-01 19:07:46 -06:00
JHertz5 7ad47019c3
Issue#1086: Corrected VHDL examples in "Configuring Multiline Indent Rules" (#1087)
* 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.
2024-01-01 18:48:42 -06:00
JHertz5 16298bfe66
Issue#1084: Updated docstring for `iteration_scheme_501`. (#1085)
* 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>
2024-01-01 18:41:42 -06:00
JHertz5 296252942b
Issue#1076: procedure_call_003 modified to accept ignore_single_line option. (#1077) 2024-01-01 15:13:52 -06:00