Commit Graph

771 Commits

Author SHA1 Message Date
JHertz5 97dca812e4 Issue#1251: Updated rule group docs for function_508 and procedure_509. 2024-10-16 21:46:15 +01:00
JHertz5 a559813a85 Issue#1251: Updated docs for function_508 and procedure_509. 2024-10-16 19:39:28 +01:00
JHertz5 cd783d4279 Issue#1251: Updated docstrings and docs for rule groups. 2024-10-15 20:59:41 +01:00
JHertz5 5c2ff12219 Issue#1251: Updated docstrings and docs for rule groups. 2024-10-15 20:02:57 +01:00
JHertz5 de8ab379a1 Issue#1251: Updated docstrings and docs for rules function_507, procedure_508, and procedure_call_502. 2024-10-15 19:50:27 +01:00
Jeremiah Leary db548fdbdb
Issue#1245: Fixing documentation issue around regex. (#1246) 2024-10-14 20:47:44 -05:00
JHertz5 ce86655850
Issue#1236: Rule for case in hexadecimal constants and base specifier (#1237)
* Issue#1236: Updated parser to recognise bit string literals.

* Issue#1236: Added rules bit_string_literal_500 and bit_string_literal_501.

* Issue#1236: Updated bit string literal tokens to combine quote tokens into bit_value string token.

* Issue#1236: Updated case_utils to add exeption for bit string literals.

* Issue#1236: Updated parser to separate bit_string_literal integer token from bit_string_literal base_specifier token.

* Issue#1236: Added test for bit_string_literal classification.

* Issue#1236: Added test for bit_string_literal_500.

* Issue#1236: Added test for bit_string_literal_501.

* Issue#1236: Updated rules and rule tests.

* Issue#1236: Style updates.

* Issue#1236: Updated classification result.

* Issue#1236: Changed bit_string_literal_501 to default to upper case.

* Issue#1236: Updated tests for bit_string_literal_501 default to upper case change.

* Issue#1236: Formatting changes.

* Issue#1236: Updated fixed versions of code examples.

* Issue#1236: Updated fixed versions of code examples.

* Issue#1236: Code refactoring to reduce duplication.

* Issue#1236: Code refactoring to improve names and remove unused code.

* Issue#1236: Formatting changes.

* Issue#1236: Refactored code to reduce congitive complexity.

* Issue#1236: Refactored code to reduce congitive complexity.

* Issue#1236: Added bit string literal rules to top-level rules documentation.

* Issue#1236: Used compiled regular expressions to improve bit_string_literal parsing.

* Issue#1236: Changed regex strings to raw strings to avoid warnings about invalid escape sequences.

* Issue#1236: Removed unused import.
2024-10-07 20:09:53 -05:00
JHertz5 8174cab017
Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
Jeremiah Leary da84a1be1f
Issue#1170: Adding rules to enforce spaces before generic map and port map assignment operators. (#1173)
* Issue#1170:  Adding rules to enforce spaces before generic map and port map assignment operators.

* Adding ability to parse external names.

  1)  Added parsing of external names
  2)  Added external_signal_name rules

* Adding parsing of external names to productions.

* Fixing rule identifiers.

* Adding external_constant_name rules.

* Adding external_variable_name rules.

* Adding classification of indexes of external names.

* Style issue updates and fixing test.
2024-10-02 21:47:19 -05:00
Jeremiah Leary 7c345ebba1
Issue#1207: Fixing default values in multiline indent documentation. (#1208) 2024-09-22 20:46:58 -05:00
JHertz5 2968a5efb9
Issue#1214: Corrected label tag for _configuring-port-map-new-line. (#1215) 2024-09-08 20:06:00 -05:00
JHertz5 7788d41f85
Issue#1216: Added escape characters for "**" in docs. (#1217)
* Issue#1216: Added escape characters for "**" in docs.

* Issue#1216: Updated rule docstring in whitespace_011

* Issue#1216: Correction to whitespace_011 docstring.
2024-09-08 20:01:16 -05:00
JHertz5 c5bf334136
Issue-1225 vsg_rule_doc_gen script does not run. (#1226)
* Issue#1225: Corrected tool name in help message for vsg_rule_doc_gen.

* Issue#1225: Added path argument to vsg_rule_doc_gen.

* Issue#1225: Passed path argument to top-level function in vsg_rule_doc_gen.

* Issue#1225: Updated reserved_rules documentation.

* Issue#1225: Updated ieee_rules documentation.

* Issue#1225: Whitespace changes.

* Issue#1225: Simple test added for the main function in vsg_rule_doc_gen.

* Issue#1225: Whitespace changes to appease black formatter.
2024-09-08 19:51:31 -05:00
JHertz5 49a4924be3
Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
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