Compare commits

..

901 Commits

Author SHA1 Message Date
Dandaedre 4c067fdf9b
Make fork package versions explicit
VSG fork CI VSG tests and package installation checks passed.
MadGobblins/vhdl-style-guide/pipeline/head This commit looks good Details
2026-10-03 22:10:44 +02:00
Dandaedre b7dc18c157
Report parser locations in incomplete diagnostics
VSG fork CI VSG tests and package installation checks passed.
MadGobblins/vhdl-style-guide/pipeline/head This commit looks good Details
2026-10-03 21:16:18 +02:00
Dandaedre 4580a83ea1
Document provenance and make editor streams failure-safe
VSG fork CI VSG tests and package installation checks passed.
MadGobblins/vhdl-style-guide/pipeline/head This commit looks good Details
2026-10-03 15:52:02 +02:00
Dandaedre 99d18a3b96
Restrict fixes by rule identifier and source line 2026-10-03 15:51:35 +02:00
Dandaedre 9e41eecfef
Expose versioned JSON diagnostics for editor clients 2026-10-03 15:51:21 +02:00
Dandaedre 39a399c2c6
Automate fork rebasing, packaging, and publication 2026-10-03 15:51:06 +02:00
Dandaedre 7b9e9128fe
Return fixed editor buffers through standard output 2026-10-03 15:50:46 +02:00
Jukka Hertzog 650058d9f9
Merge pull request #1576 from malsheimer/fix/token_prefix_clear_exception_list
Clear compiled exception list in token_prefix on each analyze
2026-09-06 10:41:23 +01:00
Michael Alsheimer e980d5ec92 fix(token_prefix): clear compiled exception list
generate_regexp_exceptions appends compiled patterns on every
analyze() call. fix() then check_rules() run analyze() twice
on the same instance, so the list grew without being reset.
2026-08-15 19:07:17 +02:00
Jukka Hertzog 4aef763290
Merge pull request #1553 from JHertz5/issue-1548
Issue#1548: Modified relaxedCamelCase to allow consecutive capital letters at the end.
2026-07-24 15:14:23 +01:00
Jukka Hertzog 4d1ba8dd47
Merge pull request #1565 from gaoflow/issue-1564
Issue#1564: Fix block_201 false positive on leading comments when block "is" is omitted
2026-07-03 19:39:32 +01:00
Jukka Hertzog f2bd0a19af
Merge pull request #1563 from lzulberti/fix/allow_comment
Remove self.allow_comment on previous_line base rule
2026-07-03 19:29:27 +01:00
Luca Zulberti 76461a18fd
Remove spurious self.allow_comment from previous_line 2026-06-24 15:06:18 +02:00
Jukka Hertzog 6dd1d02da2
Merge pull request #1550 from SAY-5/fix-issue-1549-deferred-constant-crash
Fix crash in multiline array rules on deferred constants
2026-06-19 08:30:59 +01:00
Vincent Gao 9895b186d2
Issue#1564: Fold regression test into test_rule per review
Address review feedback: rename the input file to follow the descriptive
naming convention (rule_201_test_input.block_without_is.vhd) and move the
test into the existing test_rule class instead of a separate class, checking
both the require_blank_line and no_blank_line style options.
2026-06-16 00:07:59 +02:00
Jukka Hertzog d2476547e6
Merge pull request #1567 from JHertz5/1566-unused-parameter-allow_comments-defined-in-several-rules
Issue#1566: Removed setting of unused parameter from tests.
2026-06-15 21:19:56 +01:00
JHertz5 d80fb9cba6 Issue#1566: Removed setting of unused parameter from tests. 2026-06-15 21:14:32 +01:00
Vincent Gao 526fb1c02f
Issue#1564: Fix block_201 false positive on leading comments when block is omitted
get_indexes_of_tokens_between appended the enumerate loop counter instead
of the start-token index when a start token had no following end token. A
block statement with the optional "is" keyword omitted (and no guard),
in a file containing no other is/guard tokens, therefore made block_201
report a violation against the first token of the file (a leading comment)
and --fix inserted a spurious blank line. Append the actual token index so
the rule is evaluated against the block line. Adds a regression test.
2026-06-15 19:40:34 +02:00
Jukka Hertzog a895557eee
Merge pull request #1560 from JHertz5/issue-1558
Issue#1558: Added rules.rst check to unit tests
2026-05-29 08:11:18 +01:00
Jukka Hertzog 00e59113f7
Merge pull request #1559 from JHertz5/issue-1555
Issue#1555: Added index constraint rules to rules index
2026-05-29 08:10:46 +01:00
JHertz5 c5da187a28 Issue#1558: Formatting. 2026-05-29 00:04:56 +01:00
JHertz5 66fe9beff8 Issue#1558: Added rules.rst verification to unit tests. 2026-05-28 23:59:42 +01:00
JHertz5 766d2769a6 Issue#155: Added index constraint rules to rules index. 2026-05-28 23:38:02 +01:00
Jukka Hertzog 87322afefd
Merge pull request #1554 from JHertz5/issue-1547
Issue#1547: Corrected library_007 to check library clauses for previous libraries
2026-05-28 22:54:32 +01:00
Jukka Hertzog 952374fbcd
Merge pull request #1466 from jeremiah-c-leary/issue-1458
Issue#1458:  Rules port_011 and port_025 were operating on component declarations.
2026-05-23 17:45:49 +01:00
Jukka Hertzog 6704c7ada7
Merge pull request #1505 from JHertz5/issue-1503
Issue#1503: Added new rules for structure and alignment of multiline signal initialisations
2026-05-23 17:38:31 +01:00
JHertz5 d8e5ff06e7 Merge remote-tracking branch 'origin/master' into issue-1503 2026-05-23 17:35:55 +01:00
JHertz5 919571fd7c Issue#1547: Formatting. 2026-05-23 13:59:23 +01:00
JHertz5 b1da5292ff Issue#1547: Updated tests. 2026-05-23 13:54:14 +01:00
JHertz5 df56e50412 Issue#1547: Comment improvements. 2026-05-23 13:49:36 +01:00
JHertz5 d8b8d31429 Issue#1547: Updated get_previous_library to work for library clauses as well as use clauses. 2026-05-23 13:49:26 +01:00
JHertz5 f95e083590 Issue#1547: Corrected get_index_of_line for when there is no previous line. 2026-05-23 13:49:13 +01:00
JHertz5 1cb53b68c4 Issue#1547: Simplified code. 2026-05-23 13:48:27 +01:00
Jukka Hertzog a6a8029be9
Merge pull request #1527 from HuskyNator/patch-1
Typo in example indentation config
2026-05-23 11:42:11 +01:00
Jukka Hertzog 9b4bf6c53b
Merge pull request #1535 from JHertz5/issue-1525
Issue#1525: Corrected block comment config example
2026-05-23 11:40:18 +01:00
JHertz5 55897f59ae Issue#1548: Test update. 2026-05-22 20:25:14 +01:00
JHertz5 0e63ad0b53 Issue#1548: Regex update. 2026-05-22 20:24:59 +01:00
JHertz5 ce1321963e Issue#1548: Updated test cases. 2026-05-22 20:16:20 +01:00
JHertz5 658d769d95 Issue#1548: Updated test_rule_008 to use ranges. 2026-05-22 20:00:39 +01:00
say dc3d81da0e Fix crash in multiline array rules on deferred constants
constant_012 and constant_016 crashed with a TypeError when a
constant declaration spanning multiple lines had no assignment
operator (a deferred constant whose initializer is in the package
body). array_detected_after_assignment_operator now returns False
when the assignment operator token is absent.

Fixes #1549
2026-05-12 11:45:11 -07:00
Jukka Hertzog 26055b82cb
Merge pull request #1546 from JHertz5/issue-1544
Issue#1544: Changed `comment_012` to only match whole words.
2026-04-30 01:09:35 +01:00
JHertz5 e12f19776f Issue#1544: Corrected the regex. 2026-04-18 18:10:29 +01:00
JHertz5 62b1c8866b Issue#1544: Updated comment_012 to only match whole words. 2026-04-18 17:49:18 +01:00
Jukka Hertzog ced3e55be4
Merge pull request #1542 from CJ0Hn/issue-1541
Issue#1541: Corrected the examples and default value errors in the documentation.
2026-02-05 20:51:22 +00:00
ChenJunHeng 69a37ddad8 Issue#1541: Corrected the examples and default value errors in the documentation. 2026-02-04 20:29:42 +08:00
Jukka Hertzog 2fd4c598ad
Merge pull request #1540 from JHertz5/issue-1539
Issue#1539: "carraige" typo correction.
2026-01-13 22:50:32 +00:00
JHertz5 c8be0e59d3 Issue#1539: "carraige" typo correction. 2026-01-13 22:46:44 +00:00
Jukka Hertzog 0f7cacce29
Merge pull request #1532 from JHertz5/issue-1531
Issue#1531: Improved parser to handle both qualified expressions and parenthesis character literals
2026-01-13 01:37:20 +00:00
JHertz5 0e98e93e21 Merge remote-tracking branch 'origin/master' into issue-1531 2026-01-13 01:28:06 +00:00
Jukka Hertzog 2e2f14fe68
Merge pull request #1538 from JHertz5/issue-1537
Issue#1537: Performance improvements
2026-01-01 21:15:15 +00:00
JHertz5 4c31f919e8 Issue#1537: Comment removal. 2026-01-01 20:56:16 +00:00
JHertz5 24e7ac4a77 Issue#1537: Corrected bugs. 2026-01-01 20:53:00 +00:00
JHertz5 0a703814d9 Issue#1537: Replaced combine_three_character_symbols and combine_two_character_symbols with symbol prefix tree check. 2026-01-01 17:26:08 +00:00
JHertz5 4019c18370 Issue#1537: Minor performance improvement in does_token_type_exist_in_list_of_tokens. 2026-01-01 16:47:47 +00:00
JHertz5 f6384a6975 Issue#1537: Corrected condition that had been accidentally inverted in does_token_type_exist_in_list_of_tokens 2026-01-01 16:42:54 +00:00
JHertz5 5d8ddb2763 Issue#1537: Slight speed optimisations in combine_characters_into_words. 2026-01-01 15:30:11 +00:00
JHertz5 8e69d9b7e8 Issue#1537: Replaced conditions with direct returns in several places. 2026-01-01 15:19:46 +00:00
JHertz5 9fec7fb0ec Issue#1537: Cached parser.item for the whole of utils. Replaced conditions with direct returns in several places. 2026-01-01 14:54:12 +00:00
JHertz5 885cc99b0a Issue#1537: Optimised convert_token_list_to_string. 2026-01-01 14:27:02 +00:00
JHertz5 3c2f1f497f Issue#1537: Simplified set declarations. 2026-01-01 14:01:46 +00:00
JHertz5 f53e76177f Issue#1537: Speed-optimized functions that do a boolean check to return the boolean directly instead of checking a condition and then checking a boolean literal value. 2026-01-01 13:57:51 +00:00
JHertz5 ba3c1cada8 Issue#1537: Changed lists to sets for faster lookup. 2026-01-01 13:53:32 +00:00
JHertz5 6c07b90ecc Issue#1537: Replaced double rstrip call with single rstrip call. 2026-01-01 13:29:51 +00:00
JHertz5 8b10cc622c Issue#1537: Replaced inefficient function "convert_string_to_chars" with simpler and faster code. 2026-01-01 13:28:57 +00:00
JHertz5 5a94cf3a5c Issue#1537: Removed inline comments. 2026-01-01 12:49:25 +00:00
JHertz5 df3b61b61d Issue#1537: Optimized find_next_token for speed. 2026-01-01 11:43:53 +00:00
JHertz5 7f5aaf886c Issue#1537: Modified get_token_indexes_between_indexes to use binary search instead of linear search. 2025-12-31 17:20:58 +00:00
JHertz5 2789048cc4 Issue#1537: Modified extract_closest_pair to use binary search instead of linear search. 2025-12-31 17:14:28 +00:00
JHertz5 d9b61c97c3 Issue#1537: Performance improvement in rule_list. 2025-12-31 15:38:38 +00:00
JHertz5 873bb37a9b Issue#1537: Performance improvement in vhdlFile._processFile() 2025-12-31 15:11:13 +00:00
JHertz5 355bc24f5c Issue#1525: Removed extra lines from config example. 2025-12-30 21:06:55 +00:00
JHertz5 47b8c62aee Issue#1525: Corrected documentation example. 2025-12-30 21:04:57 +00:00
JHertz5 7ba1ffaeac Merge remote-tracking branch 'origin/master' into issue-1531 2025-12-30 20:47:34 +00:00
Jukka Hertzog 24bcf8ac36
Merge pull request #1534 from JHertz5/issue-1533
Issue#1533: Corrected token pairs for `variable_403`
2025-12-30 20:44:51 +00:00
Jukka Hertzog fe33a92014 Issue#1531: Formatting 2025-12-30 20:42:38 +00:00
Jukka Hertzog 3e259fe369 Issue#1531 Updated token parsing to handle qualified expressions properly.
Refactor token filtering logic to handle sequential character literals more effectively and remove unused function.
2025-12-30 20:41:41 +00:00
JHertz5 0f075470a9 Issue#1533: Updated tests for variable_403 to protect against failure case. 2025-12-30 20:39:42 +00:00
JHertz5 b89739930f Issue#1533: Corrected token pairs for variable_403. 2025-12-30 20:39:42 +00:00
Jukka Hertzog 2c74747343
Issue#1531: Add tests for character literals in token creation 2025-12-23 17:16:41 +00:00
Jeremiah Leary 9a2414e4bd Updating README. 2025-11-09 21:04:45 -06:00
HuskyNator 39388ffd70
Typo in example indentation config
Remove typo from example config
2025-11-04 02:40:45 +01:00
Jukka Hertzog 13a797b648
Merge pull request #1524 from JHertz5/issue-1523
Issue#1523: Corrected documentation link.
2025-10-13 14:12:23 +01:00
JHertz5 5218ff9a35 Issue#1523: Corrected documentation link. 2025-10-12 11:43:01 +01:00
Jukka Hertzog 52ad5c735b
Merge branch 'master' into issue-1503 2025-09-14 17:54:41 +01:00
Jukka Hertzog b940b390bf
Merge pull request #1519 from JHertz5/issue-1518
Issue#1518: Remove commented-out code
2025-09-14 17:52:57 +01:00
Jukka Hertzog d9d74f90c1
Merge pull request #1517 from JHertz5/issue-1510
Issue#1510: New rules for multiline variable initialisations.
2025-09-14 17:52:32 +01:00
JHertz5 221c7095b0 Issue#1518: Removed commented-out code. 2025-09-14 17:49:58 +01:00
JHertz5 a3c97a8c80 Issue#1510: Removed commented-out code. 2025-09-14 17:47:37 +01:00
JHertz5 1256425cab Issue#1510: Corrections. 2025-09-14 17:41:22 +01:00
JHertz5 5ba7d3a631 Issue#1510: Added docs for new rules to handle multiline variable initialisations. 2025-09-14 17:37:50 +01:00
JHertz5 67e1fdb938 Issue#1510: Formatting. 2025-09-14 17:36:55 +01:00
JHertz5 380226beb1 Issue#1510: Added tests for new rules to handle multiline variable initialisations. 2025-09-14 17:33:45 +01:00
JHertz5 7610bfa8af Issue#1510: Added new rules to handle multiline variable initialisations. 2025-09-14 17:06:30 +01:00
JHertz5 d635a87ff9 Issue#1503: Removed unnecessary changes. 2025-09-14 17:02:34 +01:00
JHertz5 c15e4ff3f8 Issue#1510: Modified variable_400 to skip arrays. 2025-09-14 17:00:20 +01:00
Jukka Hertzog b4861c54e9
Merge pull request #1516 from JHertz5/issue-1512
Issue#1512: Added rule to align assignment operators in variable declaration arrays
2025-09-14 16:58:48 +01:00
JHertz5 b748bf46b8 Issue#1512: Corrected documentation mistake. 2025-09-14 16:53:06 +01:00
JHertz5 c2fa867657 Issue#1512: Added docs for new rule to enforce alignment of assignment operators within variable declarations. 2025-09-14 16:49:30 +01:00
JHertz5 c761b127b0 Issue#1512: Added tests for new rule to enforce alignment of assignment operators within variable declarations. 2025-09-14 16:48:15 +01:00
JHertz5 330cc57b69 Issue#1512: Corrected rule number. 2025-09-14 16:20:28 +01:00
JHertz5 c283820389 Issue#1512: Added new rule to enforce alignment of assignment operators within variable declarations. 2025-09-14 16:09:26 +01:00
Jukka Hertzog 938d464a8a
Merge pull request #1515 from JHertz5/issue-1514
Issue#1514: Corrected minor documentation mistakes for constant_001 and constant_007.
2025-09-14 15:47:53 +01:00
Jukka Hertzog 29e3b3dbce
Merge pull request #1513 from JHertz5/issue-1511
Issue#1511: Added new rule for variable declaration asssignment operator position
2025-09-14 15:45:27 +01:00
JHertz5 824529c5bb Issue#1514: Corrected minor documentation mistakes for constant_001 and constant_007. 2025-09-14 15:42:21 +01:00
JHertz5 031bf74b88 Issue#1511: Added missing semicolon. 2025-09-14 15:37:01 +01:00
JHertz5 620a669c3a Issue#1511: Corrected missing semicolon in docs. 2025-09-14 15:35:39 +01:00
JHertz5 cc92d1c4a5 Issue#1511: Added docs for new rule to enforce position of assignment operator in variable declarations. 2025-09-14 15:34:01 +01:00
JHertz5 ce4e5c6a3c Issue#1511: Added tests for new rule to enforce position of assignment operator in variable declarations. 2025-09-14 15:33:04 +01:00
JHertz5 f23cd2ac21 Issue#1511: Added new rule to enforce position of assignment operator in variable declarations. 2025-09-14 15:30:21 +01:00
JHertz5 6b60143601 Issue#1503: Doc typo corrections. 2025-09-14 15:25:07 +01:00
JHertz5 ef7b4b421f Issue#1503: Correction to signal_400. 2025-09-14 11:52:33 +01:00
JHertz5 9f25f8f573 Issue#1503: Removed unnecessary changes to signal_400. 2025-09-14 11:49:36 +01:00
JHertz5 b7fc82c990 Issue#1503: Formatting. 2025-09-14 11:47:50 +01:00
JHertz5 2a5f39c6c7 Issue#1503: Updated docs for signal_402 and signal_403. 2025-09-14 11:44:04 +01:00
JHertz5 0e00cb320d Issue#1503: Added tests for signal_403. 2025-09-14 11:40:31 +01:00
JHertz5 b6bcd8cea3 Issue#1503: Added tests for signal_402. 2025-09-14 11:33:39 +01:00
JHertz5 69fcaa886e Issue#1503: Tidying in signal_402 and signal_403. 2025-09-14 11:22:44 +01:00
JHertz5 4234d92254 Issue#1503: Updated tests for signal_400. 2025-09-14 11:15:39 +01:00
JHertz5 f334bbfe19 Issue#1503: Realised that I can use the skip arrays setting of multiline_alignment_between_tokens in signal_400! Greatly simplified my solution. 2025-09-14 11:15:15 +01:00
JHertz5 0a5e452110 Issue#1503: Tidied signal_400. 2025-09-14 10:55:32 +01:00
JHertz5 b982da5fb4 Merge remote-tracking branch 'origin/master' into issue-1503 2025-09-14 08:13:45 +01:00
Jukka Hertzog a26f66b1c6
Merge pull request #1495 from JHertz5/issue-1492
Issue#1492: New rules to handle whitespace in array definitions
2025-09-12 09:21:34 +01:00
Jukka Hertzog cb4eb92ff3
Merge pull request #1507 from JHertz5/issue-1391
Issue#1391: Added blank line rules for case generates
2025-09-11 23:48:51 +01:00
JHertz5 dabc7b2739 Merge remote-tracking branch 'origin/master' into issue-1492 2025-09-11 23:41:04 +01:00
Jukka Hertzog a0b8ac4da3
Merge pull request #1499 from JHertz5/issue-1488
Issue#1488: New rule to handle whitespace before array constraints and index constraints
2025-09-11 23:40:06 +01:00
JHertz5 04cf277b54 Issue#1492: Removed constrained_array_definition_100, shuffled other rules names down. 2025-09-11 23:39:42 +01:00
JHertz5 84fa22954f Merge remote-tracking branch 'origin/master' into issue-1492 2025-09-11 23:35:53 +01:00
JHertz5 4dfbf9aa6b Merge remote-tracking branch 'origin/master' into issue-1488 2025-09-11 23:34:17 +01:00
JHertz5 718e2e187b Merge remote-tracking branch 'origin/master' into issue-1488 2025-09-11 23:32:59 +01:00
Jukka Hertzog f62164286a
Merge pull request #1498 from JHertz5/issue-1489
Issue#1489: Update `whitespace_005` to make ignoring of whitespace before numbers optional
2025-09-11 22:50:49 +01:00
Jukka Hertzog 955408c5ca
Merge pull request #1494 from JHertz5/issue-1491
Issue#1491: New rules to handle whitespace around range keywords
2025-09-11 22:49:11 +01:00
Jukka Hertzog 2291adb404
Merge pull request #1493 from JHertz5/issue-1490
Issue#1490: Added whitespace rules for direction keywords
2025-09-11 22:48:03 +01:00
JHertz5 00f99e5b99 Issue#1503: Formatting of signal_400. 2025-09-11 21:34:52 +01:00
JHertz5 a442ebeccd Issue#1503: Modified signal_400 to avoid overlapping with signal_402. 2025-09-11 21:33:14 +01:00
Jukka Hertzog 3cc968d6af
Issue#1500: Modified test class names to remove duplication. (#1501) 2025-09-07 16:17:14 -05:00
Jukka Hertzog 8adacd4875
Issue#1496: Corrected documentation typo. (#1497)
* Issue#1496 - Corrected documentation typo.

* Issue#1496: Added full stop to comment.
2025-09-04 21:40:42 -05:00
Jukka Hertzog 090d88acb6
Issue#1485: Modified variable_assignment_004 to no longer affect conditional variable assignments. (#1486) 2025-09-04 06:47:08 -05:00
Jukka Hertzog 313d9c7bcb
Issue#1397: Added whitespace rules for file declarations (#1484)
* Issue#1397: Added rule file_101.

* Issue#1397: Added tests for rule file_101.

* Issue#1397: Added docs for rule file_101.

* Issue#1397: Added whitespace rules for file_open_information.

* Issue#1397: Added tests for whitespace rules for file_open_information.

* Issue#1397: Added docs for whitespace rules for file_open_information.

* Issue#1397: Updated test class names.
2025-09-04 06:40:06 -05:00
Jukka Hertzog d87a3b1ed9
Issue#1504: Added rules to restrict library and package names. (#1506)
* Issue#1479: Modified architecture_025 to accept regular expressions as names.

* Issue#1479: Corrected error by resetting regexp names.

* Issue#1479: Modified test for architecture_025 to test regular expressions as names.

* Issue#1479: Modified docs for architecture_025.

* Issue#1479: Formatting.

* Issue#1479: Code improvement.

* Issue#1504: Added does_token_value_match_none_of class.

* Issue#1504: Added rules to restrict library and package names.

* Issue#1504: Added tests for rules to restrict library and package names.

* Issue#1504: Added docs for rules to restrict library and package names.

* Adding documentation for rule configuration.

* Issue#1504: Updated use_clause_001 to be disabled by default to match documentation.

* Issue#1504: Updated docs for use_clause_001 to be disabled by default to match documentation.

* Issue#1504: Updated docs for new rule type documentation.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2025-09-04 06:32:41 -05:00
JHertz5 1912c2029d Issue#1503: Added new rules for array alignment within signal initialisations. 2025-09-04 08:03:30 +01:00
Lincoln Lorenz 2a265d6c1f
Issue 1475: Add support for VHDL 2019 views (#1477)
* Add alias example of a view's 'converse

* Add 2019 views

Resolves #1475

* Applied review suggestions
2025-09-03 21:36:40 -05:00
JHertz5 911d45f44d Issue#1503: Added docs for rule to check that signal assignment operator is not a different line than preceding tokens. 2025-09-03 19:40:32 +01:00
JHertz5 883b31ea91 Issue#1503: Added tests for rule to check that signal assignment operator is not a different line than preceding tokens. 2025-09-03 19:35:21 +01:00
JHertz5 54c3c7ab85 Issue#1503: Added rule to check that signal assignment operator is not a different line than preceding tokens. 2025-09-03 19:33:17 +01:00
Jukka Hertzog cb3c3f3e27
Issue#1488: Docs updated to remove deprecated rule. 2025-09-03 17:25:36 +01:00
Jukka Hertzog 3f63fbb6ad
Issue#1488: Reverted unintended change. 2025-09-03 17:23:20 +01:00
Jukka Hertzog d098bbf69c
Issue#1488: Docs updated. 2025-09-03 17:19:02 +01:00
Jukka Hertzog f93a46d4fd
Issue#1488: Updated rule_list test output. 2025-09-03 17:18:03 +01:00
Jukka Hertzog 9e7ced14f2
Issue#1488: Deleted unused test file. 2025-09-03 17:17:07 +01:00
Jukka Hertzog cf1f9f2908
Issue#1488: Deleted unused test file. 2025-09-03 17:16:57 +01:00
Jukka Hertzog 9bff28afdc
Issue#1488: Update test. 2025-09-03 17:16:29 +01:00
Jukka Hertzog b14326740d
Issue#1488: Deprecated whitespace_008. 2025-09-03 17:14:30 +01:00
Jukka Hertzog 3d199b19f9
Merge branch 'jeremiah-c-leary:master' into issue-1488 2025-09-03 17:13:15 +01:00
Jukka Hertzog 207af67aa7
Issue#1479: Modified `architecture_025` to accept regular expressions as names (#1487)
* Issue#1479: Modified architecture_025 to accept regular expressions as names.

* Issue#1479: Corrected error by resetting regexp names.

* Issue#1479: Modified test for architecture_025 to test regular expressions as names.

* Issue#1479: Modified docs for architecture_025.

* Issue#1479: Formatting.

* Issue#1479: Code improvement.

* Issue#1479: Formatting.
2025-09-03 07:19:16 -05:00
Lincoln Lorenz a8e061a92f
Issue 1474: Add 2019 standard and its reserved keywords (#1476)
* Add 2019 standard and its reserved keywords

Resolves #1474

* Update vsg/rules/reserved/rule_001.py

Fixed spelling.

Co-authored-by: Jukka Hertzog <jukka.hertzog@live.co.uk>

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
Co-authored-by: Jukka Hertzog <jukka.hertzog@live.co.uk>
2025-09-02 21:25:48 -05:00
Benjamin Thiemann 068f9102ef
Issue#1451: Fixed array detection and parenthesis handling in multiline_alignment_between_tokens (#1468)
* Issue#1451: Fixed array detection in multiline_alignment_between_tokens

* Move function toi_is_array from multiline_simple_structure to the 
  utils module and use this function in 
  multiline_alignment_between_tokens, because it correctly classifies
  parenthesis of aggregates. The previous function there falsely 
  triggered array detection on parenthesis around logical operators.

* Rename "check_for_array" to "skip_array", because that is what the 
  variable is used to do.

* Extend tests for concurrent_003 with logical expressions that start 
  with a parenthesis.

* Issue#1451: Fixed parenthesis handling in multiline_alignment_between_tokens

Do not add parenthesis pairs to the list of occurring parenthesis if
they are on the same line.
2025-09-02 21:18:33 -05:00
JHertz5 1769e08256 Issue#1391: Code example updated. 2025-09-01 21:16:37 +01:00
JHertz5 6142e0ffd7 Issue#1391: Added docs for blank line rules for case generates. 2025-09-01 21:11:59 +01:00
JHertz5 3b6612a0da Issue#1391: Added tests for blank line rules for case generates. 2025-09-01 21:06:48 +01:00
JHertz5 a00e62db5f Issue#1391: Added blank line rules for case generates. 2025-09-01 21:06:39 +01:00
Jeremiah Leary a73054725f Fixing test failure on documentation. 2025-09-01 12:56:40 -05:00
Rui Chen 5fa097a564
fix SyntaxWarning for py3.13 compatibility (#1441)
Signed-off-by: Rui Chen <rui@chenrui.dev>
2025-09-01 10:01:30 -05:00
Jeremiah Leary 043ee7a0f9
Issue#1413: Fixing incorrect reference to rule in documentation. (#1414) 2025-09-01 09:51:24 -05:00
JHertz5 259dcb4d9f Issue#1503: Added docs for new rule. 2025-08-28 21:23:26 +01:00
JHertz5 3076bf8efd Issue#1503: Added tests for new rule. 2025-08-28 21:21:25 +01:00
JHertz5 4015087748 Issue#1503: Added new rule for alignment of assignment operators in a signal declaration default value. 2025-08-28 21:16:47 +01:00
JHertz5 84033315bc Issue#1490: Updated test class names. 2025-08-25 08:15:14 +01:00
JHertz5 533c5658ed Issue#1491: Updated test class names. 2025-08-25 08:14:44 +01:00
JHertz5 df74d35558 Issue#1492: Updated test class names. 2025-08-25 08:14:06 +01:00
JHertz5 fe7987e093 Issue#1488: Test update. 2025-08-25 08:01:01 +01:00
JHertz5 09a9be953f Issue#1488: Updated example tests. 2025-08-25 08:00:41 +01:00
JHertz5 d0ec87909e Issue#1488: Doc corrections. 2025-08-24 22:44:10 +01:00
JHertz5 eea06c9dee Issue#1488: Test corrections. 2025-08-24 22:42:41 +01:00
JHertz5 4762013289 Issue#1488: Added docs for new rules. 2025-08-24 22:41:50 +01:00
JHertz5 989c4b9a7f Issue#1488: Added tests for new rules. 2025-08-24 22:33:26 +01:00
JHertz5 1e0a3b30eb Issue#1488: Added new rules to handle whitespace before opening parentheses of index/array constraints.. 2025-08-24 22:22:51 +01:00
JHertz5 72d0391b29 Issue#1489: Minor code simplification. 2025-08-24 22:04:21 +01:00
JHertz5 d75437c771 Issue#1489: Updated tests to check new behaviour. 2025-08-24 22:02:33 +01:00
JHertz5 d48d2cb03a Issue#1489: Updated docs to reflect change. 2025-08-24 21:53:23 +01:00
JHertz5 d996b7d227 Issue#1489: Updated whitespace_005 to make ignoring of whitespace before numbers optional. 2025-08-24 21:50:06 +01:00
JHertz5 82d18f907b Updated classification test. 2025-08-24 21:34:13 +01:00
JHertz5 cda8132232 #1491: Updated tests. 2025-08-24 21:30:37 +01:00
JHertz5 5d03cc8b37 #1491: Updated parsing to avoid misidentifying range attributes as range keywords. 2025-08-24 21:30:25 +01:00
JHertz5 81de9b06b0 #1492: Updated code example tests. 2025-08-24 21:15:39 +01:00
JHertz5 a6c264075d #1492: Whitespace corrections. 2025-08-24 19:47:18 +01:00
JHertz5 ee67ef0a73 #1492: Added tests for whitespace rules for constrained and unconstrained array definitions. 2025-08-24 19:44:44 +01:00
JHertz5 2b5670a62b #1492: Added tests for whitespace rules for constrained and unconstrained array definitions. 2025-08-24 19:35:10 +01:00
JHertz5 5a6c3e45ec #1492: Added whitespace rules for constrained and unconstrained array definitions. 2025-08-24 19:22:59 +01:00
JHertz5 070699cea8 #1491: Docs correction. 2025-08-24 19:06:12 +01:00
JHertz5 d70b72c4b8 #1491: Added docs for new rules. 2025-08-24 19:02:06 +01:00
JHertz5 e866be03e8 #1491: Added tests for new rules. 2025-08-24 18:58:34 +01:00
JHertz5 fceac27841 #1491: Added parsing of range keywords within discrete ranges. 2025-08-24 18:12:56 +01:00
JHertz5 ecd955d686 #1491: Added range_constraint rules 100 and 100. 2025-08-23 12:04:34 +01:00
JHertz5 040405f3ad #1491: Added index_subtype_definition rules 100 and 100. 2025-08-23 12:04:14 +01:00
JHertz5 e22edf0d71 Issue#1490: Added docs for whitespace rules 102 and 103. 2025-08-23 11:50:41 +01:00
JHertz5 84f62f3b6e Issue#1490: Added tests for whitespace rules 102 and 103. 2025-08-23 11:31:41 +01:00
JHertz5 4b56079fd8 Issue#1490: Added whitespace rules 102 and 103. 2025-08-23 11:17:31 +01:00
JFMarten 7a7ad605b4
issue-1469: warning for no matches of file_rules (#1470)
Co-authored-by: Jakob Marten <github@jfmarten.de>
2025-07-19 14:25:39 -05:00
Lincoln Lorenz c786afbd67
Issue#1471: UTF-8 check should handle output differences from command (#1472)
* Issue#1471: UTF-8 check should handle output differences from  command

* Use native encoding checks to validate fix preserves file encodings

* Mocking stdout to keep stdout from displaying during tests.

* Fixing style issues.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2025-07-19 14:09:53 -05:00
Benjamin Thiemann 587052b276
Fix file_rules globbing (#1453)
* Issue#1446: Fixed comment indentation at end of scope

* config: Refactored glob_filenames

* config: Fixed error message construction in validate_file_exists

* config: Fixed process_file_list_key to use key parameter

* Issue#1425: Fixed missing globbing of "file_rules"

* Adding tests.

* Revert "Issue#1446: Fixed comment indentation at end of scope"

This reverts commit 7106e12fd05049924ea89447922b00de0c83c7fc.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2025-07-13 14:25:44 -05:00
Jukka Hertzog e02087dc8f
Issue#1250: Corrected alignment of multiline variable and signal declarations for align_left = no (#1345)
* Issue#1250: Corrections to multiline_alignment for method _analyze_align_left_no_align_paren_yes.

* Issue#1250: Updated tests after corrections to multiline_alignment for method _analyze_align_left_no_align_paren_yes.

* Issue#1250: Updates after merge of issue-1290.

* Issue#1250: Updated "align_left no, align_paren no" alignment as well.

* Issue#1250: Updated tests for signal_400.

* Issue#1250: Updated tests for variable_400.

* Issue#1250: Formatting.
2025-07-11 06:23:26 -05:00
Jeremiah Leary 54fb8761bb Issue#1458: Rules port_011 and port_025 were operating on component declarations. 2025-07-10 22:04:22 -05:00
Jeremiah Leary 285768d3eb
Fixing warnings during doc generation. (#1465)
* Fixing warnings during doc generation.

* Fixing style issues.
2025-07-10 21:49:37 -05:00
Benjamin Thiemann bd8541b702
Fix missing carriage return handling for rules moving token to previous line (#1455) 2025-07-10 14:00:56 -05:00
Jeremiah Leary a595084ffa
Issue#1403: VSG crashes in constaint due to not checking for "is" or ">>". (#1405) 2025-07-10 07:47:38 -05:00
malsheimer 4cb3be55f5
add new rule_015 for variables (#1440)
This rule checks for multiple (shared) variable names defined in a single (shared) variable declaration.
By default, this rule will only flag more than two (shared) variable declarations.
2025-07-10 07:07:58 -05:00
malsheimer 6a68806d9e
Add new rule variable_500 to check case of keyword "shared" (#1464) 2025-07-08 19:43:04 -05:00
Jukka Hertzog c3b9b537a9
Issue#1459: Added architecture specification enforcement for entity instantiations (#1460)
* Issue#1459: Added rule instantiation_036.

* Issue#1459: Added tests for rule instantiation_036.

* Issue#1459: Added docs for rule instantiation_036.

* Issue#1459: Test change to trigger CI run.

* Revert "Issue#1459: Test change to trigger CI run."

This reverts commit d983807ceadb9c6b942ea60f327dce28fc96b485.

* Issue#1459: Changed default behaviour to "add".
2025-07-06 16:44:10 -05:00
Benjamin Thiemann 78cd5ec485
Fix comment indentation at end of scope (#1452)
* Issue#1446: Fixed comment indentation at end of scope

* Refactored implementation:

  1)  Removed pragma updates
  2)  Added options to configure
      a)  Declarative part can be configured independent of statement part
  3)  Added documentation
  4)  Updated tests for all combinations of configurations

* Fixing configuration merge of indent options.

* Minor updates to error reporting.

* Updating failing tests.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2025-07-06 15:12:10 -05:00
Jeremiah Leary a6e745c809
Issue#1442: Ensuring ISO-8859 encoded files are written as ISO-8859 encoded files (#1463)
* Issue#1442:  Ensuring ISO-8859 encoded files are written as ISO-8859 encoded files.

* Attempting to get builds to pass.

* Attempting to update build tool versions.

* Updating license to current standard.

* Disabling manifest to debug github action errors.

* Switching out pytest for unittest

* Adding __init__.py file so file_encodings test runs

* Attempting to skip failing tests.

* Attempting to skip tests during GITHub actions.

* Adding debug prints.

* Printing out environment variables to help with debug.

* Using HOME environment variable to test for GITHUB.

* Removing debug print statements.

* Enabling pytest.

* Replacing pytest with unittest.

Pytest is failing on some plugin and I do not know how to fix it.
2025-07-04 14:10:49 -05:00
Jeremiah Leary 4c0120a5a4
Issue#1415: Fixing classification of + and - when used with predefined attributes. (#1417) 2025-06-29 11:59:49 -05:00
Jeremiah Leary 78b7cf3bb6
Issue#1433: Fixed mis-classification of signs. (#1434) 2025-04-06 16:52:26 -05:00
Pelle Eikeberg aecb5f63b9
Issue#1427: added 'r' to string to allow to invalid escape char 2025-03-25 07:10:36 -05:00
Jeremiah Leary bf5057891c
Issue#1420: Delimited comment tokens were not classified correctly. (#1422) 2025-03-18 19:33:09 -05:00
Jeremiah Leary 3d58538005
Issue#1411: Adding parsing for PSL. (#1412)
* Issue#1411:  Adding parsing for PSL.

* Fixing cover_assertion classification.
2025-03-12 07:22:48 -05:00
Jeremiah Leary c5184bf694
Issue#1409: Fixing crash with rules architecture_600 and architecture_601. (#1410) 2025-03-09 10:33:10 -05:00
Jeremiah Leary 399ef06989
Issue#1407: Timestamp preserved for unmodified files. (#1408)
* Issue#1407:  Timestamp preserved for unmodified files.

* Removing debug print statement.
2025-03-08 07:58:30 -06:00
Jeremiah Leary 54405d9e8e
Issue 1402 (#1406)
* Issue#1402: Adding rule interface_incomplete_type_declaration_500

* Adding rule interface_incomplete_type_declaration_501.

* Adding rule interface_incomplete_type_declaration_600.

* Adding rule interface_incomplete_type_declaration_601.

* Fixing style issues.
2025-03-06 06:02:15 -06:00
Jeremiah Leary d6422f774d
Issue#1358: Adding user_error_message option. (#1387) 2025-03-02 12:14:53 -06:00
Jukka Hertzog cc678cb21f
Issue#1383: Added case rules for file declarations (#1396)
* Issue#1383: Added case rules for file declarations.

* Issue#1383: Added tests for case rules for file declarations.

* Issue#1383: Added documentation for case rules for file declarations.

* Issue#1383: Added case rules for file type declarations.

* Issue#1383: Added tests for case rules for file type declarations.

* Issue#1383: Added documentation for case rules for file type declarations.

* Issue#1383: Corrected "file type declaration" to "file type definition".
2025-01-19 17:18:53 -06:00
Jukka Hertzog 12473270ea
Issue#1389: Whitespace rules for case-generate statements (#1390)
* Issue#1389: Expanded on case rules to check that they don't affect case-generates.

* Issue#1389: Added new case generate rules.

* Issue#1389: Added tests for new case generate rules.

* Issue#1389: Added documentation for new case generate rules.

* Issue#1389: Corrected test file reference.

* Issue#1389: Corrected code snippet.

* Issue#1389: Corrected code snippet.

* Issue#1389: Connected code snippets

* Issue#1389: Corrected code snippet.

* Issue#1389: Corrected code snippet

* Issue#1389: Updated rules to use simpler base rules where possible.

* Issue#1389: Updated rules to use simpler base rules where possible.

* Issue#1389: Corrected mistake in case_004.
2025-01-19 16:45:26 -06:00
Jukka Hertzog 009cb1b0e0
Issue#1394: Removed unreachable return statement (#1395) 2025-01-19 16:41:04 -06:00
Jeremiah Leary 8e16b801d6 Adding python 3.13 to github build action. 2025-01-18 07:59:58 -06:00
Jukka Hertzog 286d592642
Issue#1392: Minor formatting fix in `case_300` documentation. (#1393)
* Issue#1392: Updated docstring for case_300

* Issue#1392: Updated docs for case_300
2025-01-18 06:53:37 -06:00
Jeremiah Leary 431504ecbc Fixing style issues. 2025-01-13 21:38:34 -06:00
Brandon Maier 4b43d5744a
Fix for pytest on Windows (#1338)
* tests: support admin check on Windows

The tests fail on Windows with the following

> ___________ ERROR collecting tests/source_file/test_source_file.py ____________
> tests\source_file\test_source_file.py:24: in <module>
>     class testOSError(unittest.TestCase):
> tests\source_file\test_source_file.py:39: in testOSError
>     @unittest.skipIf("SUDO_UID" in os.environ.keys() or os.geteuid() == 0, "We are root. Root always has permissions so test will fail.")
> E   AttributeError: module 'os' has no attribute 'geteuid'

Catch the AttributeError and attempt to check for admin when on Windows

Signed-off-by: Brandon Maier <brandon.maier@gmail.com>

* tests: support running 'vsg' binary on Windows

A large number of tests fail on Windows with the following error

> ________ test_severity_using_main.test_architecture_with_configuration ________
> [gw0] win32 -- Python 3.8.20 %PREFIX%\python.exe
>
> self = <tests.severity.test_main.test_severity_using_main testMethod=test_architecture_with_configuration>
>
>     def test_architecture_with_configuration(self):
>         try:
> >           subprocess.check_output(["bin/vsg", "-f", self._sArchitectureFileName, "-c", sConfigFile])
>
> tests\severity\test_main.py:86:
> _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
> ..\_test_env\lib\subprocess.py:415: in check_output
>     return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
> ..\_test_env\lib\subprocess.py:493: in run
>     with Popen(*popenargs, **kwargs) as process:
> ..\_test_env\lib\subprocess.py:858: in __init__
>     self._execute_child(args, executable, preexec_fn, close_fds,
...
> E FileNotFoundError: [WinError 2] The system cannot find the file specified
> ..\_test_env\lib\subprocess.py:1327: FileNotFoundError

Tests that call "bin/vsg" are relying on the Unix shebang (e.g.
"#!/usr/bin/python") to launch `vsg` using the Python interpreter, But
this is not supported on Windows. Instead launch `vsg` with Python
directly.

Signed-off-by: Brandon Maier <brandon.maier@gmail.com>

* tests: normalize line endings for Windows tests

Many of the tests that compare `vsg` stdout fail with a warning as
follows.

> First differing element 0:
> 'ERRO[19 chars]1.vhd(7)port_007 -- Change number of spaces after *in* to 4.\r'
> 'ERRO[19 chars]1.vhd(7)port_007 -- Change number of spaces after *in* to 4.'

The tests use `.split('\n')` to split stdout and stderr by the Linux
line terminator '\n'. But on Windows this causes test failures as the
line terminator is '\r\n'.

Instead use Python `.splitlines()`. which will split on both Linux and
Windows style line terminators. `.splitlines()` also removes empty
trailing lines, so we must modify the expected output accordingly.

Signed-off-by: Brandon Maier <brandon.maier@gmail.com>

* Fixing test error by including encoding when reading vhdl files.

* Fixing second error due to glob function using incorrect divider.

* Fixed file compare not working in quality report test.

* Fixed output error message to be independent of platform.

* Skipping permission tests when running on windows.

* Skipping file permission test when running on Windows.

---------

Signed-off-by: Brandon Maier <brandon.maier@gmail.com>
Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2025-01-13 20:46:16 -06:00
Jeremiah Leary d34592f34b
Merge pull request #1203 from jeremiah-c-leary/issue-1202
Issue#1202:  Adding Pascal_Snake_Case option to case rules.
2025-01-13 06:51:12 -06:00
Jeremiah Leary ec4910cd0f
Merge pull request #1388 from valerionew/patch-1
Update tox.ini to include python 3.13
2025-01-12 09:17:15 -06:00
Valerio 28ff282b79
Update tox.ini to include python 3.13 2025-01-07 11:35:27 +01:00
Jeremiah Leary 267e02b25b
Merge pull request #1386 from JHertz5/issue-1385
Issue#1385: Replace rules iteration_scheme_502 and for_generate_statement_502 with a parameter_specification rule
2025-01-05 08:43:34 -06:00
Jukka Hertzog 17720811ad
Merge branch 'jeremiah-c-leary:master' into issue-1385 2025-01-04 21:12:17 +00:00
JHertz5 c01ece36d3 Issue#1385: Documentation correction for deprecated rules. 2025-01-04 21:09:49 +00:00
Jeremiah Leary d3f6e80124
Merge pull request #1380 from JHertz5/issue-1366
Issue#1366: Added structure rules for subprogram instantiation declarations
2025-01-04 13:58:44 -06:00
JHertz5 1d63871e75 Merge remote-tracking branch 'origin/master' into issue-1366 2025-01-04 18:47:29 +00:00
Jukka Hertzog 756fd22e49
Merge branch 'jeremiah-c-leary:master' into issue-1385 2025-01-04 18:45:46 +00:00
Jeremiah Leary a79da927c9
Merge pull request #1381 from JHertz5/issue-1318
Issue#1318: Added whitespace rules for subprogram instantiation declarations
2025-01-04 12:23:08 -06:00
JHertz5 9727a04330 Issue#1385: Updated documentation. 2025-01-04 17:41:24 +00:00
JHertz5 447158529d Issue#1385: Deprecated rules iteration_scheme_502 and for_generate_statement_502. 2025-01-04 17:39:03 +00:00
JHertz5 ca3f0b93bf Issue#1385: Added tests for case rule for in keyword in parameter specifications. 2025-01-04 17:37:42 +00:00
JHertz5 9fcb0ee003 Issue#1385: Added case rule for in keyword in parameter specifications. 2025-01-04 17:29:30 +00:00
Jukka Hertzog d1f1cce68a
Merge branch 'jeremiah-c-leary:master' into issue-1318 2025-01-04 17:18:17 +00:00
Jukka Hertzog d53cf5ee1e
Merge branch 'jeremiah-c-leary:master' into issue-1366 2025-01-04 17:17:39 +00:00
Jeremiah Leary 71705a6fb9
Merge pull request #1382 from JHertz5/issue-1376
Issue#1376: Added case rules for parameter identifiers in for generates/loops
2025-01-04 11:01:39 -06:00
Jeremiah Leary 83a6e68f03 Updating documentation for upper and lower case configuration. 2025-01-04 10:31:45 -06:00
Jeremiah Leary 75cbdfe002 Adding tests for relaxedCamelCase and RelaxedPascalCase. 2025-01-04 10:09:33 -06:00
Jeremiah Leary 81b8beb4d2 Updating Announcements. 2025-01-01 17:17:51 -06:00
Jeremiah Leary b9607b0267 Adding new regex options. 2025-01-01 17:08:36 -06:00
JHertz5 ff00562e04 Merge remote-tracking branch 'origin/master' into issue-1318 2025-01-01 19:13:58 +00:00
JHertz5 a7e2c6b791 Merge remote-tracking branch 'origin/master' into issue-1366 2025-01-01 19:13:18 +00:00
Jukka Hertzog 72b262cd58
Merge branch 'jeremiah-c-leary:master' into issue-1376 2025-01-01 19:12:26 +00:00
Jeremiah Leary 68009fac8e
Merge pull request #1233 from JHertz5/issue-1232
Issue#1232: Replaced ieee_500 with type_mark_500
2025-01-01 11:51:40 -06:00
Jeremiah Leary 2355a0fc24
Merge pull request #1371 from JHertz5/issue-1364
Issue#1364: Added case rules for subprogram instantiation declarations
2025-01-01 11:40:09 -06:00
Jeremiah Leary 6b15d115c0 Fixing style issues. 2025-01-01 11:30:38 -06:00
Jeremiah Leary 96b9be47d2 Merge branch 'master' into issue-1202
Updated tests.
2025-01-01 11:24:46 -06:00
JHertz5 55d86de1a4 Issue#1364: Deleted "actual" files for rule_group tests. These files should never have been committed. 2025-01-01 14:02:27 +00:00
JHertz5 6bd2c3abd7 Issue#1364: Corrected rule fix examples in documentation. 2025-01-01 13:56:46 +00:00
JHertz5 407d08dfb2 Issue#1376: Removed redundant new rules. 2024-12-30 19:06:24 +00:00
JHertz5 80f123030a Issue#1376: Added documentation for parameter_specification rule for identifier case. 2024-12-30 19:03:55 +00:00
JHertz5 78380c9067 Issue#1376: Added tests for parameter_specification rule for identifier case. 2024-12-30 18:55:58 +00:00
JHertz5 3d36d70230 Issue#1376: Added parameter_specification rule for identifier case. 2024-12-30 18:55:42 +00:00
JHertz5 97bd50c547 Merge remote-tracking branch 'origin/master' into issue-1232 2024-12-30 09:37:47 +00:00
JHertz5 e50db92b5a Merge remote-tracking branch 'origin/master' into issue-1366 2024-12-30 09:31:44 +00:00
JHertz5 b689c20974 Merge remote-tracking branch 'origin/master' into issue-1318 2024-12-30 09:29:59 +00:00
Jukka Hertzog a1fed3b41c
Merge branch 'jeremiah-c-leary:master' into issue-1376 2024-12-30 09:26:51 +00:00
Jeremiah Leary 710f857db1
Merge branch 'master' into issue-1364 2024-12-29 17:32:06 -06:00
Jeremiah Leary 2e209a6329
Merge pull request #1375 from JHertz5/issue-1363
Issue-1363: Added case rules for array type definitions
2024-12-29 17:27:27 -06:00
Jeremiah Leary ff1a64947f
Merge pull request #1373 from JHertz5/issue-1372
Issue#1372: Corrected documentation links
2024-12-29 17:15:06 -06:00
Jeremiah Leary 2a2fbf4dd7
Merge pull request #1378 from JHertz5/issue-1377
Issue#1377: Improved consistency of formatting of keywords in documentation.
2024-12-29 17:00:13 -06:00
JHertz5 caab45d8e6 Issue#1376: Added docs for new rules. 2024-12-29 18:10:19 +00:00
JHertz5 51b56009c5 Issue#1376: Updated new tests to check rule groups. 2024-12-29 18:08:02 +00:00
JHertz5 92cfaafe34 Issue#1376: Corrected rule group of new case rules. 2024-12-29 18:07:25 +00:00
JHertz5 6514e4c680 Issue#1376: Added test for case rule for parameter identifiers in iteration schemes. 2024-12-29 18:03:12 +00:00
JHertz5 4879f4bd01 Issue#1376: Added case rule for parameter identifiers in iteration schemes. 2024-12-29 18:00:12 +00:00
JHertz5 c450a00516 Issue#1376: Added test for case rule for parameter identifiers in for-generates. 2024-12-29 17:56:51 +00:00
JHertz5 0a92f649fb Issue#1376: Added case rule for parameter identifiers in for-generates. 2024-12-29 17:49:50 +00:00
JHertz5 a8b94fdfbf Issue#1318: Added documentation for subprogram instantiation whitespace rules. 2024-12-29 17:26:45 +00:00
JHertz5 533336e393 Issue#1318: Added tests for subprogram instantiation whitespace rules. 2024-12-29 17:23:52 +00:00
JHertz5 b26a7052cb Issue#1318: Added subprogram instantiation whitespace rules. 2024-12-29 17:11:07 +00:00
JHertz5 4a225657a4 Issue#1366: Added documentation for subprogram instantiation structure rules. 2024-12-29 11:12:54 +00:00
JHertz5 62bef9cdf0 Issue#1366: Corrected doc comment. 2024-12-29 11:12:38 +00:00
JHertz5 0d884952ea Issue#1366: Added tests for subprogram instantiation structure rules. 2024-12-29 11:08:54 +00:00
JHertz5 9087f795c8 Issue#1366: Added subprogram instantiation structure rules. 2024-12-29 10:58:49 +00:00
JHertz5 a2519e4b1a Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
JHertz5 5b501b8961 Issue#1363: Removed empty line. 2024-12-23 19:04:38 +00:00
Jukka Hertzog 5521eafdb3
Issue#1363: Removed accidental line. 2024-12-23 10:47:07 +00:00
Jukka Hertzog d10f72c3fa
Issue#1363: Doc file correction. 2024-12-23 10:04:23 +00:00
Jukka Hertzog ebc5c87423
Issue#1363: Deleted files place in wrong directory. 2024-12-23 09:47:50 +00:00
Jukka Hertzog f4c65b5b33
Issue#1363: Deleted files place in wrong directory. 2024-12-23 09:47:42 +00:00
Jukka Hertzog 926f4e8d33
Issue#1363: Deleted files place in wrong directory. 2024-12-23 09:47:32 +00:00
Jukka Hertzog b7f995575a
Issue#1363: Deleted files place in wrong directory. 2024-12-23 09:47:23 +00:00
Jukka Hertzog b493c9b1d0
Issue#1363: Deleted files place in wrong directory. 2024-12-23 09:46:57 +00:00
Jukka Hertzog ee415cfa08
Issue#1363: Added rule group documentation for new rules. 2024-12-23 09:45:23 +00:00
Jukka Hertzog 6593a9ca32
Issue#1363: Added documentation for new rules. 2024-12-23 09:44:39 +00:00
Jukka Hertzog 9993b379ab
Issue#1363: Deleted directory in the wrong location. 2024-12-23 09:37:01 +00:00
Jukka Hertzog be9d7c2c0b
Issue#1363: Deleted directory in the wrong location. 2024-12-23 09:36:52 +00:00
Jukka Hertzog bf4aa74f7a
Issue#1363: Added array type definition case rules.
(to the correct directory this time)
2024-12-23 09:36:22 +00:00
Jukka Hertzog 1b986ec952
Issue#1363: Updated vsg/rules/__init__.py with new modules. 2024-12-23 09:34:27 +00:00
Jukka Hertzog 2c3e175ee1
Issue#1363: Deleted unwanted line. 2024-12-23 09:31:42 +00:00
Jukka Hertzog 61bff1cf1a
Issue#1363: Reverted changes to vsg __init__.py 2024-12-23 09:31:02 +00:00
Jukka Hertzog 701da49cc5
Issue#1363: Deleted tests/unbounded_array_definition/__pycache__ directory 2024-12-23 09:28:56 +00:00
Jukka Hertzog c667838ffe
Issue#1363: Deleted tests/constrained_array_definition/__pycache__ directory 2024-12-23 09:28:34 +00:00
Jukka Hertzog 47735b1118
Issue#1363: Added documentation for case rules for array type definitions. 2024-12-23 09:24:29 +00:00
Jukka Hertzog 9960026cf5
Issue#1363: Added tests for case rules for array type definitions. 2024-12-23 09:19:50 +00:00
Jukka Hertzog 84dd83896d
Issue#1363: Added case rules for array type definitions. 2024-12-23 09:18:18 +00:00
Jukka Hertzog a774962318
Merge branch 'jeremiah-c-leary:master' into issue-1372 2024-12-23 09:15:14 +00:00
JHertz5 ae3d806154 Issue#1372: Corrected documentation links. 2024-12-22 02:35:32 +00:00
JHertz5 9f9dca03f8 Issue#1364: Corrected rule group documentation. 2024-12-22 02:25:23 +00:00
JHertz5 e515ed6892 Issue#1364: Added documentation for case rules for subprogram kinds. 2024-12-22 02:21:59 +00:00
JHertz5 2beebc40eb Issue#1364: Added documentation for case rules for subprogram instantiations. 2024-12-22 02:20:28 +00:00
JHertz5 74607d5bc5 Issue#1364: Added tests for case rules for subprogram instantiations. 2024-12-22 02:14:16 +00:00
JHertz5 d24ee8b9e3 Issue#1364: Added case rules for subprogram instantiations. 2024-12-21 18:25:46 +00:00
JHertz5 da2192e212 Issue#1364: Minor simplifications in package instantiation rules. 2024-12-21 18:25:07 +00:00
JHertz5 1cd45b65d7 Issue#1364: Added documentation for rules subprogram_kind_500 and subprogram_kind_501. 2024-12-21 18:14:53 +00:00
JHertz5 b8177c3b04 Issue#1364: Added tests for rules subprogram_kind_500 and subprogram_kind_501. 2024-12-21 18:14:33 +00:00
JHertz5 0c1f693430 Issue#1364: Updated documentation for rules function_014 and procedure_505. 2024-12-21 18:14:12 +00:00
JHertz5 178571e7cd Issue#1364: Updated tests for rules function_014 and procedure_505. 2024-12-21 18:10:01 +00:00
JHertz5 ce086080a1 Issue#1364: Deprecated rules function_014 and procedure_505, and updated procedure_009, in favour of subprogram_kind rules. 2024-12-21 18:09:29 +00:00
JHertz5 8cf2a5e316 Merge remote-tracking branch 'origin/master' into issue-1364 2024-12-21 18:04:01 +00:00
Jukka Hertzog 2fdbcb4ec5
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-12-21 17:48:05 +00:00
JHertz5 1ad29342c3 Issue#1364: Added rules subprogram_kind_500 and subprogram_kind_501. 2024-12-21 17:45:28 +00:00
Jeremiah Leary ae0e7b142b
Merge pull request #1370 from JHertz5/issue-1369
Issue#1369: Deprecated `procedure_009`, which duplicates `procedure_505`
2024-12-21 11:30:46 -06:00
Jeremiah Leary 873f8bbe52
Merge pull request #1362 from JHertz5/issue-1361
Issue#1361: Added case rule for `open` keyword in array constraints.
2024-12-21 11:30:05 -06:00
JHertz5 696656a095 Issue#1364: Updated tests for function_014. 2024-12-21 17:24:32 +00:00
JHertz5 90028521ae Issue#1364: Updated function_014 to only work at the end of function declarations. 2024-12-21 17:22:30 +00:00
JHertz5 b2d93a3c13 Issue#1364: Corrected procedure_505. 2024-12-21 17:22:10 +00:00
Jeremiah Leary 534c9fbacf
Merge pull request #1360 from JHertz5/issue-1359
Issue#1359: Added case rules for the `range` keyword.
2024-12-21 11:20:44 -06:00
JHertz5 9b436224ca Issue#1364: Updated tests for procedure_505 to ensure that it only works at the end of procedure declarations. 2024-12-21 17:17:26 +00:00
JHertz5 c1732451d8 Issue#1364: Updated procedure_505 to only work at the end of procedure declarations. 2024-12-21 17:16:57 +00:00
JHertz5 58ae6220cc Issue#1369: Updated solution message for rule procedure_009. 2024-12-21 17:09:01 +00:00
Jeremiah Leary e1b5e3a19f
Merge pull request #1368 from JHertz5/issue-1367
Issue#1367: Added missing init file for if_generate_statement.
2024-12-21 11:04:48 -06:00
JHertz5 5eb34981fe Issue#1369: Updated documentation for rule procedure_009. 2024-12-21 16:59:02 +00:00
JHertz5 95a8f67afb Issue#1369: Updated tests for rule procedure_009. 2024-12-21 16:58:08 +00:00
JHertz5 9041008b92 Issue#1369: Deprecated rule procedure_009. 2024-12-21 16:57:55 +00:00
Jukka Hertzog 390281d151
Issue#1232: Deleted irrelevant file. 2024-12-21 16:04:18 +00:00
JHertz5 93dda2315d Issue#1367: Added missing init file for if_generate_statement. 2024-12-21 16:01:30 +00:00
Jukka Hertzog ac7b4320cc
Merge branch 'jeremiah-c-leary:master' into issue-1361 2024-12-21 15:58:19 +00:00
Jukka Hertzog 0ece002909
Merge branch 'jeremiah-c-leary:master' into issue-1359 2024-12-21 15:58:15 +00:00
JHertz5 9fe3f68de0 Issue#1361: Added documentation for rule array_constraint_500. 2024-12-21 11:24:09 +00:00
JHertz5 c66211af0e Issue#1361: Added tests for rule array_constraint_500. 2024-12-21 11:21:47 +00:00
JHertz5 fdafb60e2c Issue#1361: Added rule array_constraint_500. 2024-12-21 11:21:34 +00:00
JHertz5 d88a255745 Issue#1359: Corrected grammar error. 2024-12-21 11:14:22 +00:00
JHertz5 6d4feaab88 Issue#1359: Updated rule group documentation. 2024-12-21 11:00:38 +00:00
JHertz5 b2c83a7c07 Issue#1359: Added documentation for rules range_constraint_500 and index_subtype_definition_500. 2024-12-21 10:55:44 +00:00
JHertz5 19bc240ea3 Issue#1359: Added tests for rules range_constraint_500 and index_subtype_definition_500. 2024-12-21 10:54:32 +00:00
JHertz5 97e500bf9f Issue#1359: Corrected order of packages in __init__.py. 2024-12-21 10:49:32 +00:00
JHertz5 3cd805b0e9 Issue#1359: Added rules range_constraint_500 and index_subtype_definition_500. 2024-12-21 10:39:23 +00:00
JHertz5 9f79aaad8d Issue#1232: Updated top level rule documentation. 2024-12-20 22:42:34 +00:00
JHertz5 0cf5afb348 Issue#1232: Updated rule group tests. 2024-12-20 22:38:23 +00:00
JHertz5 773d2e8e80 Issue#1232: Updated rule group tests. 2024-12-20 22:21:04 +00:00
JHertz5 87b1b3e591 Issue#1232: Formatting. 2024-12-20 22:13:26 +00:00
JHertz5 199f54f5fb Issue#1232: Updated tests for type_mark_500. 2024-12-20 19:33:39 +00:00
JHertz5 116b1941da Issue#1232: Updated documentation for type_mark_500. 2024-12-20 19:33:25 +00:00
JHertz5 5d3d995208 Issue#1232: Updated type_mark_500 to avoid duplicated violations. 2024-12-20 19:33:03 +00:00
JHertz5 c001fa8048 Issue#1232: Updated tests for type_mark_500 to act on generic and port clauses. 2024-12-20 19:26:56 +00:00
JHertz5 9b1c0144c5 Issue#1232: Updated type_mark_500 to act on generic and port clauses. 2024-12-20 19:26:39 +00:00
JHertz5 d798ae36a9 Issue#1232: Updated documentation for disabled rules. 2024-12-20 19:05:44 +00:00
JHertz5 9219ec42af Issue#1232: Removed unused files 2024-12-20 19:03:06 +00:00
JHertz5 3d2d44d0f4 Issue#1232: Updated documentation after reverting the disabling of subtype_002 and type_014. 2024-12-20 19:02:36 +00:00
JHertz5 caf3b5ec44 Issue#1232: Reverted disabling of subtype_002 and type_014. 2024-12-20 19:02:14 +00:00
JHertz5 5045fc01d1 Issue#1232: Updated group documentation deprecating rules generic_017 and port_018. 2024-12-20 19:01:19 +00:00
JHertz5 6e9b560260 Issue#1232: Updated documentation for rule generic_017. 2024-12-20 18:59:47 +00:00
JHertz5 d538ec7867 Issue#1232: Updated tests for rule generic_017. 2024-12-20 18:59:31 +00:00
JHertz5 68b4921599 Issue#1232: Deprecated rule generic_017. 2024-12-20 18:59:17 +00:00
JHertz5 7a91103bb0 Issue#1232: Updated documentation for rule port_018. 2024-12-20 18:58:28 +00:00
JHertz5 6aaa7b6366 Issue#1232: Updated tests for rule port_018. 2024-12-20 18:58:03 +00:00
JHertz5 c2c07ef689 Issue#1232: Deprecated rule port_018. 2024-12-20 18:57:21 +00:00
Jukka Hertzog 8eecb06807
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-12-20 18:11:31 +00:00
Jeremiah Leary bcce2c8f1f
Merge pull request #1238 from larshb/doc-fixes
Minor improvements in documentation
2024-12-20 10:11:40 -06:00
Jukka Hertzog 69b7bea2c6
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-12-20 09:09:40 +00:00
Jeremiah Leary cc25b139c6
Merge pull request #1311 from JHertz5/issue-1310
Issue#1310: Add consistent case rules for paramter names in subprograms.
2024-12-19 19:28:21 -06:00
Jukka Hertzog da256c14eb
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-12-19 09:26:18 +00:00
Jukka Hertzog 4c0d95d4db
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-12-19 09:26:16 +00:00
Jeremiah Leary cf87ca6f58
Merge pull request #1327 from JHertz5/issue-1323
Issue#1323:  Add indent and blank line rules for package instantiation declarations
2024-12-18 13:45:42 -06:00
JHertz5 5042954dc0 Issue#1232: Corrected test files to ensure scope of parameters within nested functions. 2024-12-18 09:20:54 +00:00
JHertz5 7d26573846 Issue#1232: Corrected documentation for rule package_instantiation_201. 2024-12-18 08:57:06 +00:00
JHertz5 a0b189b6de Merge remote-tracking branch 'origin/master' into issue-1323 2024-12-18 08:55:30 +00:00
Jukka Hertzog 6d549e1caa
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-12-18 08:54:31 +00:00
Jukka Hertzog 3ca9eba781
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-12-18 08:54:29 +00:00
Jeremiah Leary 5845f5e1e0
Merge pull request #1355 from JHertz5/issue-1333
Issue#1333: Broke `instantiation_001` out into port map and generic map rules.
2024-12-17 16:22:02 -06:00
Jeremiah Leary 32500e3b47
Merge pull request #1356 from JHertz5/issue-1341
Issue#1341: Added `delay_machanism` and `after` keyword case rules
2024-12-17 15:53:37 -06:00
Jeremiah Leary 477999667b
Merge pull request #1352 from JHertz5/issue-1350
Issue#1350 Added case and whitespace rules for shift operators.
2024-12-17 15:39:55 -06:00
Jukka Hertzog ccf8cb508a
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-12-17 01:23:53 +00:00
Jukka Hertzog 8095022d2c
Merge branch 'jeremiah-c-leary:master' into issue-1323 2024-12-17 01:23:51 +00:00
Jukka Hertzog 8475ee4935
Merge branch 'jeremiah-c-leary:master' into issue-1350 2024-12-17 01:23:50 +00:00
Jukka Hertzog ca24b31d7d
Merge branch 'jeremiah-c-leary:master' into issue-1333 2024-12-17 01:23:49 +00:00
Jukka Hertzog 47e5d7fe51
Merge branch 'jeremiah-c-leary:master' into issue-1341 2024-12-17 01:23:48 +00:00
Jukka Hertzog e0f240d560
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-12-17 01:23:33 +00:00
Jeremiah Leary da81c9277c
Merge pull request #1351 from rpatel3001/patch-1
use with FIPS
2024-12-16 13:05:59 -06:00
Jeremiah Leary b8d49ca03d
Merge pull request #1354 from JHertz5/issue-1353
Issue#1353: Corrected documentation for `port_015`
2024-12-16 12:51:31 -06:00
JHertz5 0e043c2448 Issue#1232: Formatting. 2024-12-15 13:30:51 +00:00
JHertz5 4f359477a2 Issue#1232: Corrected rule_group tests. 2024-12-15 12:49:56 +00:00
JHertz5 1b2cb8bc27 Issue#1232: Updated type_mark_500 to only apply to type_marks that are not locally defined. 2024-12-15 12:28:27 +00:00
JHertz5 416a03bfbb Issue#1341: Added documentation for rule after_500. 2024-12-15 09:45:46 +00:00
JHertz5 1d0e8e9c15 Issue#1341: Added tests for rule after_500. 2024-12-15 09:44:03 +00:00
JHertz5 9148623156 Issue#1341: Added rule after_500. 2024-12-15 09:36:47 +00:00
JHertz5 504106d30c Issue#1341: Added more documentation for delay_mechanism rules. 2024-12-14 23:43:31 +00:00
JHertz5 4ec64e4e73 Issue#1333: Test update. 2024-12-14 23:34:02 +00:00
JHertz5 c2b50bd330 Issue#1341: Added documentation for delay_mechanism rules. 2024-12-14 23:30:38 +00:00
JHertz5 a2396c1982 Issue#1341: Corrected tests for rules delay_mechanism_501, delay_mechanism_502. 2024-12-14 23:26:51 +00:00
JHertz5 369b94bf67 Issue#1341: Added tests for rules delay_mechanism_500, delay_mechanism_501, delay_mechanism_502. 2024-12-14 23:24:04 +00:00
JHertz5 4d18d4d898 Issue#1341: Added rules delay_mechanism_500, delay_mechanism_501, delay_mechanism_502. 2024-12-14 23:23:53 +00:00
JHertz5 a288f9a59b Issue#1333: Updated documentation. 2024-12-14 22:53:59 +00:00
JHertz5 f296ceb6c6 Issue#1333: Deprecated rule instantiation_001. 2024-12-14 22:51:26 +00:00
JHertz5 91263f7002 Issue#1333: Added test for rule instantiation_300. 2024-12-14 22:45:39 +00:00
JHertz5 9170edf9e7 Issue#1333: Added tests for rules generic_map_300, generic_map_301, generic_map_302. 2024-12-14 22:38:48 +00:00
JHertz5 26d2c324ca Issue#1333: Updated indent_config for package/subprogram instantiation declarations. 2024-12-14 22:38:01 +00:00
JHertz5 c068444c6d Issue#1333: Added tests for rules port_map_300, port_map_301, port_map_302. 2024-12-14 20:45:36 +00:00
JHertz5 a3ff19c5bf Issue#1353: Corrected documentation for `port_015` 2024-12-14 19:58:23 +00:00
JHertz5 c5a05e4651 Issue#1333: Added rule instantiation_300. 2024-12-14 19:54:19 +00:00
JHertz5 1f1ba78589 Issue#1333: Added rules port_map_300, port_map_301, port_map_302. 2024-12-14 19:53:59 +00:00
JHertz5 b3c700eeb4 Issue#1333: Added rules generic_map_300, generic_map_301, generic_map_302. 2024-12-14 19:53:52 +00:00
JHertz5 bdf30ec41a Issue#1350: Corrected test for rule whitespace_101. 2024-12-14 10:53:45 +00:00
JHertz5 3b34f7a621 Issue#1350: Corrected name of classes for whitespace tests. 2024-12-14 09:35:03 +00:00
JHertz5 3031c90aaf Issue#1350: Corrected test for rule whitespace_101. 2024-12-14 09:34:47 +00:00
JHertz5 2bba67c25f Issue#1333: Added rule generic_map_300. 2024-12-14 09:32:30 +00:00
JHertz5 e8e9b01e05 Issue#1350: Updated documentation for new rules. 2024-12-14 09:23:22 +00:00
JHertz5 2fdba1d44e Issue#1350: Added tests for rule whitespace_101. 2024-12-14 09:19:57 +00:00
JHertz5 9c49788fcb Issue#1350: Added init files for tests. 2024-12-14 09:16:21 +00:00
JHertz5 511ac09f2b Issue#1350: Added tests for rule shift_operator_500 2024-12-14 09:13:17 +00:00
JHertz5 505ac21dc6 Issue#1350: Added rule whitespace_101. 2024-12-14 09:10:55 +00:00
JHertz5 97cf12f8ea Issue#1350: Minor correction to whitespace_013 default solution message. 2024-12-14 09:10:42 +00:00
JHertz5 ce5f1588e3 Issue#1350: Added rule shift_operator_500 2024-12-14 09:05:24 +00:00
Rajan Patel d2756e7f75
use with FIPS 2024-12-13 18:13:54 -05:00
JHertz5 e3f8443f19 Merge remote-tracking branch 'origin/master' into issue-1323 2024-12-13 22:39:50 +00:00
Jukka Hertzog aa1fac5054
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-12-13 22:22:34 +00:00
Jukka Hertzog 7f31fc88af
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-12-13 22:22:23 +00:00
Jeremiah Leary 2545818344
Merge pull request #1336 from JHertz5/issue-1335
Issue#1335: Updated `variable_011` to act on association actual parts
2024-12-13 15:01:49 -06:00
Jeremiah Leary 36aa24f18f
Merge pull request #1329 from JHertz5/issue-1325
Issue#1325: Added rules for whitespace in package instantiations.
2024-12-13 14:33:51 -06:00
Jeremiah Leary 6041ddc7d5
Merge pull request #1321 from JHertz5/issue-1320
Issue#1320: Added rules to enforce whitespace and structure around map keywords.
2024-12-13 14:30:25 -06:00
Jeremiah Leary 394f13735c
Merge pull request #1348 from JHertz5/issue-1347
Issue#1347: Removed commented-out code
2024-12-13 14:21:33 -06:00
Jeremiah Leary 400d6fea51
Merge pull request #1349 from jeremiah-c-leary/issue-1290
Issue 1290
2024-12-13 13:43:55 -06:00
Jukka Hertzog 8a3e45674b
Merge branch 'jeremiah-c-leary:master' into issue-1347 2024-12-13 16:09:34 +00:00
Jukka Hertzog 3e8be527b1
Merge branch 'jeremiah-c-leary:master' into issue-1335 2024-12-13 16:09:32 +00:00
Jukka Hertzog 18cecec89a
Merge branch 'jeremiah-c-leary:master' into issue-1320 2024-12-13 16:09:32 +00:00
Jukka Hertzog 8e73f531ad
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-12-13 16:09:31 +00:00
Jukka Hertzog 8c9ccfe65e
Merge branch 'jeremiah-c-leary:master' into issue-1323 2024-12-13 16:09:30 +00:00
Jukka Hertzog db97173281
Merge branch 'jeremiah-c-leary:master' into issue-1325 2024-12-13 16:09:30 +00:00
Jukka Hertzog 3af40d6142
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-12-13 16:09:29 +00:00
Jeremiah Leary 25d1f4314a
Merge pull request #1303 from JHertz5/issue-1302
Issue#1302: Added parsing of shift operators
2024-12-13 09:38:00 -06:00
JHertz5 0063fa5346 Merge remote-tracking branch 'origin/master' into issue-1232 2024-12-13 14:16:40 +00:00
JHertz5 c84ae04512 Merge remote-tracking branch 'origin/master' into issue-1325 2024-12-13 14:11:58 +00:00
JHertz5 b301dce3c9 Issue#1323: Added documentation for package_instantiation_201. 2024-12-13 14:10:51 +00:00
JHertz5 4bc7e1e289 Merge remote-tracking branch 'origin/master' into issue-1323 2024-12-13 14:09:56 +00:00
JHertz5 a57360ac94 Merge remote-tracking branch 'origin/master' into issue-1310 2024-12-13 14:08:46 +00:00
JHertz5 79b5803324 Merge remote-tracking branch 'origin/master' into issue-1335 2024-12-13 14:08:32 +00:00
JHertz5 214d6d1990 Merge remote-tracking branch 'origin/master' into issue-1320 2024-12-13 14:08:15 +00:00
JHertz5 0fb4919c7e Merge remote-tracking branch 'origin/master' into issue-1347 2024-12-13 14:07:31 +00:00
JHertz5 f630e6ba85 Merge remote-tracking branch 'origin/master' into issue-1302 2024-12-13 14:05:23 +00:00
Jeremiah Leary add3736ffd
Merge pull request #1331 from JHertz5/issue-1330
Issue#1330: Added naming rules for package instantiation declarations.
2024-12-13 07:31:07 -06:00
Jeremiah Leary 3b94109788
Merge pull request #1328 from JHertz5/issue-1324
Issue#1324: Added structure rule for package instantiations.
2024-12-13 07:19:40 -06:00
Jeremiah Leary 070c050e9f
Merge pull request #1346 from JHertz5/issue-1280
Issue#1280: Added rule to enforce case of `others` keyword in `choice` productions
2024-12-13 06:40:46 -06:00
JHertz5 0bc12e70f4 Merge remote-tracking branch 'origin/master' into issue-1302 2024-12-13 09:37:59 +00:00
Jeremiah Leary 8aabf7179e
Merge pull request #1301 from JHertz5/issue-1300
Issue#1300: Reduced duplication in vhdlFile
2024-12-12 16:57:09 -06:00
Jeremiah Leary bae7553f77 Updating for style issues. 2024-12-12 16:38:14 -06:00
Jeremiah Leary 60147b01a7 Removing invalid tokens from reserved_001. 2024-12-12 16:32:50 -06:00
Jeremiah Leary 0359607490 Updating rule generic_600 to ignore functions and procedures in generic maps. 2024-12-12 16:09:18 -06:00
Jeremiah Leary b1567a6987 Updating rule generic_020 to ignore procedures and functions in generic maps. 2024-12-12 16:02:10 -06:00
Jeremiah Leary 5fc7d028cb Updating rule generic_017 to ignore function and procedures in generic maps. 2024-12-12 15:50:50 -06:00
Jeremiah Leary c4cc365a27 Updated rule generic_016 to ignore functions and procedures in generic maps. 2024-12-12 15:36:53 -06:00
Jeremiah Leary 7e9e5fcc5c Updating rule generic_014 to ignore functions and procedures in generic maps. 2024-12-12 15:25:56 -06:00
JHertz5 e146f5bad3 Issue#1347: Formatting. 2024-12-12 21:24:54 +00:00
JHertz5 18fd385e97 Issue#1347: Formatting. 2024-12-12 21:11:59 +00:00
JHertz5 a94031c5b3 Issue#1347: Removed line that was deleted by accident. 2024-12-12 21:09:21 +00:00
JHertz5 541557584f Issue#1347: Formatting 2024-12-12 21:06:57 +00:00
JHertz5 59b581e892 Issue#1347: Removed commented-out code 2024-12-12 20:48:55 +00:00
JHertz5 65b8e34b85 Issue#1280: Updated documentation. 2024-12-12 20:29:32 +00:00
JHertz5 d2c751bd07 Issue#1280: Added choice_500 to keywords case rule group. 2024-12-12 20:29:11 +00:00
JHertz5 f805073ead Issue#1280: Updated tests for deprecated rules. 2024-12-12 20:22:48 +00:00
JHertz5 c0dcb8847b Issue#1280: Deprecated rules aggregate_500, case_500, and case_generate_alternative_501 in favour of choice_500. 2024-12-12 20:22:19 +00:00
JHertz5 5da0099d7b Issue#1280: Added tests for rule choice_500. 2024-12-12 20:13:19 +00:00
JHertz5 0cd094eaa0 Issue#1280: Minor fix for bit_string_literal test class names. 2024-12-12 20:13:07 +00:00
JHertz5 b9371617ce Issue#1280: Added rule choice_500. 2024-12-12 19:59:58 +00:00
Jukka Hertzog b8746188a1
Merge branch 'jeremiah-c-leary:master' into issue-1320 2024-12-12 19:49:50 +00:00
Jukka Hertzog 482d92f1c4
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-12-12 19:49:46 +00:00
Jukka Hertzog ba1fb675ea
Merge branch 'jeremiah-c-leary:master' into issue-1335 2024-12-12 19:49:46 +00:00
Jukka Hertzog 59ff8aaaca
Merge branch 'jeremiah-c-leary:master' into issue-1325 2024-12-12 19:49:45 +00:00
Jukka Hertzog b5fb80c6b0
Merge branch 'jeremiah-c-leary:master' into issue-1323 2024-12-12 19:49:44 +00:00
Jukka Hertzog 1bf2a78bc1
Merge branch 'jeremiah-c-leary:master' into issue-1324 2024-12-12 19:49:44 +00:00
Jukka Hertzog 9e6093ee3d
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-12-12 19:49:43 +00:00
Jukka Hertzog 02fcc63b22
Merge branch 'jeremiah-c-leary:master' into issue-1330 2024-12-12 19:49:43 +00:00
Jukka Hertzog ea0934e8cf
Merge branch 'jeremiah-c-leary:master' into issue-1302 2024-12-12 19:49:41 +00:00
Jukka Hertzog 5f89f9fe44
Merge branch 'jeremiah-c-leary:master' into issue-1300 2024-12-12 19:49:41 +00:00
Jeremiah Leary 3b06b9e224 Updating rule generic_007 to ignore functions and procedures in generic maps. 2024-12-12 13:31:23 -06:00
Jeremiah Leary 267cd2917f Updating rule generic_006 to ignore functions and procedures in generic maps. 2024-12-12 12:41:19 -06:00
Jeremiah Leary 074656c04e Fixing style issues. 2024-12-12 12:32:52 -06:00
Jeremiah Leary a19108da56 Updated rule generic_004 to ignore functions and procedures. 2024-12-12 12:30:46 -06:00
Jeremiah Leary 2bc14a067a Refactoring to reduce code duplication. 2024-12-12 11:56:13 -06:00
Jeremiah Leary 06ff95900b Fixing rule generic_004 to ignore functions and procedures in generic maps. 2024-12-12 11:19:55 -06:00
Jeremiah Leary 1c9f48f9f7
Merge pull request #1296 from JHertz5/issue-1287
Issue#1287: Updated alignment rules to separate protected type bodies from other declarative regions
2024-12-12 10:20:59 -06:00
Jeremiah Leary b9e3f3ff8f
Merge pull request #1332 from JHertz5/issue-1319
Issue#1319: Updated generic map rules to work on all instances of generic maps.
2024-12-12 10:11:12 -06:00
Jukka Hertzog 7607f4feac
Issue#1287: Updated tests to check that declarations outisde of protected type bodies are ignore by protected type body rules. 2024-12-12 10:40:50 +00:00
JHertz5 5e56a0c374 Issue#1319: Updated tests for generic_map_006 2024-12-12 02:07:22 +00:00
JHertz5 2555cd6c9e Merge remote-tracking branch 'origin/master' into issue-1320 2024-12-12 01:59:04 +00:00
JHertz5 a7229b9817 Merge remote-tracking branch 'origin/master' into issue-1335 2024-12-12 01:53:25 +00:00
JHertz5 b1d7189d5d Merge remote-tracking branch 'origin/master' into issue-1310 2024-12-12 01:53:12 +00:00
JHertz5 8fe2f52768 Merge remote-tracking branch 'origin/master' into issue-1325 2024-12-12 01:52:55 +00:00
JHertz5 8744d57e1d Merge remote-tracking branch 'origin/master' into issue-1323 2024-12-12 01:52:14 +00:00
JHertz5 a9327ba902 Merge remote-tracking branch 'origin/master' into issue-1324 2024-12-12 01:51:56 +00:00
JHertz5 194ff7af96 Merge remote-tracking branch 'origin/master' into issue-1330 2024-12-12 01:51:43 +00:00
JHertz5 618583096e Merge remote-tracking branch 'origin/master' into issue-1232 2024-12-12 01:51:31 +00:00
JHertz5 60ec3e8657 Merge remote-tracking branch 'origin/master' into issue-1319 2024-12-12 01:51:05 +00:00
JHertz5 158192bdeb Merge remote-tracking branch 'origin/master' into issue-1300 2024-12-12 01:49:13 +00:00
JHertz5 5edf5a528f Merge remote-tracking branch 'origin/master' into issue-1287 2024-12-12 01:48:59 +00:00
JHertz5 d6ca617680 Merge remote-tracking branch 'origin/master' into issue-1302 2024-12-12 01:48:41 +00:00
Jeremiah Leary b9538868e1
Merge pull request #1326 from JHertz5/issue-1322
Issue#1322: Added case rules for package instantiation declarations
2024-12-11 16:44:14 -06:00
Jeremiah Leary a72a499912
Merge pull request #1317 from JHertz5/issue-1316
Issue#1316: Split enforcement for port maps out of generic_map_006.
2024-12-11 16:11:13 -06:00
Jeremiah Leary 527812dfd5
Merge pull request #1315 from JHertz5/issue-1314
Issue#1314: Updated report printing to dynamically update to match longest rule name.
2024-12-11 15:39:03 -06:00
Jeremiah Leary e2cfbdb275
Merge pull request #1298 from JHertz5/issue-1297
Issue#1297: Package body documentation corrections
2024-12-11 15:19:42 -06:00
Jeremiah Leary 588a615d5b
Merge pull request #1313 from JHertz5/issue-1295
Issue#1295: Update multiline_alignment_between_tokens.py to skip variable array assignments
2024-12-11 15:15:04 -06:00
Jeremiah Leary 0c83fa94af
Merge pull request #1308 from JHertz5/issue-1291
* Issue#1291: Correction to indentation when bIgnoreStartParen is enabled in _analyze_align_left_no_align_paren_yes.

* Issue#1291: Updated signal_400 tests to exercise initialisations.

* Issue#1291: Updated variable_400 tests to exercise initialisations.

* Issue#1291: Code cleanliness improvement.
2024-12-11 15:06:59 -06:00
Jukka Hertzog e12f495c26
Merge branch 'jeremiah-c-leary:master' into issue-1302 2024-12-10 08:09:50 +00:00
Jukka Hertzog e074a22df5
Merge branch 'jeremiah-c-leary:master' into issue-1287 2024-12-10 08:09:48 +00:00
Jukka Hertzog 474ace4816
Merge branch 'jeremiah-c-leary:master' into issue-1300 2024-12-10 08:09:47 +00:00
Jukka Hertzog 966174d666
Merge branch 'jeremiah-c-leary:master' into issue-1291 2024-12-10 08:09:45 +00:00
Jukka Hertzog 275a06e2f8
Merge branch 'jeremiah-c-leary:master' into issue-1319 2024-12-10 08:09:44 +00:00
Jukka Hertzog 4a2e5f6e2d
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-12-10 08:09:43 +00:00
Jukka Hertzog 63d0efd8c4
Merge branch 'jeremiah-c-leary:master' into issue-1330 2024-12-10 08:09:42 +00:00
Jukka Hertzog 7ea7bae4ad
Merge branch 'jeremiah-c-leary:master' into issue-1324 2024-12-10 08:09:36 +00:00
Jukka Hertzog cfcc4c9f88
Merge branch 'jeremiah-c-leary:master' into issue-1323 2024-12-10 08:09:35 +00:00
Jukka Hertzog e112439c8e
Merge branch 'jeremiah-c-leary:master' into issue-1325 2024-12-10 08:09:34 +00:00
Jukka Hertzog 418626c57e
Merge branch 'jeremiah-c-leary:master' into issue-1320 2024-12-10 08:09:33 +00:00
Jukka Hertzog bc622816d3
Merge branch 'jeremiah-c-leary:master' into issue-1316 2024-12-10 08:09:33 +00:00
Jukka Hertzog 9e86bdd586
Merge branch 'jeremiah-c-leary:master' into issue-1295 2024-12-10 08:09:32 +00:00
Jukka Hertzog 20e46fe075
Merge branch 'jeremiah-c-leary:master' into issue-1314 2024-12-10 08:09:31 +00:00
Jukka Hertzog 0cdf6ceb90
Merge branch 'jeremiah-c-leary:master' into issue-1335 2024-12-10 08:09:30 +00:00
Jukka Hertzog a51c2e70cb
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-12-10 08:09:30 +00:00
Jukka Hertzog 65143470bd
Merge branch 'jeremiah-c-leary:master' into issue-1322 2024-12-10 08:09:29 +00:00
Jukka Hertzog 368c5cb7b3
Merge branch 'jeremiah-c-leary:master' into issue-1297 2024-12-10 08:09:28 +00:00
Jukka Hertzog 22601912a9
Issue#1234: Consistent capitalization of generic names doesn't work inside generic maps (#1235)
* Issue#1234: Copied rule architecture_601 into rule architecture_600 to fix instances within generic maps not being corrected.

* Issue#1234: Updated/corrected spi_master.fixed.vhd for smart_tab.

* Issue#1228: Not sure why this was working before, but updated extract_generic/port_names_from_entities to protect against entities with no generic or port declarations.

* Issue#1234: Refactored common code from architecture_600 and architecture_601 out to shared base class.

* Issue#1234: Improved violation reporting.

* Issue#1234: Sorted setup in architecture_600 and architecture_601.

* Issue#1234: Modified imports to appease isort.

* Issue#1234: Updated tests to exercise improvement.

* Issue#1234: Removed unused function.
2024-12-09 17:20:48 -06:00
Jeremiah Leary a484f3cb7b Updating release process documentation. 2024-12-07 14:59:55 -06:00
Jukka Hertzog 5e954a452a
Merge branch 'jeremiah-c-leary:master' into issue-1297 2024-12-07 13:57:46 +00:00
Jukka Hertzog 0ce046e13d
Merge branch 'jeremiah-c-leary:master' into issue-1322 2024-12-07 13:57:45 +00:00
Jukka Hertzog 13852e3239
Merge branch 'jeremiah-c-leary:master' into issue-1335 2024-12-07 13:57:43 +00:00
Jukka Hertzog 095d5d45a3
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-12-07 13:57:42 +00:00
Jukka Hertzog 2da3fa68ef
Merge branch 'jeremiah-c-leary:master' into issue-1295 2024-12-07 13:57:41 +00:00
Jukka Hertzog f7f3cd4298
Merge branch 'jeremiah-c-leary:master' into issue-1314 2024-12-07 13:57:41 +00:00
Jukka Hertzog 004bfc4efc
Merge branch 'jeremiah-c-leary:master' into issue-1320 2024-12-07 13:57:39 +00:00
Jukka Hertzog 21a91ed4eb
Merge branch 'jeremiah-c-leary:master' into issue-1316 2024-12-07 13:57:39 +00:00
Jukka Hertzog ca489d5733
Merge branch 'jeremiah-c-leary:master' into issue-1325 2024-12-07 13:57:38 +00:00
Jukka Hertzog f49f0a008c
Merge branch 'jeremiah-c-leary:master' into issue-1323 2024-12-07 13:57:37 +00:00
Jukka Hertzog 7f1a1946c5
Merge branch 'jeremiah-c-leary:master' into issue-1324 2024-12-07 13:57:36 +00:00
Jukka Hertzog d2d43f986c
Merge branch 'jeremiah-c-leary:master' into issue-1330 2024-12-07 13:57:35 +00:00
Jukka Hertzog dc101cb7d6
Merge branch 'jeremiah-c-leary:master' into issue-1319 2024-12-07 13:57:34 +00:00
Jukka Hertzog eeb7aba0ad
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-12-07 13:57:34 +00:00
Jukka Hertzog 1becacbfc8
Merge branch 'jeremiah-c-leary:master' into issue-1291 2024-12-07 13:57:29 +00:00
Jukka Hertzog 2d01648f6d
Merge branch 'jeremiah-c-leary:master' into issue-1287 2024-12-07 13:57:27 +00:00
Jukka Hertzog 7b724757ef
Merge branch 'jeremiah-c-leary:master' into issue-1300 2024-12-07 13:57:27 +00:00
Jukka Hertzog 5ea90f3de2
Merge branch 'jeremiah-c-leary:master' into issue-1302 2024-12-07 13:57:26 +00:00
Jeremiah Leary ec19e1deb7
Issue#1286: Ensuring existing file permissions are maintained on fixed files. (#1342) 2024-12-06 15:30:17 -06:00
JHertz5 6c5b6fa24b Merge remote-tracking branch 'origin/issue-1300' into issue-1302 2024-11-27 14:10:34 +00:00
JHertz5 807c00ab67 Issue#1300: Formatting 2024-11-27 14:09:00 +00:00
JHertz5 00f06d923c Merge remote-tracking branch 'origin/master' into issue-1300 2024-11-27 14:08:39 +00:00
Jukka Hertzog 274ea484af
Merge branch 'jeremiah-c-leary:master' into issue-1287 2024-11-27 14:03:07 +00:00
Jukka Hertzog e1b9855ed9
Merge branch 'jeremiah-c-leary:master' into issue-1291 2024-11-27 14:03:01 +00:00
Jukka Hertzog 6b1ff1a88a
Merge branch 'jeremiah-c-leary:master' into issue-1319 2024-11-27 14:02:57 +00:00
Jukka Hertzog 1ffc72c5d1
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-11-27 14:02:56 +00:00
Jukka Hertzog f59cd83971
Merge branch 'jeremiah-c-leary:master' into issue-1330 2024-11-27 14:02:55 +00:00
Jukka Hertzog f10a2d9b17
Merge branch 'jeremiah-c-leary:master' into issue-1323 2024-11-27 14:02:54 +00:00
Jukka Hertzog f4f0185b13
Merge branch 'jeremiah-c-leary:master' into issue-1324 2024-11-27 14:02:53 +00:00
Jukka Hertzog 49a123b751
Merge branch 'jeremiah-c-leary:master' into issue-1320 2024-11-27 14:02:52 +00:00
Jukka Hertzog 7471fe5d9d
Merge branch 'jeremiah-c-leary:master' into issue-1325 2024-11-27 14:02:52 +00:00
Jukka Hertzog eb9fe8499f
Merge branch 'jeremiah-c-leary:master' into issue-1316 2024-11-27 14:02:51 +00:00
Jukka Hertzog 01655570d9
Merge branch 'jeremiah-c-leary:master' into issue-1314 2024-11-27 14:02:50 +00:00
Jukka Hertzog 76f925721a
Merge branch 'jeremiah-c-leary:master' into issue-1295 2024-11-27 14:02:49 +00:00
Jukka Hertzog 95b00ccbb3
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-11-27 14:02:48 +00:00
Jukka Hertzog 55cc5ea26b
Merge branch 'jeremiah-c-leary:master' into issue-1335 2024-11-27 14:02:46 +00:00
Jeremiah Leary 9297b3a6cf
Issue#1339: Improving detection of attribute_name productions. (#1340) 2024-11-26 09:37:52 -06:00
Jukka Hertzog fa85f7929a
Issue#1335: Updated tests to exercise variable_011 on procedure calls. 2024-11-20 11:34:14 +00:00
Jukka Hertzog 139ec20a15
Issue#1335: Update variable_011 to act on association element actual parts. 2024-11-20 11:28:31 +00:00
JHertz5 d154d60afd Issue#1310: Corrected order of imports to satisfy isort. 2024-11-17 11:21:15 +00:00
JHertz5 83570fbc80 Issue#1310: Cleaned up consistent subprogram parameter case. 2024-11-17 11:10:13 +00:00
JHertz5 0f1aed3679 Issue#1310: Update tests for procedure_509. 2024-11-17 10:51:00 +00:00
JHertz5 c38ed5c8e8 Issue#1310: Updated consistent subprogram parameter case to modify only certain tokens
(i.e. ignoring tokens like procedure names that are allowed to overlap with formal parameter names).
2024-11-17 10:50:41 +00:00
Jukka Hertzog 1a74c50405
Merge branch 'jeremiah-c-leary:master' into issue-1314 2024-11-17 03:10:45 +00:00
Jukka Hertzog 271e10999d
Merge branch 'jeremiah-c-leary:master' into issue-1295 2024-11-17 03:10:45 +00:00
Jukka Hertzog 1ae546de3f
Merge branch 'jeremiah-c-leary:master' into issue-1316 2024-11-17 03:10:44 +00:00
Jukka Hertzog cff0ade241
Merge branch 'jeremiah-c-leary:master' into issue-1320 2024-11-17 03:10:43 +00:00
Jukka Hertzog 126f379f76
Merge branch 'jeremiah-c-leary:master' into issue-1322 2024-11-17 03:10:42 +00:00
Jukka Hertzog ea087727de
Merge branch 'jeremiah-c-leary:master' into issue-1325 2024-11-17 03:10:41 +00:00
Jukka Hertzog 9f7421b5d7
Merge branch 'jeremiah-c-leary:master' into issue-1324 2024-11-17 03:10:40 +00:00
Jukka Hertzog 3e409c0a3f
Merge branch 'jeremiah-c-leary:master' into issue-1323 2024-11-17 03:10:39 +00:00
Jukka Hertzog b2352f828b
Merge branch 'jeremiah-c-leary:master' into issue-1330 2024-11-17 03:10:38 +00:00
Jukka Hertzog 5a3e99018c
Merge branch 'jeremiah-c-leary:master' into issue-1319 2024-11-17 03:10:37 +00:00
Jukka Hertzog 2e13987b40
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-11-17 03:10:36 +00:00
Jukka Hertzog 2026109773
Merge branch 'jeremiah-c-leary:master' into issue-1300 2024-11-17 03:10:34 +00:00
Jukka Hertzog 491c20c778
Merge branch 'jeremiah-c-leary:master' into issue-1291 2024-11-17 03:10:34 +00:00
Jukka Hertzog fa4b475d5d
Merge branch 'jeremiah-c-leary:master' into issue-1302 2024-11-17 03:10:32 +00:00
Jukka Hertzog c3733c4fe6
Merge branch 'jeremiah-c-leary:master' into issue-1297 2024-11-17 03:10:31 +00:00
Jukka Hertzog 0bf29f942e
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-11-17 03:10:30 +00:00
Jukka Hertzog f03f8ac60d
Merge branch 'jeremiah-c-leary:master' into issue-1287 2024-11-17 03:09:33 +00:00
JHertz5 26f49bfadb Issue#1310: Update tests for function_508. 2024-11-17 03:07:50 +00:00
Jukka Hertzog 3b6d443df9
Issue#1248: Added function_specification open_parenthesis to indent_config.yaml. (#1307) 2024-11-16 20:40:11 -06:00
JHertz5 ccddd6d06f Merge remote-tracking branch 'origin/master' into issue-1287 2024-11-17 02:16:12 +00:00
Jukka Hertzog 5d8e91f0eb
Merge branch 'jeremiah-c-leary:master' into issue-1297 2024-11-17 02:08:48 +00:00
Jukka Hertzog 887c6d2287
Merge branch 'jeremiah-c-leary:master' into issue-1302 2024-11-17 02:08:46 +00:00
Jukka Hertzog 736cf92ae7
Merge branch 'jeremiah-c-leary:master' into issue-1291 2024-11-17 02:08:42 +00:00
Jukka Hertzog 7665561650
Merge branch 'jeremiah-c-leary:master' into issue-1300 2024-11-17 02:08:40 +00:00
Jukka Hertzog b3baeb1d9f
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-11-17 02:08:22 +00:00
Jukka Hertzog 861314fb73
Merge branch 'jeremiah-c-leary:master' into issue-1319 2024-11-17 02:07:29 +00:00
Jukka Hertzog 70685983f4
Merge branch 'jeremiah-c-leary:master' into issue-1330 2024-11-17 02:07:28 +00:00
Jukka Hertzog c1ccfd519f
Merge branch 'jeremiah-c-leary:master' into issue-1324 2024-11-17 02:07:27 +00:00
Jukka Hertzog 432af58d71
Merge branch 'jeremiah-c-leary:master' into issue-1323 2024-11-17 02:07:27 +00:00
Jukka Hertzog 71cf2137bb
Merge branch 'jeremiah-c-leary:master' into issue-1325 2024-11-17 02:07:26 +00:00
Jukka Hertzog 5a8a7ceedf
Merge branch 'jeremiah-c-leary:master' into issue-1322 2024-11-17 02:07:25 +00:00
Jukka Hertzog 519c9cacb8
Merge branch 'jeremiah-c-leary:master' into issue-1320 2024-11-17 02:07:24 +00:00
Jukka Hertzog 1b73b76996
Merge branch 'jeremiah-c-leary:master' into issue-1316 2024-11-17 02:07:23 +00:00
Jukka Hertzog 908a3ae698
Merge branch 'jeremiah-c-leary:master' into issue-1314 2024-11-17 02:07:22 +00:00
Jukka Hertzog d894927dfa
Merge branch 'jeremiah-c-leary:master' into issue-1295 2024-11-17 02:07:21 +00:00
Jukka Hertzog 58ef3854b4
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-11-17 02:07:03 +00:00
Jukka Hertzog 4ab01fe454
Issue#1288: Added indent rules for protected type declarations and bodies (#1294)
* Issue#1285: Added case rules for protected type declarations.

* Issue#1285: Added case rules for protected type body declarations.

* Issue#1285: Correction in protected_type_502

* Issue#1285: Added protected_type and protected_type_body to top-level rules object

* Issue#1285: Added tests for protected_type rules

* Issue#1285: Whitespace changes in test cases.

* Issue#1285: Updated protected_type tests.

* Issue#1285: Added tests for protected_type_body rules

* Issue#1285: Updated documentation for protected_type and protected_type_body rules.

* Issue#1288: Some corrections in next statement test names

* Issue#1288: Added rule protected_type_300.

* Issue#1288: Added tests for rule protected_type_300.

* Issue#1288: Added rule protected_type_body_300.

* Issue#1288: Added tests for rule protected_type_body_300.

* Issue#1288: Updated documentation.

* Issue#1288: Corrected test cases
2024-11-16 19:24:43 -06:00
Jukka Hertzog 1f3502431f
Issue#1283: Split indent rules to treat labels separately from keywords (#1292)
* Issue#1283: Added rule case_300

* Issue#1283: Added tests for rule case_300

* Issue#1283: Added rule next_301.

* Issue#1283: Added tests for rule next_301.

* Issue#1283: Removed label checking from rule next_300.

* Issue#1283: Updated tests for rule next_300.

* Issue#1283: Indentation correction.

* Issue#1283: Added rule exit_301.

* Issue#1283: Added tests for rule exit_301.

* Issue#1283: Removed label checking from rule exit_300.

* Issue#1283: Updated tests for rule exit_300.

* Issue#1283: Added rule null_301.

* Issue#1283: Removed label checking from rule null_300.

* Issue#1283: Added tests for rule null_301.

* Issue#1283: Updated tests for rule null_statement_300.

* Issue#1283: Added rule wait_300.

* Issue#1283: Removed label checking from rule wait_001.

* Issue#1283: Added tests for rule wait_300.

* Issue#1283: Updated docs.

* Issue#1283: Update indent_rule_group.rst to remove deprecated rule
2024-11-16 19:19:30 -06:00
Jukka Hertzog 6845559968
Issue#1279: Added case rule for `others` keyword in aggregates (#1299)
* Issue#1279: Added rule aggregate_500

* Issue#1279: Added tests for rule aggregate_500

* Issue#1279: Added documentation for rule aggregate_500

* Issue#1279: Minor rewording in docstring.
2024-11-16 19:10:10 -06:00
JHertz5 ff578d238b Issue#1310: Corrected consistent subprogram parameter case.
It still needs cleanup, but it works much more correctly now.
2024-11-16 18:08:51 +00:00
JHertz5 45a457e7ef Issue#1319: Slight improvement to test for rule generic_map_600. 2024-11-15 14:32:03 +00:00
JHertz5 b0da9824ea Issue#1319: Updated test for rule generic_map_601 to test generic maps other than those in component instantiations. 2024-11-15 14:31:47 +00:00
JHertz5 5c43dff008 Issue#1319: Updated test for rule generic_map_600 to test generic maps other than those in component instantiations. 2024-11-15 14:27:57 +00:00
JHertz5 3654adcf9a Issue#1319: Updated test for rule generic_map_100 to test generic maps other than those in component instantiations. 2024-11-15 14:23:14 +00:00
JHertz5 3c4c94d042 Issue#1319: Removed double newlines in test files. 2024-11-15 14:18:40 +00:00
JHertz5 f82bf23e0d Issue#1319: Updated test for rule generic_map_008 to test generic maps other than those in component instantiations. 2024-11-15 14:17:35 +00:00
JHertz5 0726be155c Issue#1319: Updated test for rule generic_map_007 to test generic maps other than those in component instantiations. 2024-11-15 14:15:20 +00:00
JHertz5 51948244ec Issue#1319: Removed double newlines in test files. 2024-11-15 14:12:29 +00:00
JHertz5 6e0b092b17 Issue#1319: Updated test for rule generic_map_006 to test generic maps other than those in component instantiations. 2024-11-15 14:07:53 +00:00
JHertz5 97c5317256 Issue#1319: Updated test for rule generic_map_005 to test generic maps other than those in component instantiations. 2024-11-15 13:58:32 +00:00
JHertz5 3b3c1a0372 Issue#1319: Updated test for rule generic_map_004 to test generic maps other than those in component instantiations. 2024-11-15 13:51:04 +00:00
JHertz5 cca23e5a9b Issue#1319: Updated test for rule generic_map_003 to test generic maps other than those in component instantiations. 2024-11-15 13:42:04 +00:00
Jukka Hertzog fed929521a
Issue#1319: Formatting correction. 2024-11-14 14:52:46 +00:00
Jukka Hertzog 0d2c1c4945
Issue#1319: Updated tests for generic_map_002
Test are now exercising all instances of generic maps.
2024-11-14 14:41:38 +00:00
Jukka Hertzog 9745609d32
Issue#1319: Updated generic_map_002 to work on all instances of generic maps. 2024-11-14 14:40:16 +00:00
Jukka Hertzog 784913ce4a
Issue#1319: Update generic_map_001 test to test all instances of generic map. 2024-11-14 14:30:09 +00:00
Jukka Hertzog aa63662ecd
Issue#1319: Update generic_map_001 test to test all instances of generic map. 2024-11-14 14:25:58 +00:00
Jukka Hertzog b7ec85062e
Issue#1319: Update generic_map_001 test to test all instances of generic map. 2024-11-14 14:25:36 +00:00
Jukka Hertzog c683aff494
Issue#1319: Update generic_map_001 test to test all instances of generic map. 2024-11-14 14:24:13 +00:00
Jukka Hertzog 8d27c94439
Issue#1319: Update generic_map_001 to work on all instances of `generic map` 2024-11-14 14:22:44 +00:00
Jukka Hertzog 70e95863ea
Issue#1330: Removed unused line from rule_600.py 2024-11-14 11:13:24 +00:00
Jukka Hertzog fe4d57d4e4
Issue#1330: Removed unused line from rule_601.py 2024-11-14 11:12:53 +00:00
Jukka Hertzog 10839d7c10
Issue#1330: Updated formatting in rule_600.py 2024-11-14 11:11:25 +00:00
Jukka Hertzog 38115813ac
Issue#1330: Update configuring_prefix_and_suffix_rules.rst 2024-11-14 11:05:15 +00:00
Jukka Hertzog 168501d64f
Issue#1330: Update unfixable_rules.rst 2024-11-14 11:02:56 +00:00
Jukka Hertzog f476959d48
Isue#1330 Update configuring_disabled_rules.rst 2024-11-14 11:01:51 +00:00
Jukka Hertzog d508e775f5
Issue#1330 Update naming_rule_group.rst 2024-11-14 11:00:40 +00:00
Jukka Hertzog 7bdfa76670
Issue#1330 Updated package_instantiation_rules.rst 2024-11-14 10:59:05 +00:00
Jukka Hertzog 27051dd201
Issue#1330 Added tests for new package instantiation naming rules. 2024-11-14 10:57:32 +00:00
Jukka Hertzog b820d1f914
#1330: Update __init__.py in package_instantiation. 2024-11-14 10:56:42 +00:00
Jukka Hertzog c6a090e40f
Issue#1330 Added rules for naming in package instantiations. 2024-11-14 10:55:39 +00:00
JHertz5 7438867a84 Issue#1324: Rearranged imports. 2024-11-13 22:51:01 +00:00
JHertz5 2efbd76d49 Issue#1323: Rearranged imports. 2024-11-13 22:50:13 +00:00
JHertz5 14e296c182 Issue#1325: Added documentation for whitespace in package instantiations. 2024-11-13 22:47:27 +00:00
JHertz5 9a299bb9a7 Issue#1325: Added tests for whitespace in package instantiations. 2024-11-13 22:45:43 +00:00
JHertz5 5badda131e Issue#1325: Added rules for whitespace in package instantiations. 2024-11-13 22:37:48 +00:00
JHertz5 f3639c3952 Issue#1324: Formatting changes. 2024-11-13 22:29:15 +00:00
JHertz5 2c1abde135 Issue#1324: Added documentation for rule package_instantiation_201. 2024-11-13 22:27:15 +00:00
JHertz5 cceef5eb8f Issue#1324: Added tests for rule package_instantiation_201. 2024-11-13 22:25:54 +00:00
JHertz5 0322c3cd70 Issue#1324: Added rule package_instantiation_201. 2024-11-13 22:25:45 +00:00
JHertz5 c4105ccf9b Issue#1323: Minor refactoring in rule. 2024-11-13 22:25:12 +00:00
JHertz5 b79b4e1c9d Issue#1324: Added documentation for structure rules for package instantiations. 2024-11-13 21:51:31 +00:00
JHertz5 4ab90204ce Issue#1324: Added tests for structure rules for package instantiations. 2024-11-13 21:49:53 +00:00
JHertz5 f7846d9f41 Issue#1324: Added structure rule for package instantiations. 2024-11-13 21:48:34 +00:00
JHertz5 54c24f89bf Issue#1323: Updated test_indent. 2024-11-13 19:49:38 +00:00
JHertz5 421e320d30 Issue#1323: Fixed excess newlines at end of file. 2024-11-13 19:48:09 +00:00
JHertz5 ae7d0558e7 Issue#1323: Added documentation for blank line and indent rules for package instantiations. 2024-11-13 19:34:56 +00:00
JHertz5 bce8204174 Issue#1323: Added tests for indent rule for package instantiations. 2024-11-13 19:32:28 +00:00
JHertz5 aad4541901 Issue#1323: Updated indent_config.yaml for package_instantiation_declaration tokens. 2024-11-13 19:28:36 +00:00
JHertz5 5f4755cabd Issue#1323: Added tests for blank line rules for package instantiations. 2024-11-13 19:23:52 +00:00
JHertz5 463f31ec23 Issue#1323: Added blank line and indent rules for package instantiations. 2024-11-13 19:22:37 +00:00
JHertz5 5b641012e3 Issue#1322: Added documentation for case rules for package instantiations. 2024-11-13 19:06:39 +00:00
JHertz5 510d158070 Issue#1322: Added tests for case rules for package instantiations. 2024-11-13 19:02:12 +00:00
JHertz5 d8b50f1213 Issue#1322: Added case rules for package instantiations. 2024-11-13 19:02:04 +00:00
JHertz5 7f41409e9b Issue#1320: Removed accidental characters. 2024-11-13 10:55:20 +00:00
JHertz5 702677f922 Issue#1320: Updated documentation for new rules. 2024-11-13 10:50:46 +00:00
JHertz5 99123642ff Issue#1320: Added subphase adjustment to rule port_map_003. 2024-11-13 10:48:11 +00:00
JHertz5 c5c673b37f Issue#1320: Added tests for rules port_map_011 and generic_map_101. 2024-11-13 10:47:55 +00:00
JHertz5 a0cb01d30f Issue#1320: Added rules port_map_011 and generic_map_101. 2024-11-13 10:47:39 +00:00
JHertz5 29fe733ab4 Issue#1320: Added subphase adjustment to rule generic_map_003. 2024-11-13 10:40:35 +00:00
JHertz5 d8d3d344a9 Issue#1320: Added tests for rules generic_map_009 and generic_map_101. 2024-11-13 10:40:11 +00:00
JHertz5 f2fb3a23ab Issue#1320: Added rules generic_map_009 and generic_map_101. 2024-11-13 10:39:56 +00:00
JHertz5 db484c8087 Issue#1316: Updated documentation for deprecated rule instantiation_018 2024-11-13 10:06:00 +00:00
JHertz5 7cafaf8d5f Issue#1316: Updated message for deprecated rule instantiation_018 2024-11-13 09:09:34 +00:00
JHertz5 436727359e Issue#1316: Added documentation for rule port_map_006. 2024-11-13 09:09:09 +00:00
JHertz5 c01bd75ffb Issue#1316: Added tests for rule port_map_006. 2024-11-13 09:04:30 +00:00
JHertz5 6408c99070 Issue#1316: Added rule port_map_006. 2024-11-13 09:04:23 +00:00
JHertz5 098186cb7f Issue#1316: Update tests for rule generic_map_006. 2024-11-13 09:03:42 +00:00
JHertz5 2a2b2b2782 Issue#1316: Removed port map enforcement from rule generic_map_006. 2024-11-13 09:03:26 +00:00
JHertz5 76323e9315 Issue#1314: Formatting changes. 2024-11-13 08:26:51 +00:00
JHertz5 b7a1023f5b Issue#1314: Updated tests after report format change. 2024-11-13 08:26:26 +00:00
JHertz5 2454856d76 Issue#1314: Updated report printing to dynamically update to match longest rule name. 2024-11-13 08:21:21 +00:00
Jukka Hertzog 323701af92
Issue#1295: Updated test output for variable_assignment_004.
Making sure that array assignments are ignored.
2024-11-12 15:32:56 +00:00
Jukka Hertzog a8ee388309
Issue#1295: Updated test input for variable_assignment_004.
Making sure that array assignments are ignored.
2024-11-12 15:32:09 +00:00
Jukka Hertzog bd6f5658fc
Issue#1295: Update multiline_alignment_between_tokens.py to make array assignment check include variable assignments 2024-11-12 15:11:27 +00:00
Jukka Hertzog cc2d9e9530
Merge branch 'master' into issue-1287 2024-11-11 09:51:06 +00:00
Jukka Hertzog 6e92361fd4
Issue#1232: Update classification_results.txt for port_clause 2024-11-11 09:45:27 +00:00
Jukka Hertzog f6e2bca6e4
Issue#1232: Update classification_results.txt for interface_signal_declaration 2024-11-11 09:43:42 +00:00
Jukka Hertzog 7ea9d58c1b
Issue#1232: Update classification_results.txt for `generic_clause` 2024-11-11 09:42:53 +00:00
Jukka Hertzog a03adb1cb6
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-11-11 09:38:20 +00:00
Jukka Hertzog 2457bff571
Merge branch 'jeremiah-c-leary:master' into issue-1297 2024-11-11 09:37:02 +00:00
Jukka Hertzog 9a7f3518b0
Merge branch 'jeremiah-c-leary:master' into issue-1302 2024-11-11 09:36:16 +00:00
Jukka Hertzog 18c8916325
Merge branch 'jeremiah-c-leary:master' into issue-1291 2024-11-11 09:35:41 +00:00
Jukka Hertzog 2437c247b9
Merge branch 'jeremiah-c-leary:master' into issue-1310 2024-11-11 09:35:29 +00:00
Jukka Hertzog acdbbd81cb
Issue#1285: Added case rules for protected type declarations and bodies (#1293)
* Issue#1285: Added case rules for protected type declarations.

* Issue#1285: Added case rules for protected type body declarations.

* Issue#1285: Correction in protected_type_502

* Issue#1285: Added protected_type and protected_type_body to top-level rules object

* Issue#1285: Added tests for protected_type rules

* Issue#1285: Whitespace changes in test cases.

* Issue#1285: Updated protected_type tests.

* Issue#1285: Added tests for protected_type_body rules

* Issue#1285: Updated documentation for protected_type and protected_type_body rules.
2024-11-10 20:00:22 -06:00
Jukka Hertzog 9aaa274bd1
Issue#1284: Deprecate case_013 (#1312)
* Issue#1284: Deprecated rule case_013.

* Issue#1284: Updated tests for deprecated rule case_013.

* Issue#1284: Updated documentation for deprecated rule case_013.

* Issue#1284: Added punctuation to docstring.
2024-11-10 19:07:33 -06:00
JHertz5 cf13383d7b Merge remote-tracking branch 'origin/master' into issue-1232 2024-11-10 23:19:37 +00:00
JHertz5 6c8b89bb50 Merge remote-tracking branch 'origin/master' into issue-1287 2024-11-10 23:18:28 +00:00
JHertz5 d7f0323f46 Merge remote-tracking branch 'origin/master' into issue-1297 2024-11-10 23:18:12 +00:00
JHertz5 4c3b96bbaf Merge remote-tracking branch 'origin/master' into issue-1300 2024-11-10 23:17:43 +00:00
JHertz5 0461cb1d46 Merge remote-tracking branch 'origin/master' into issue-1302 2024-11-10 23:17:16 +00:00
JHertz5 5188e6596c Merge remote-tracking branch 'origin/master' into issue-1291 2024-11-10 23:16:39 +00:00
JHertz5 caea9dddd6 Merge remote-tracking branch 'origin/master' into issue-1310 2024-11-10 23:15:48 +00:00
Jukka Hertzog 5f4725dba1
Issue#1281: Typo corrections (#1282) 2024-11-10 07:55:57 -06:00
Jukka Hertzog c65927224b
Issue#1304: Corrected misplaced classification tests (#1305)
* Issue#1304: Moved classification test inputs. Added interfaces to let parser not crash in clauses

* Issue#1304: Added expected results for new classification tests.

* Issue#1304: Updated port clause expected result.
2024-11-10 07:47:03 -06:00
Jukka Hertzog 571bc52927
Issue#1251: Added rules to enforce case on parameters in functions and procedures (#1254)
* Issue#1251: Added rules function_507, procedure_508, and procedure_call_502.

* Issue#1251: Updated docstrings and docs for rules function_507, procedure_508, and procedure_call_502.

* Issue#1251: Updated docstrings and docs for rule groups.

* Issue#1251: Updated docstrings and docs for rule groups.

* Issue#1251: Updated expected test output.

* Issue#1251: Updated expected test output.

* Issue#1251: Added tests for rules function_507, procedure_508, and procedure_call_502.

* Issue#1251: Added rules function_508 and procedure_509.

* Issue#1251: Updated docs for function_508 and procedure_509.

* Issue#1251: Updated rule group docs for function_508 and procedure_509.

* Issue#1251: Minor consistency improvement.

* Issue#1251: Removed unused imports.

* Issue#1251: Corrected rules function_507 and procedure_508 to act on interface file declarations

* Issue#1251: Improved tests for function_507 and procedure_508

* Issue#1251: Updated get_function_subprogram_body and get_procedure_subprogram_body to handle nested declarations

* Issue#1251: Updates to consistent_subprogram_parameter_token_case. Still doesn't exclude nested regions unfortunately, but at least handles them perhaps satisfactorily.

* Issue#1251: Added tests for function_508 and procedure_509.

* Issue#1251: Removed unused code.

* Issue#1251: Formatting

* Issue#1251: Updated style tests.

* Issue#1251: Cleanup in consistent_subprogram_parameter_token_case

* Issue#1251: Fixed crash in case of subprogram with no interfaces.

* Issue#1251: Updated test file to exercise corner case

* Issue#1251: Updated test file to exercise corner case

* Issue#1251: Updated test file to exercise corner case

* Issue#1251: Updated test file to exercise corner case

* Issue#1251: Removed consistent case changes, to be split into a different PR.
2024-11-10 07:36:31 -06:00
JHertz5 61d74dbe83 Merge remote-tracking branch 'origin/master' into issue-1251 2024-11-10 01:51:11 +00:00
JHertz5 3377576ae3 Merge remote-tracking branch 'origin/master' into issue-1300 2024-11-10 01:49:44 +00:00
JHertz5 b81c1cea83 Merge remote-tracking branch 'origin/master' into issue-1291 2024-11-10 01:49:18 +00:00
JHertz5 13292b3157 Merge remote-tracking branch 'origin/master' into issue-1287 2024-11-10 01:48:40 +00:00
JHertz5 ea8623d9b3 Merge remote-tracking branch 'origin/master' into issue-1302 2024-11-10 01:48:25 +00:00
JHertz5 2576c48602 Merge remote-tracking branch 'origin/master' into issue-1297 2024-11-10 01:47:29 +00:00
JHertz5 ace0f048e0 Merge remote-tracking branch 'origin/master' into issue-1232 2024-11-10 01:45:56 +00:00
Jukka Hertzog 83bfcfd9d3
Issue#1267: Updated rule return_statement_300 to handle label alignment (#1268)
* Issue#1267: Updated rule return_statement_300 to handle label alignment

* Issue#1267: Removed extra newline from indent_config.yaml

* Issue#1267: Split return label rule out to return_statement_301.

* Issue#1267: Reverted return_statement_300 tests.

* Issue#1267: Added tests for return_statement_301.

* Issue#1267: Added documentation for return_statement_301.
2024-11-09 14:18:19 -06:00
Jukka Hertzog 44544d3060
Issue#1253: Added rule to enforce case of `pure` and `impure` keywords. (#1259)
* Issue#1253: Added rule function_510.

* Issue#1253: Added tests for rule function_510.

* Issue#1253: Updated documentation for rule function_510.

* Issue#1253: Updated documentation for rule function_510.

* Issue#1253: Changed rule function_510 to function_509 to avoid conflict with other in-progress branches.

* Issue#1253: Updated test script.

* Issue#1253: Adjusted whitespace in test files for consistency with other tests.

* Issue#1253: Split rules to act on pure and impure separately.
2024-11-09 14:14:49 -06:00
Jukka Hertzog 980b7cfc74
Issue#1228: Added subtype rules to match type rules (#1229)
* Issue#1228: Added rules subtype_005 and subtype_006.

* Issue#1228: Added test for rule subtype_005.

* Issue#1228: Added test for rule subtype_006.

* Issue#1228: Added rules subtype_007 and subtype_008.

* Issue#1228: Added tests for rules subtype_007 and subtype_008.

* Issue#1228: Added rules subtype_009 and subtype_010.

* Issue#1228: Added tests for rules subtype_009 and subtype_010.

* Issue#1228: Added rule subtype_200.

* Issue#1228: Fixed rule subtype_200.
Removed duplicates from lTokens and lAllowTokens.
Updated code example to avoid duplicate definitions.

* Issue#1228: Added tests for rule subtype_200.

* Issue#1228: Corrections/improvements to new rule docstrings.

* Issue#1228: Reworked rule numbers to reflect execution phases.

* Issue#1228: Updated rule documentation.

* Issue#1228: Updated documentation.

* Issue#1228: Updated rule subtype_102 to include resolution functions.

* Issue#1228: Simplified subtype_102 by using whitespace_after_token instead of whitespace_between_token_pairs.

* Issue#1228: Simplified subtype_101 by using whitespace_before_token instead of whitespace_between_token_pairs.

* Issue#1228: Corrected order of init imports for subtypes.

* Issue#1228: Corrected order of init imports for subtypes.
2024-11-09 14:07:20 -06:00
Jukka Hertzog 51555b3c1e
Issue#1251: Updated test file to exercise corner case 2024-11-05 14:47:44 +00:00
Jukka Hertzog 66e767c6de
Issue#1251: Updated test file to exercise corner case 2024-11-05 14:47:16 +00:00
Jukka Hertzog 2958d5fd15
Issue#1251: Updated test file to exercise corner case 2024-11-05 14:46:52 +00:00
Jukka Hertzog 1455a0839e
Issue#1251: Updated test file to exercise corner case 2024-11-05 14:46:02 +00:00
Jukka Hertzog b8e77e794a
Issue#1251: Fixed crash in case of subprogram with no interfaces. 2024-11-05 14:32:55 +00:00
Jukka Hertzog 1ca9579751
Issue#1300: Corrected misleading function name
Changed "both" to "either" to avoid the implication that a token can be simultaneously unary and binary.
2024-11-01 10:31:36 +00:00
JHertz5 ce72851a7d Issue#1291: Code cleanliness improvement. 2024-11-01 10:20:53 +00:00
JHertz5 d01c2f4d6b Issue#1291: Updated variable_400 tests to exercise initialisations. 2024-11-01 10:10:10 +00:00
JHertz5 51bd0ed53e Issue#1291: Updated signal_400 tests to exercise initialisations. 2024-11-01 10:03:37 +00:00
JHertz5 8f174c24cf Issue#1291: Correction to indentation when bIgnoreStartParen is enabled in _analyze_align_left_no_align_paren_yes. 2024-11-01 09:44:43 +00:00
JHertz5 b612e751a9 Issue#1302: Added test for classification of shift operators 2024-10-29 20:56:05 +00:00
JHertz5 184fd5dbd2 Issue#1302: Added parsing of shift operators 2024-10-29 20:46:59 +00:00
JHertz5 7db106450f Issue#1300: Removed unused or commented-out code. 2024-10-29 20:31:48 +00:00
JHertz5 600222bccb Issue#1300: Reducing number of if clauses with identical contents 2024-10-29 20:26:56 +00:00
JHertz5 37c65992de Issue#1300: Formatting, cleaned up TODO note 2024-10-29 20:22:06 +00:00
JHertz5 a5019fea30 Issue#1300: Breaking out code to simplify it 2024-10-29 20:21:37 +00:00
JHertz5 9008efef76 Issue#1300: Removed unused code. 2024-10-29 20:17:01 +00:00
JHertz5 82e4bd6a3c Issue#1300: Moved common code to top level of elif tree 2024-10-29 20:12:59 +00:00
JHertz5 2d55be2182 Issue#1300: Cleaned up assignment of parser todo token types 2024-10-29 20:05:57 +00:00
JHertz5 d2147a10a0 Issue#1300: Removed unused code. 2024-10-29 20:05:22 +00:00
JHertz5 71d68d2de1 Issue#1300: Removed commented-out code. 2024-10-29 19:51:29 +00:00
JHertz5 11a87c2cd3 Issue#1300: Cleaned up assignment of binary/unary operators 2024-10-29 19:51:13 +00:00
JHertz5 423ff996d3 Issue#1300: Cleaned up assignment of IEEE token types 2024-10-29 19:50:21 +00:00
JHertz5 f8812924e6 Issue#1297: Updated docs 2024-10-24 22:13:53 +01:00
JHertz5 7c82a55e19 Issue#1297: Updated docstrings 2024-10-24 22:13:45 +01:00
JHertz5 e40969ca7c Issue#1287: Style 2024-10-24 22:05:33 +01:00
JHertz5 5ca74da98e Issue#1287: Added documentation for alignment rules for protected type body 2024-10-24 21:57:39 +01:00
JHertz5 28d3232481 Issue#1287: Updated style test 2024-10-24 21:52:23 +01:00
JHertz5 450076c06d Issue#1287: Added tests for alignment rules for protected type body 2024-10-24 21:51:02 +01:00
JHertz5 08c1b4049e Issue#1287: Added alignment rules for protected type body 2024-10-24 21:50:46 +01:00
JHertz5 54ac5297af Merge remote-tracking branch 'origin/issue-1285' into issue-1287 2024-10-24 21:20:28 +01:00
JHertz5 dfc8059425 Issue#1287: Updated tests for process rules 2024-10-24 21:14:52 +01:00
JHertz5 f861d9b4e2 Issue#1287: Updated tests for procedure rules 2024-10-24 19:53:28 +01:00
JHertz5 521c856d3f Issue#1287: Updated tests for package body rules 2024-10-24 19:51:47 +01:00
JHertz5 a3b70c9138 Issue#1287: Updated tests for function rules 2024-10-24 19:42:20 +01:00
JHertz5 61316475c8 Issue#1287: Updated tests for block rules 2024-10-24 19:35:55 +01:00
JHertz5 a00db0f6d8 Issue#1287: Updated tests for architecture rules 2024-10-24 19:32:23 +01:00
JHertz5 11a4e3e80b Issue#1287: Added protected type body as exclusion zone for alignment rules within declarative regions (where relevant). 2024-10-24 19:31:53 +01:00
Jukka Hertzog 18ea00c551
Issue#1251: Cleanup in consistent_subprogram_parameter_token_case 2024-10-24 09:55:21 +01:00
JHertz5 311f2ccb42 Issue#1251: Updated style tests. 2024-10-24 08:11:49 +01:00
JHertz5 2ba7e810eb Issue#1251: Formatting 2024-10-24 08:09:52 +01:00
JHertz5 0e5ab59ba9 Issue#1251: Removed unused code. 2024-10-24 07:57:38 +01:00
JHertz5 d6dee6d00c Merge remote-tracking branch 'origin/master' into issue-1251 2024-10-24 07:55:44 +01:00
JHertz5 4ecab3411f Issue#1251: Added tests for function_508 and procedure_509. 2024-10-24 07:52:49 +01:00
JHertz5 fe0e6ce82f Issue#1251: Updates to consistent_subprogram_parameter_token_case. Still doesn't exclude nested regions unfortunately, but at least handles them perhaps satisfactorily. 2024-10-24 07:45:31 +01:00
JHertz5 de4d298420 Issue#1251: Updated get_function_subprogram_body and get_procedure_subprogram_body to handle nested declarations 2024-10-23 20:04:52 +01:00
JHertz5 090120c733 Issue#1251: Improved tests for function_507 and procedure_508 2024-10-23 20:03:56 +01:00
JHertz5 6c95d45ba7 Issue#1251: Corrected rules function_507 and procedure_508 to act on interface file declarations 2024-10-23 18:59:50 +01:00
JHertz5 157926c19a Issue#1285: Updated documentation for protected_type and protected_type_body rules. 2024-10-22 22:59:02 +01:00
JHertz5 f313504306 Issue#1285: Added tests for protected_type_body rules 2024-10-22 22:55:18 +01:00
JHertz5 e17a72c797 Issue#1285: Updated protected_type tests. 2024-10-22 22:55:07 +01:00
JHertz5 218e4bbbcc Issue#1285: Whitespace changes in test cases. 2024-10-22 22:49:39 +01:00
JHertz5 61470c0a67 Issue#1285: Added tests for protected_type rules 2024-10-22 22:42:11 +01:00
JHertz5 0b2e3cf3db Issue#1285: Added protected_type and protected_type_body to top-level rules object 2024-10-22 22:41:55 +01:00
JHertz5 7afd4e05f8 Issue#1285: Correction in protected_type_502 2024-10-22 22:41:25 +01:00
JHertz5 c91f6eefe4 Issue#1285: Added case rules for protected type body declarations. 2024-10-22 22:25:04 +01:00
JHertz5 7807bdf865 Issue#1285: Added case rules for protected type declarations. 2024-10-22 22:24:42 +01:00
Jeremiah Leary dd64777650 Fixing tox style errors. 2024-10-20 18:35:25 -05:00
Jeremiah Leary 5ca843011c Adding vhdl productions speadsheet. 2024-10-20 18:26:07 -05:00
JHertz5 c14c303097
Issue#1277: Rule for enforcing case on `others` in case statements. (#1278)
* Issue#1277: Added rule case_500.

* Issue#1277: Added tests for rule case_500.

* Issue#1277: Added documentation for rule case_500.
2024-10-20 17:32:01 -05:00
JHertz5 2c60191df3
Issue#1252: Rules for enforcing case on function and procedure parameter directions (#1260)
* Issue#1252: Added rules function_509 and procedure_510.

* Issue#1252: Changed rule function_509 to function_510.

* Issue#1252: Added tests for rules function_509 and procedure_510.

* Issue#1252: Updated documentation for rules function_510 and procedure_510.
2024-10-20 17:07:07 -05:00
JHertz5 6a58dfc469
Issue#1256: Updated PascalCase and camelCase regexes to allow a single uppercase letter at the end of the name (#1257)
* Issue#1256: Updated PascalCase and CamelCase regexes to allow a single uppercase letter at the end of the name.

* Issue#1256: Updated tests to check that PascalCase and CamelCase regexes allow a single uppercase letter at the end of the name.
2024-10-20 15:53:19 -05:00
JHertz5 150c4d6700
Issue#1263: Rules for enforcing case on parameter class in functions and parameters (#1264)
* Issue#1263: Added rules function_511 and procedure_511.

* Issue#1263: Added tests for rules function_511 and procedure_511.

* Issue#1263: Removed duplicate token in rules function_511 and procedure_511.

* Issue#1263: Updated docstring for rules function_511 and procedure_511.

* Issue#1263: Updated docs for rules function_511 and procedure_511.
2024-10-20 10:52:38 -05:00
JHertz5 44fd761232
Issue#1265: Added rules for next statements (#1266)
* Issue#1265: Added rules next_statement_300, next_statement_500 and next_statement_501.

* Issue#1265: Added tests for rules next_statement_300, next_statement_500 and next_statement_501.

* Issue#1265: Added docs for rules next_statement_300, next_statement_500 and next_statement_501.

* Issue#1265: Update rule next_statement_300 to handle label alignment as well.

* Issue#1265: Updated indent rule group test.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2024-10-20 10:31:58 -05:00
JHertz5 3d3835a08d
Issue#1275: Added rules for library names in entity instantiations (#1276)
* Issue#1275: Added rule instantiation_500.

* Issue#1275: Added tests for rule instantiation_500.

* Issue#1275: Added documentation for rule instantiation_500.

* Issue#1275: Reverted IEEE rule doc change.

* Issue#1275: Removed excess newline in docstring/documentation.
2024-10-20 10:31:19 -05:00
JHertz5 afb9a1d56e
Issue#1269: Rule to enforce case on exit statements (#1270)
* Issue#1269: Added rules exit_statement_300, exit_statement_500 and exit_statement_501.

* Issue#1269: Added tests for rules exit_statement_300, exit_statement_500 and exit_statement_501.

* Issue#1269: Added docs for rules exit_statement_500 and exit_statement_501.
2024-10-20 10:11:50 -05:00
JHertz5 78c4c5deb6
Issue#1261: Rules for enforcing case in wait statements (#1262)
* Issue#1261: Added rules wait_500, wait_501, wait_502 and wait_503.

* Issue#1261: Added tests for rules wait_500, wait_501, wait_502 and wait_503.

* Issue#1261: Added documentation for rules wait_500, wait_501, wait_502 and wait_503.
2024-10-20 09:47:20 -05:00
JHertz5 d57c9c186b
Issue#1273: Added rules to enforce `in` keywords in for loops/generates (#1274)
* Issue#1273: Added rules for_generate_statement_502 and iteration_scheme_502.

* Issue#1273: Added tests for rules for_generate_statement_502 and iteration_scheme_502.

* Issue#1273: Added documentation for rules for_generate_statement_502 and iteration_scheme_502.
2024-10-20 09:03:37 -05:00
JHertz5 32ff55eb6a
Issue#1271: Added rules for null statements (#1272)
* Issue#1271: Added rules null_statement_300 and null_statement_500.

* Issue#1271: Added tests for rules null_statement_300 and null_statement_500.

* Issue#1271: Added documentation for rules null_statement_300 and null_statement_500.
2024-10-19 11:02:15 -05:00
JHertz5 96267d9b28 Issue#1251: Removed unused imports. 2024-10-16 22:25:58 +01:00
JHertz5 115b42bfdd Issue#1251: Minor consistency improvement. 2024-10-16 22:25:08 +01:00
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 8a02d1c16d Issue#1251: Added rules function_508 and procedure_509. 2024-10-16 19:33:16 +01:00
JHertz5 8a48538282 Issue#1251: Added tests for rules function_507, procedure_508, and procedure_call_502. 2024-10-16 12:37:10 +01:00
JHertz5 1910aedfac Issue#1251: Updated expected test output. 2024-10-15 22:18:09 +01:00
JHertz5 8e92eec62b Issue#1251: Updated expected test output. 2024-10-15 21:02:20 +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
JHertz5 484e859c4a Issue#1251: Added rules function_507, procedure_508, and procedure_call_502. 2024-10-15 19:44:35 +01:00
JHertz5 5cd819455b Issue#1232: Updated classification results. 2024-10-15 11:42:59 +01:00
JHertz5 deebeeca7f
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-10-15 10:54:33 +01:00
Jeremiah Leary db548fdbdb
Issue#1245: Fixing documentation issue around regex. (#1246) 2024-10-14 20:47:44 -05:00
JHertz5 33a2ae7559
Issue#1241: Reduced duplication in token classification tests (#1242)
* Issue#1241: Added meta test that tests all token classifications available.

* Issue#1241: Added classification result for resolution indications.

* Issue#1241: Removed now-redundant test files.

* Issue#1241: Formatting update.

* Issue#1236: Improved LRM name list acquisition.

* Issue#1241: Updated class names for consistency.

* Issue#1241: Improved safety of automated test name generation.

* Issue#1241: Simplified function name.

* Issue#1241: Duplication reduction.

* Issue#1241: Efficiency improvement.

* Issue#1241: Refactored code to be more clean by using pathlib's features.

* Issue#1241: Formatting.

* Issue#1241: Delete tests/vhdlFile/test_bit_string_literal.py, which now duplicates test_token.py.
2024-10-13 18:54:13 -05:00
JHertz5 124be04fec
Issue#1243: Fixed external names parsing bug (#1244)
* Issue#1243: Updated external name classification_test_input.vhd to expose bug.

* Issue#1243: Updated classification_results.txt to match desired output

* Issue#1243: Updated external_signal_name.py to fix bug.

* Issue#1243: Updated external_variable_name.py to fix bug.

* Issue#1243: Updated external_constant_name.py to fix bug.

* Issue#1243: Fixed external_variable_name.py.

* Issue#1243: Minor simplification in external name classification

* Issue#1243: Minor simplification in external name classification

* Issue#1243: Minor simplification in external name classification
2024-10-13 08:45:43 -05:00
JHertz5 b533014112
Issue#1232: Update classification_results.txt for bit_string_literal 2024-10-08 10:01:30 +01:00
JHertz5 4e6fe08b5c
Merge branch 'jeremiah-c-leary:master' into issue-1232 2024-10-08 09:51:57 +01: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
Lars Henrik Bolstad 1238218b16 Minor improvements in documentation
* Git Hub / git hub -> GitHub
* sored -> stored
* Remove dead link to setting_up_a_development_environment (removed in a980504671)
2024-10-05 17:56:25 +02:00
JHertz5 a4f1feed43 Issue#1232: Updated classification results for test_external_name. 2024-10-03 21:55:31 +01:00
JHertz5 6f0c8f3a49 Revert "Issue#1232: Updated classification results for test_external_name."
This reverts commit daf3449fd5.
2024-10-03 21:54:37 +01:00
JHertz5 daf3449fd5 Issue#1232: Updated classification results for test_external_name. 2024-10-03 21:44:07 +01:00
JHertz5 c8c7e328ee Merge remote-tracking branch 'origin/master' into issue-1232 2024-10-03 21:40:45 +01:00
JHertz5 392fcfee8a Issue#1232: Docstring update for type_mark_500. 2024-10-03 21:30:35 +01:00
JHertz5 5d958d8f5c Issue#1232: Formatted typ_mark_500 test. 2024-10-03 20:52:10 +01: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
JHertz5 8aba40092e Issue#1232: Removed trailing newline from type_mark_500 docstring and documentation. 2024-09-28 19:06:29 +01:00
JHertz5 7bf9202af5 Issue#1232: Updated documentation for rules type_014 and subtype_002 being disabled by default to avoid conflicts with type_mark_500. 2024-09-28 18:58:45 +01:00
JHertz5 4bda683e74 Issue#1232: Set rules type_014 and subtype_002 to be disabled by default to avoid conflicts with type_mark_500. 2024-09-28 18:58:23 +01:00
JHertz5 3c3497d9ce Issue#1232: Updated classification results where parser can no longer guarantee a type_mark. 2024-09-28 18:47:46 +01:00
JHertz5 bcff28c425 Issue#1232: Updated style test results. 2024-09-28 17:57:26 +01:00
JHertz5 c7939bf0e5 Issue#1232: Updated classification results. 2024-09-28 17:45:16 +01:00
JHertz5 34c8ae049d Issue#1232: Added missing __init__ files to overcome testing problem. 2024-09-28 17:39:33 +01:00
JHertz5 4066052ad5 Issue#1232: Documentation and docstring updates. 2024-09-28 17:39:11 +01:00
JHertz5 e9a357eac4 Issue#1232: Updated rule_group docs. 2024-09-28 17:29:53 +01:00
JHertz5 db426a5778 Issue#1232: Updated rule_group tests. 2024-09-28 17:27:18 +01:00
JHertz5 0113cf240f Issue#1232: Added rule docs for rule type_mark_500. 2024-09-28 14:48:35 +01:00
JHertz5 42a3198358 :Merge remote-tracking branch 'origin/master' into issue-1232 2024-09-28 14:46:58 +01:00
JHertz5 ea91048a8a Issue#1232: Added test for rule type_mark_500. 2024-09-28 14:43:19 +01:00
JHertz5 8e425b4591 Issue#1232: Added rule type_mark_500 2024-09-28 13:57:12 +01:00
JHertz5 973279f32d Issue#1232: Removed parsing for ieee types. They will now be treated as normal type marks. 2024-09-28 13:56:44 +01:00
JHertz5 a25622001c Issue#1232: Deprecated rule ieee_500. 2024-09-28 13:52:13 +01:00
Jeremiah Leary 7c345ebba1
Issue#1207: Fixing default values in multiline indent documentation. (#1208) 2024-09-22 20:46:58 -05:00
Alon Bar-Lev cd881588e5
vsg: print file name when ClassifyError (#1210)
In current implementation the user see something like the following when
ClassifyError is raised:

    Error: Unexpected token detected while parsing procedure_call_statement @ Line 49, Column 22 in file None
           Expecting : ;
           Found     : )

In a project that contains multiple files, the user is clueless as he does not
know which of the files caused the error.

This change adds the name of the file to the message.

    Error while processing xxx:
    Error: Unexpected token detected while parsing procedure_call_statement @ Line 49, Column 22 in file None
           Expecting : ;
           Found     : )

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-09-22 20:45:46 -05:00
JHertz5 7f51f89dce
#Issue1212: VSG crashes when encountering generate statement corner case. (#1222)
* Issue#1212: Corrected order of operations in extract_pairs to ensure that it does not return an empty list as one of the pairs.

* Issue#1212: Updated the tests to exercise failure case that raised this isssue.

* Issue#1212: Updated extract_indexes_from_pairs to strip any empty pairs from the input list.
2024-09-21 21:40:13 -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 82ee7a9f16
Issue#1223: Declared regex patterns as raw strings rather than Unicode strings to avoid interpretation as an escape sequence. (#1224) 2024-09-08 19:57:49 -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 5669062a64 Issue#1202: Adding Pascal_Snake_Case option to case rules. 2024-07-21 18:18:06 -05:00
Jeremiah Leary 0dbc78a350
Issue#1198: Adding regex option to rule port_map_002. (#1199) 2024-07-19 07:00:50 -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 5647dbcb35
Issue#911: Improving detection of unary logical operators. (#1046)
* Issue#911:  Improving detection of unary logical operators.

* Adding descriminator for keywords before unary operator.

* Fixing style issues.
2024-07-11 07:26:01 -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 ba8bfa23e8
Issue#1188: single comments with */ would be incorrectly classified and fail to parse. (#1191) 2024-07-09 20:36:59 -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 3277b965ac
Issue#1189: Adding error reporting for invalid indent configurations. (#1194)
* Issue#1189:  Adding error reporting for invalid indent configurations.

* Fixing style issues.
2024-07-08 20:48:01 -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
Edgar Vedvik c6c26e33bc
PR#1183: Fix bug in whitespace between tokens and add test for it (#1183)
Co-authored-by: Edgar Vedvik <edgar@radionor.no>
2024-06-19 21:32:02 -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 091f78d274
Issue#1177: Updating prefix and suffix rules to check for prefix or suffix if both exceptions are provided. (#1181) 2024-06-17 20:16:39 -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 a8c84a837d Updating announcements. 2024-06-04 06:48:15 -05:00
Jeremiah Leary 872884d33c
Issue#1168: Fixing mis-classification formal parameters in procedure specifications. (#1169) 2024-05-03 07:14:54 -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 9444c8d320
Issue#1166: code tags for rule length_003 were not honored. (#1167) 2024-04-16 20:11:15 -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 ce70761895
Issue#1059: Performance improvements: (#1064)
* Issue#1059:  Performance improvements:

  * Added lower value to token and removed .lower() in other files
  * Simplified find_next_token

* Attempt at new algorithm for closest pair.

NOTE:  attempt has been commented out.

* WIP:  Improved token pairs process:

NOTE:  It does not appear to complete all the  matches.

* Revert "WIP:  Improved token pairs process:"

This reverts commit f41254087e84caa42b02058fd9fbb6cfcce673fc.

* Revert "Attempt at new algorithm for closest pair."

This reverts commit 4a972793883b9aa54a6e7ccd15e1cc26b8296fec.

* Updates for black.
2024-04-09 06:52:40 -05:00
Jeremiah Leary e02d51244c Attemping to fix versioning for publishing to pypi 2024-04-06 20:10:26 -05:00
Jeremiah Leary 16d2f07dbb Ignoring release notes. 2024-04-06 10:15:17 -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 40050f54e7
Issue#1160: Removing unused files from MANIFEST.in (#1161) 2024-03-29 18:46:22 -05:00
Alon Bar-Lev 73f3ad02c5
cleanup: remove trailing spaces (#1158)
introduced in 374e2f4a8.

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-29 09:39:14 -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 374e2f4a8a Updating vacation status. 2024-03-27 20:14:35 -05:00
Alon Bar-Lev 1dc2f98438 ci: run for any branch
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-26 19:54:22 -05:00
Alon Bar-Lev 68409053e3 ci: remove unused travis configuration
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-26 19:50:49 -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 b8c49b5946 style: python encoding
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 c52e7c846b vsg: support unsigned and mark attributes
Required by the following tests:

* attribute/test_rule_500.py
* ieee/test_rule_500.py

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 18:48:35 +02:00
Alon Bar-Lev 219e01e406 tests: ieee: fix syntax of generic
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 18:48:35 +02:00
Alon Bar-Lev d837c98e1d tests: exit_statement: remove trailing spaces
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 18:48:35 +02:00
Alon Bar-Lev fc9c1f10fb tests: create files in temporary location
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 18:48:35 +02:00
Alon Bar-Lev 2d95ee7032 tests: rename '*.vhdl' -> '*.vhd'
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 e58beac8bf config: properly escape '\w', '\s' in string regexp
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 18:48:34 +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 1a93449194
Issue#1132: Fixing selection of iToken vs iCurrent. (#1133) 2024-03-14 07:27:19 -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
Jeremiah Leary 888b4e9ec4
Issue#1137: Fixing rules variable_011 and variable_assignment_008. (#1138) 2024-03-09 18:26:41 -06:00
Jeremiah Leary 8fa5c3f06b
Issue#789: Adding support for alignment of multiple targets in variable assignments (#841)
Added classification of aggregates for targets in simple_variable_assignments.

  1)  Added tests
  2)  Added classifiers
      a)  target
      b)  aggregate
  3)  Updated indent configuration

* Style updates.
2024-03-09 17:52:58 -06:00
7758 changed files with 168765 additions and 118953 deletions

8
.codespell-ignore Normal file
View File

@ -0,0 +1,8 @@
dentity
din
dout
elemente
inout
leary
synopsys
toi

View File

@ -1,4 +0,0 @@
[run]
omit = vsg/tests/*

7
.flake8 Normal file
View File

@ -0,0 +1,7 @@
[flake8]
max-line-length = 160
ignore =
# Whitespace before ':': conflict with black
E203
# Line break occurred before a binary operator: conflict with black
W503

2
.gitattributes vendored Normal file
View File

@ -0,0 +1,2 @@
[core]
* text=auto eol=lf

View File

@ -13,10 +13,7 @@ name: "CodeQL"
on:
push:
branches: [ "master" ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "master" ]
schedule:
- cron: '17 9 * * 5'
@ -38,7 +35,7 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
@ -48,11 +45,11 @@ jobs:
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
@ -61,7 +58,7 @@ jobs:
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# If the Autobuild fails above, remove it and uncomment the following three lines.
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
# - run: |

View File

@ -2,41 +2,132 @@
name: CI
# Controls when the action will run.
# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ master ]
pull_request:
branches: [ master ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
env:
BUILD_PYTHON_FOR_BUILD: "3.10"
BUILD_PYTHON_FOR_BUILD_ALIAS: "py310"
SKIP_TEST_ON_GITHUB: "True"
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
dist:
name: dist
runs-on: ubuntu-22.04
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v2
- name: checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # cannot be shallow as version will not be generated
- name: python.install
uses: actions/setup-python@v5
with:
python-version: ${{ env.BUILD_PYTHON_FOR_BUILD }}
- name: dependencies.install
run: |
python -m pip install --upgrade pip
python -m pip install tox
- name: dist
run: |
tox -e wheel-${{ env.BUILD_PYTHON_FOR_BUILD_ALIAS }}
- name: archive.upload
uses: actions/upload-artifact@v4
with:
name: dist
path: |
dist/wheel-${{ env.BUILD_PYTHON_FOR_BUILD_ALIAS }}
style:
runs-on: ubuntu-22.04
steps:
- name: checkout
uses: actions/checkout@v4
- name: python.install
uses: actions/setup-python@v5
with:
python-version: ${{ env.BUILD_PYTHON_FOR_BUILD }}
- name: dependencies.install
run: |
python -m pip install --upgrade pip
python -m pip install tox
- name: test
run: |
tox -e style
docs:
runs-on: ubuntu-22.04
steps:
- name: checkout
uses: actions/checkout@v4
- name: python.install
uses: actions/setup-python@v5
with:
python-version: ${{ env.BUILD_PYTHON_FOR_BUILD }}
- name: dependencies.install
run: |
python -m pip install --upgrade pip
python -m pip install tox
- name: build
run: |
tox -e docs
- name: archive.upload
if: always()
uses: actions/upload-artifact@v4
with:
name: docs
path: |
build.out/docs
build:
name: ${{ matrix.python-version }}-build
runs-on: ubuntu-22.04
strategy:
matrix:
python-version:
- "3.8"
- "3.9"
- "3.10"
- "3.11"
- "3.12"
- "3.13"
steps:
- name: checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
- name: Run Unit Tests
run: python -m unittest
- name: Generate Code Coverage Report
- name: python.install ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: dependencies.install
run: |
pip install coverage
coverage run -m unittest
python -m pip install --upgrade pip
python -m pip install tox
- name: build
run: |
tox
- name: Upload Coverage to Codecov
uses: codecov/codecov-action@v1
uses: codecov/codecov-action@v4
with:
directory: build.out
- name: archive.upload
if: always()
uses: actions/upload-artifact@v4
with:
name: build.out-${{ matrix.python-version }}
path: |
build.out
# - name: SonarCloud Scan
# uses: SonarSource/sonarcloud-github-action@master
# env:

View File

@ -14,4 +14,3 @@ jobs:
with:
project-url: https://github.com/users/jeremiah-c-leary/projects/3
github-token: ${{ secrets.ADD_TO_PROJECT_WORKFLOW_PAT }}

17
.gitignore vendored
View File

@ -8,14 +8,21 @@ dist
# Sphinx
_build
# This version file should never be committed
vsg/version_info.*
# Tox
.tox
build.out/
# Ignore release notes
release_notes.txt
# IDE files
.idea/
.vscode/
venv
.venv/
.uv-cache/
.uv-python/
.ci-*/
.package-build/
# Ignore external repos used for tests
vsg/tests/external_repos/repos
tests/external_repos/repos

85
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,85 @@
repos:
- repo: https://github.com/psf/black
rev: 23.12.1
hooks:
- id: black
- repo: https://github.com/PyCQA/isort
rev: 5.13.2
hooks:
- id: isort
# These are abuse of python import mechanism
# please conisder to remove in favor of direct module import.
exclude: "^(\
vsg/rules/__init__\\.py|\
vsg/vhdlFile/extract/__init__\\.py\
)$"
- repo: https://github.com/asottile/add-trailing-comma
rev: v3.1.0
hooks:
- id: add-trailing-comma
# repeat as above changes may cause rework
- repo: https://github.com/psf/black
rev: 23.12.1
hooks:
- id: black
- repo: https://github.com/Lucas-C/pre-commit-hooks
rev: v1.5.4
hooks:
- id: forbid-tabs
exclude: '^(.*\.vhd|.*\.svg)$'
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: check-added-large-files
- id: check-case-conflict
- id: check-json
# * config_error - intentional
# * *_run_config.json - legacy not json compliant
exclude: "^(\
tests/vsg/config_error\\.json\
)$"
- id: check-executables-have-shebangs
- id: check-shebang-scripts-are-executable
exclude: '^(.*\.svg)$'
- id: check-symlinks
- id: check-toml
- id: check-xml
- id: check-yaml
- id: debug-statements
- id: destroyed-symlinks
- id: detect-private-key
- id: fix-byte-order-marker
- id: end-of-file-fixer
- id: trailing-whitespace
exclude: "^(\
tests/styles/code_examples/trailing_whitespace\\.vhd|\
tests/styles/jcl/trailing_whitespace.fixed\\.vhd|\
tests/whitespace/.*\\.vhd\
)$"
- id: fix-encoding-pragma
# - repo: https://github.com/mgedmin/check-manifest
# rev: "0.50"
# hooks:
# - id: check-manifest
# additional_dependencies:
# - setuptools-git-versioning
# args:
# - --no-build-isolation
- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
hooks:
- id: codespell
args:
- -I.codespell-ignore
- repo: https://github.com/PyCQA/flake8
rev: 7.0.0
hooks: []
#- id: flake8

View File

@ -1,21 +0,0 @@
test-warnings: false
disable:
- prospector_N801
- prospector_N802
- prospector_N806
pep8:
full: true
disable:
- N801
- N802
- N806
prospector:
disable:
- N801
- N802
- N806

View File

@ -1,36 +1,12 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true
# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: docs/requirements.txt
commands:
- pip install tox
- tox -e docs

View File

@ -1,30 +0,0 @@
env:
global:
- CC_TEST_REPORTER_ID=05478298c5451cbc18f01aab36344f7f9327bcb1346d90db96df76321ae1e3f8
# command to install
install:
- pip install codecov
- python setup.py install
language:
- python
python:
- "3.8"
before_script:
- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
- chmod +x ./cc-test-reporter
- ./cc-test-reporter before-build
# command to run tests
script:
- coverage run setup.py test
after_success:
- codecov
after_script:
- ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

104
DISCLOSURE.md Normal file
View File

@ -0,0 +1,104 @@
# Authorship, LLM Use, and Safety Disclosure
This document describes the narrow stream-integration fork of VSG: how it was
developed, where an LLM was used, what is tested, and which operations can
affect source code. It does not make claims about the development process of
the complete upstream project.
## Authorship
The original VSG parser, rule library, fix engine, command-line application,
and most of this repository predate the fork. They are the work of Jeremy C.
Leary and upstream contributors. The fork maintainer chose the integration
requirements, keeps the patch set deliberately narrow, and accepts releases.
The fork-specific standard-input and standard-output integration,
machine-readable diagnostics, rule-scoped fix adapter, packaging automation,
tests, and related documentation were developed or refined with an LLM coding
assistant under maintainer direction. Development has been iterative, so this
repository does not claim reliable line-by-line attribution between human and
LLM-assisted work. The fork commits above the tracked upstream branch keep the
integration changes reviewable as a separate patch series.
## What the fork adds
The fork builds on VSG's existing `--stdin` and `--no-failure` options and adds
a small command-line boundary around existing behavior:
- `--diagnostics_json` emits a versioned diagnostic document;
- `--stdout` emits corrected VHDL instead of writing it to a source file;
- `--fix_rule RULE:LINE` adapts a selection to VSG's existing `--fix_only`
mechanism; and
- packaging and CI exercise the complete stream interface as an installed
artifact.
The parser, rules, phase ordering, and correction engine remain VSG's. The fork
does not add a second VHDL parser or formatter.
## Diagnostic JSON and side effects
`--diagnostics_json` requires `--stdin` and is incompatible with fixing and
other options that claim standard output. VSG parses the submitted text and
runs its normal rules, then serializes the resulting findings and effective
rule metadata. The JSON does not contain or execute replacement text and does
not introduce a path that writes back to the submitted source.
In this mode, producing JSON cannot change the VHDL, its behavior, or its
formatting. Output is always one valid JSON document: successful analysis is
marked complete, while argument, configuration, parsing, or unexpected failures
produce an incomplete envelope with empty findings and structured error
metadata. Details may also go to standard error. The process does not use or
contact an LLM at runtime.
This source-integrity statement is specifically about diagnostic mode. VSG
still reads explicitly supplied configuration and local-rule files, and local
rules are Python code that must be trusted. Operating-system logging, wrappers,
or custom rules are outside this fork's boundary.
Fixing is intentionally different. With `--stdin --fix --stdout`, VSG returns
corrected VHDL on standard output and does not write the input to a source file;
a caller such as the bridge may choose to apply that output. If parsing or
fixing cannot complete, this stream mode returns the original input unchanged;
an empty or partial result is never presented as a correction. Existing VSG
file workflows retain their upstream behavior, including any explicitly
requested file changes.
## What is tested
Focused fork tests cover:
- required and conflicting option validation;
- deterministic, versioned JSON and empty diagnostic collections;
- effective severity, fixability, documentation metadata, and Unicode text;
- invalid VHDL, invalid configuration, and unexpected failures with a valid
incomplete JSON document, including parser locations when available;
- rule selector parsing, validation, and deduplication;
- selected rules on the same line and across correction phases;
- corrections that insert lines; and
- unchanged output when a selected rule is unknown.
CI also runs the upstream unit and style suites, builds both wheel and source
distributions, and installs and smoke-tests the wheel through both pip and uv.
The smoke tests exercise stdin/stdout formatting from the installed artifact.
The tests cover known cases; they are not formal verification. In particular,
they do not prove VHDL semantic equivalence after formatting, cover every
third-party local rule, or remove upstream parser limitations such as embedded
PSL and VHDL 2019.
## Risk by operation
| Operation | Source-change risk | Main remaining risk |
| --- | --- | --- |
| `--stdin --diagnostics_json` | None by design | A finding or its metadata may be incomplete or incorrect. |
| `--stdin --stdout --fix` | Returns changed text by design | Applying the output may introduce an unwanted formatting change. |
| `--fix_rule` | Returns selected changes by design | Correction phases can move later findings, making original line selections stale. |
| Existing file-based VSG commands | Unchanged by the fork | They retain the behavior and risks documented by upstream VSG. |
The machine interface uses one-based line ranges because VSG does not provide
generally valid character spans. Consumers must validate the schema and must
not reinterpret internal token indexes as source columns.
For important or safety-critical HDL, keep work in version control, inspect
corrected output, and run the normal simulation, synthesis, linting, and review
process before accepting a change.

172
Jenkinsfile vendored Normal file
View File

@ -0,0 +1,172 @@
// Add the Gitea webhook configured for this Jenkins installation.
pipeline {
agent { label 'rust_no_docker' }
options {
disableConcurrentBuilds()
skipDefaultCheckout(true)
}
environment {
PYTHONUNBUFFERED = '1'
UV_CACHE_DIR = "${WORKSPACE}/.uv-cache"
UV_PYTHON_INSTALL_DIR = "${WORKSPACE}/.uv-python"
}
stages {
stage('Checkout') {
steps {
deleteDir()
checkout scm
sh 'git fetch --force --tags origin'
}
}
stage('Set up development environment') {
steps {
sh '''
set -eu
command -v uv >/dev/null 2>&1 || {
echo "ERROR: uv is required on the Jenkins worker." >&2
exit 1
}
uv --version
command -v python3
python3 --version
uv venv --python python3 .venv
uv pip install --python .venv/bin/python -e '.[tests,dev]'
'''
}
}
stage('Style') {
steps {
sh 'uv run --no-sync pre-commit run --all-files'
}
}
stage('Tests') {
steps {
sh 'uv run --no-sync python -m unittest'
}
}
stage('Build package') {
steps {
sh './build-package.sh'
}
}
stage('Wheel install with pip') {
steps {
sh '''
set -eu
wheel="$(find dist -maxdepth 1 -type f -name 'vsg-*.whl' -print -quit)"
test -n "${wheel}" || {
echo "ERROR: built wheel was not found." >&2
exit 1
}
python3 -m venv .ci-pip-venv
.ci-pip-venv/bin/python -m pip install "${wheel}"
output="$(
printf 'entity smoke is\nend entity smoke;\n' |
.ci-pip-venv/bin/vsg --stdin --stdout --fix --style jcl --no-failure
)"
printf '%s\n' "${output}" | grep -F 'entity SMOKE is'
'''
}
}
stage('Wheel install with uv') {
steps {
sh '''
set -eu
wheel="$(find dist -maxdepth 1 -type f -name 'vsg-*.whl' -print -quit)"
test -n "${wheel}" || {
echo "ERROR: built wheel was not found." >&2
exit 1
}
uv venv --python .venv/bin/python .ci-uv-venv
uv pip install --python .ci-uv-venv/bin/python "${wheel}"
output="$(
printf 'entity smoke is\nend entity smoke;\n' |
.ci-uv-venv/bin/vsg --stdin --stdout --fix --style jcl --no-failure
)"
printf '%s\n' "${output}" | grep -F 'entity SMOKE is'
'''
}
}
stage('Archive package') {
steps {
archiveArtifacts artifacts: 'dist/*', fingerprint: true, onlyIfSuccessful: true
}
}
stage('Publish package') {
when {
branch 'master'
}
steps {
withCredentials([
string(
credentialsId: 'vsg-gitea-package-token',
variable: 'GITEA_TOKEN'
)
]) {
sh '''
set +x
set -eu
test -n "${GITEA_TOKEN}" || {
echo "ERROR: Jenkins supplied an empty Gitea package token." >&2
exit 1
}
for artifact in dist/vsg-*.tar.gz dist/vsg-*.whl; do
test -f "${artifact}" || {
echo "ERROR: expected package artifact was not found: ${artifact}" >&2
exit 1
}
done
UV_PUBLISH_USERNAME='Dandaedre' \
UV_PUBLISH_PASSWORD="${GITEA_TOKEN}" \
uv publish \
--publish-url 'https://proxy.dandaedre.com/gitea/api/packages/MadGobblins/pypi' \
--check-url 'https://proxy.dandaedre.com/gitea/api/packages/MadGobblins/pypi/simple/' \
--no-attestations \
dist/vsg-*.tar.gz \
dist/vsg-*.whl
'''
}
}
}
}
post {
success {
publishChecks(
conclusion: 'SUCCESS',
name: 'VSG fork CI',
summary: 'VSG tests and package installation checks passed.',
text: 'The wheel was tested through both pip and uv, including stdin/stdout formatting.',
title: 'Build Successful'
)
}
failure {
publishChecks(
conclusion: 'FAILURE',
name: 'VSG fork CI',
summary: 'A VSG fork check failed.',
text: 'Review the Jenkins log for style, tests, build, installation, or publishing failures.',
title: 'Build Failed'
)
}
}
}

View File

@ -1,4 +1,29 @@
include README.rst
prune vsg/tests
include vsg/styles/*.yaml
include vsg/vhdlFile/indent/*.yaml
include *.properties
include .codespell-ignore
include .flake8
include .gitattributes
include .gitignore
include .pre-commit-config.yaml
include .pre-commit-hooks.yaml
include .readthedocs.yaml
include CODE_OF_CONDUCT.md
include bin/vsg
include bin/vsg_parser
include bin/vsg_rule_doc_gen
include docs/conf.py
include docs/example_configuration_json_file.json
include tox.ini
recursive-include .github *.md
recursive-include .github *.yml
recursive-include docs *.gif
recursive-include docs *.png
recursive-include docs *.rst
recursive-include docs *.svg
recursive-include docs *.csv
recursive-include tests *.json
recursive-include tests *.py
recursive-include tests *.rst
recursive-include tests *.txt
recursive-include tests *.vhd
recursive-include tests *.xml
recursive-include tests *.yaml

View File

@ -22,22 +22,14 @@ VHDL Style Guide (VSG)
Announcements
-------------
Update 02/10/2024
Update 11/09/2025
For Release 3.22.0.
Where has Jeremy been?
In an attempt to be more consistent in the configuration files, the following options are changing from camelCase to snake_case:
Just wanted to let everyone know that I have not abandoned this project.
There was a family emergency I had to handle and now work is taking a significant amount of my time.
+---------------+--------------+
| option | Changed To |
+===============+==============+
| indentSize | indent_size |
+---------------+--------------+
| indentStyle | indent_style |
+---------------+--------------+
An Error message will be generated if the old style is encountered.
A reminder to change the option to snake_case will be given.
I plan to start working on this again in December.
Regards,
@ -144,11 +136,91 @@ The latest development version can be cloned...
git clone https://github.com/jeremiah-c-leary/vhdl-style-guide.git
...and then installed locally...
Install prerequisites.
.. code-block:: bash
python setup.py install
pip install tox
Build locally, artifacts will appear in ``dist`` directory.
.. code-block:: bash
tox
Fork for ``vsg_bridge_ls``
~~~~~~~~~~~~~~~~~~~~~~~~~
This fork adds stream integration options so VSG can serve editor buffers.
``--diagnostics_json`` reads VHDL from ``--stdin`` and always writes one
versioned JSON diagnostic document to standard output. Failed analysis is a
valid document marked incomplete rather than missing or malformed JSON. Parser
failures include their best available one-based line and column so an editor can
replace stale style findings with a useful syntax error.
``--stdout`` writes fixed VHDL to standard output; if stdin cannot be parsed or
fixing otherwise fails, it returns the original input unchanged so callers get
a safe no-op rather than an empty replacement. Repeatable ``--fix_rule
RULE:LINE`` arguments restrict
``--fix`` to selected rules and one-based lines; they require ``--fix`` and
cannot be combined with ``--fix_only``. ``--no-failure`` permits diagnostic
findings without a nonzero process status. It is the VSG backend required for
`vsg_bridge_ls <https://proxy.dandaedre.com/gitea/MadGobblins/vsg-bridge-ls>`_.
The bridge README is the main user guide for installing both projects and
configuring an editor.
LLM disclosure and safety
^^^^^^^^^^^^^^^^^^^^^^^^^
* **Human foundation:** the original VSG parser, rules, fix engine, and command
line tool predate this fork and are the work of Jeremy C. Leary and upstream
contributors. The fork maintainer chooses its scope and accepts releases.
* **LLM-assisted work:** the fork-specific stream interface, machine-readable
diagnostics, scoped-fix adapter, packaging, tests, and related documentation
were developed or refined with an LLM coding assistant under maintainer
direction.
* **What is tested:** focused tests cover option validation, deterministic JSON,
Unicode, clean and invalid input, stdout/stderr separation, selected fixes,
and unchanged output for an unknown rule. CI also runs the upstream test and
style suites, builds the package, and smoke-tests installed wheels through
both pip and uv. Tests reduce risk; they do not prove the absence of defects.
* **Practical risk:** ``--diagnostics_json`` only serializes information
collected during normal parsing and rule analysis. It does not modify the
submitted VHDL, change formatting, write the source file, or use an LLM at
runtime. Existing VSG behavior is unchanged when the fork options are absent.
Explicit ``--fix``/``--stdout`` operations are different: they intentionally
return corrected VHDL, which a caller may then apply. Review generated edits
and use version control, especially for safety-critical HDL. See the
`full authorship, testing, and risk disclosure <DISCLOSURE.md>`_ for details.
The preferred installation uses uv and the prebuilt Gitea package:
.. code-block:: bash
uv venv .venv
uv pip install --python .venv/bin/python \
--index https://proxy.dandaedre.com/gitea/api/packages/MadGobblins/pypi/simple/ \
vsg
Installing from ``master`` also works with uv, and either source works with
standard pip. See the bridge's
`installation guide <https://proxy.dandaedre.com/gitea/MadGobblins/vsg-bridge-ls/src/branch/main/doc/installation.md>`_
for all supported commands and environment setup.
Fork maintainers can build locally with ``./build-package.sh`` and publish the
new artifacts with:
.. code-block:: bash
./build-package.sh ../gitea_token.txt --publish
On ``master``, Jenkins fetches the Git tags used by
``setuptools-git-versioning``, runs both installation smoke tests, archives the
generated distributions, and publishes those exact artifacts to Gitea. The
required Jenkins credential is documented in the bridge development guide.
Use ``./update-fork.sh`` to fetch upstream tags and rebase the small fork patch
series onto the latest upstream ``master``. The script requires a clean
worktree and automatically aborts a failed rebase.
Usage
-----

View File

@ -1,15 +1,16 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import sys
import os
import sys
# Get the path to the executable
executablePath = os.path.dirname(os.path.realpath(__file__))
# Import program modules
sys.path.append(os.path.join(executablePath, '..'))
sys.path.append(os.path.join(executablePath, ".."))
from vsg.__main__ import main
if __name__ == '__main__':
if __name__ == "__main__":
main()

View File

@ -1,15 +1,16 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import sys
import os
import sys
# Get the path to the executable
executablePath = os.path.dirname(os.path.realpath(__file__))
# Import program modules
sys.path.append(os.path.join(executablePath, '..'))
sys.path.append(os.path.join(executablePath, ".."))
from vsg.__parser__ import main
if __name__ == '__main__':
if __name__ == "__main__":
main()

View File

@ -1,15 +1,16 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import sys
import os
import sys
# Get the path to the executable
executablePath = os.path.dirname(os.path.realpath(__file__))
# Import program modules
sys.path.append(os.path.join(executablePath, '..'))
sys.path.append(os.path.join(executablePath, ".."))
from vsg.__rule_doc_gen__ import main
if __name__ == '__main__':
if __name__ == "__main__":
main()

135
build-package.sh Executable file
View File

@ -0,0 +1,135 @@
#!/usr/bin/env bash
set -Eeuo pipefail
show_help() {
cat <<'EOF'
Usage: ./build-package.sh [TOKEN_FILE] [--publish]
Build the VSG source distribution and wheel. With --publish, upload the newly
built artifacts to Gitea. TOKEN_FILE overrides all other token sources.
Optional publishing settings:
GITEA_TOKEN token value used when TOKEN_FILE is omitted
GITEA_TOKEN_FILE
token file used when TOKEN_FILE and GITEA_TOKEN are omitted
(default: ../gitea_token.txt)
GITEA_USERNAME Gitea login name (default: Dandaedre)
GITEA_OWNER package owner (default: MadGobblins)
GITEA_URL Gitea base URL (default: https://proxy.dandaedre.com/gitea)
EOF
}
fail_usage() {
echo "ERROR: $1" >&2
show_help >&2
exit 2
}
publish=false
token_file_argument=""
while [ "$#" -gt 0 ]; do
case "$1" in
--publish)
[ "${publish}" = false ] || fail_usage "--publish was specified more than once."
publish=true
;;
-h|--help)
show_help
exit 0
;;
-*)
fail_usage "unknown option: $1"
;;
*)
[ -z "${token_file_argument}" ] || fail_usage "more than one token file was specified."
token_file_argument="$1"
;;
esac
shift
done
if [ -n "${token_file_argument}" ] && [ "${publish}" = false ]; then
fail_usage "TOKEN_FILE requires --publish."
fi
repo_root="$(git rev-parse --show-toplevel 2>/dev/null)" || {
echo "ERROR: build-package.sh must run inside a Git worktree." >&2
exit 1
}
gitea_token="${GITEA_TOKEN:-}"
if [ -n "${token_file_argument}" ]; then
gitea_token=""
gitea_token_file="${token_file_argument}"
else
gitea_token_file="${GITEA_TOKEN_FILE:-${repo_root}/../gitea_token.txt}"
fi
if [ "${publish}" = true ] && [ -z "${gitea_token}" ]; then
if [ ! -f "${gitea_token_file}" ] || [ ! -r "${gitea_token_file}" ]; then
fail_usage "token file is not a readable regular file: ${gitea_token_file}"
fi
IFS= read -r gitea_token <"${gitea_token_file}" || :
fi
if [ "${publish}" = true ] && [ -z "${gitea_token}" ]; then
fail_usage "token file is empty: ${gitea_token_file}"
fi
cd "${repo_root}"
if ! command -v uv >/dev/null 2>&1; then
echo "ERROR: uv is required to build the package." >&2
exit 1
fi
if [ ! -x .venv/bin/python ]; then
echo "Creating the required local virtual environment..."
uv venv .venv
fi
readonly build_dir=".package-build"
if [ -e "${build_dir}" ]; then
rm -rf -- "${build_dir}"
fi
echo "Building the source distribution and wheel..."
uv build --no-sources --out-dir "${build_dir}"
shopt -s nullglob
artifacts=("${build_dir}"/vsg-*.tar.gz "${build_dir}"/vsg-*.whl)
if [ "${#artifacts[@]}" -lt 2 ]; then
echo "ERROR: uv build completed without producing both expected package formats." >&2
exit 1
fi
mkdir -p dist
built_artifacts=()
for artifact in "${artifacts[@]}"; do
destination="dist/${artifact##*/}"
cp -- "${artifact}" "${destination}"
built_artifacts+=("${destination}")
done
rm -rf -- "${build_dir}"
echo "Built package artifacts:"
printf ' %s\n' "${built_artifacts[@]}"
if [ "${publish}" = true ]; then
readonly gitea_username="${GITEA_USERNAME:-Dandaedre}"
readonly gitea_owner="${GITEA_OWNER:-MadGobblins}"
readonly gitea_url="${GITEA_URL:-https://proxy.dandaedre.com/gitea}"
echo
echo "Publishing package artifacts to Gitea..."
UV_PUBLISH_USERNAME="${gitea_username}" \
UV_PUBLISH_PASSWORD="${gitea_token}" \
uv publish \
--publish-url "${gitea_url}/api/packages/${gitea_owner}/pypi" \
--check-url "${gitea_url}/api/packages/${gitea_owner}/pypi/simple/" \
--no-attestations \
"${built_artifacts[@]}"
echo "Published package artifacts successfully."
fi
echo
echo "Install the wheel into a uv environment with:"
printf ' uv pip install %q\n' "${built_artifacts[-1]}"

View File

@ -1,20 +0,0 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = vhdl-style-guide
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

View File

@ -54,7 +54,7 @@ after_002
|phase_5| |disabled| |error| |alignment|
This rule checks the *after* keywords are aligned in a clock process.
This rule checks the **after** keywords are aligned in a clock process.
|configuring_keyword_alignment_rules_link|
@ -93,7 +93,7 @@ after_003
|phase_1| |disabled| |error| |structure|
This rule checks the *after* keywords do not exist in the reset portion of a clock process.
This rule checks the **after** keywords do not exist in the reset portion of a clock process.
**Violation**
@ -125,3 +125,23 @@ This rule checks the *after* keywords do not exist in the reset portion of a clo
end if;
end process clk_proc;
after_500
#########
|phase_6| |error| |case| |case_keyword|
This rule checks the **after** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
a <= 1 AFTER 10 ns;
**Fix**
.. code-block:: vhdl
a <= 1 after 10 ns;

9
docs/aggregate_rules.rst Normal file
View File

@ -0,0 +1,9 @@
.. include:: includes.rst
Aggregate Rules
---------------
aggregate_500
#############
This rule has been deprecated and replaced with rule `choice_500 <choice_rules.html#choice-500>`_.

View File

@ -263,11 +263,11 @@ This rule checks for consistent capitalization of alias designators.
alias_declaration_600
#####################
|phase_7| |disabled| |error| |naming|
|phase_7| |disabled| |error| |unfixable| |naming|
This rule checks for valid prefixes on alias designators.
Default prefix is *a\_*.
Default prefix is *a_*.
|configuring_prefix_and_suffix_rules_link|
@ -288,11 +288,11 @@ Default prefix is *a\_*.
alias_declaration_601
#####################
|phase_7| |disabled| |error| |naming|
|phase_7| |disabled| |error| |unfixable| |naming|
This rule checks for valid suffixes on alias designators.
Default prefix is *\_a*.
Default prefix is *_a*.
|configuring_prefix_and_suffix_rules_link|
@ -309,4 +309,3 @@ Default prefix is *\_a*.
alias header_a is name;
alias footer_a is name;

View File

@ -1,13 +0,0 @@
API
---
VSG was written to be included in other tools.
The command line script provides one means of using VSG.
It also provides an example of how to use the API.
There are two main modules you will use when incorporating VSG into another program:
.. toctree::
vsg.vhdlFile
vsg.rule_list

View File

@ -511,11 +511,12 @@ It is clearer to the reader to state which architecture the end statement is clo
architecture_025
################
|phase_7| |disabled| |error| |naming|
|phase_7| |disabled| |error| |unfixable| |naming|
This rule checks for valid names for the architecture.
Typical architecture names are: RTL, EMPTY, and BEHAVE.
This rule allows the user to restrict what can be used for an architecture name.
Note that regular expressions are accepted in the **names** field.
.. NOTE:: This rule is disabled by default.
You can enable and configure the names using the following configuration.
@ -531,6 +532,7 @@ This rule allows the user to restrict what can be used for an architecture name.
- rtl
- empty
- behave
- my_pattern.*
**Violation**
@ -882,4 +884,3 @@ This rule checks for consistent capitalization of port names in an architecture
register <= I_DATA;
end architecture rtl;

View File

@ -0,0 +1,47 @@
.. include:: includes.rst
Array Constraint Rules
----------------------
array_constraint_100
####################
|phase_2| |error| |whitespace|
This rule checks for whitespace before the opening parenthesis.
|configuring_whitespace_rules_link|
**Violation**
.. code-block:: vhdl
subtype my_array3 is my_array2 (open)(7 downto 0);
**Fix**
.. code-block:: vhdl
subtype my_array3 is my_array2(open)(7 downto 0);
array_constraint_500
####################
|phase_6| |error| |case| |case_keyword|
This rule checks the **open** keyword in array constraints has the proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
subtype t_my_array is t_array(OPEN)(t_range);
**Fix**
.. code-block:: vhdl
subtype t_my_array is t_array(open)(t_range);

View File

@ -340,4 +340,3 @@ This rule checks the **severity** keyword has proper case.
assert WIDTH > 16
report "FIFO width is limited to 16 bits."
severity FAILURE;

View File

@ -128,4 +128,3 @@ This rule checks the *type_mark* has proper case.
.. code-block:: vhdl
attribute max_delay : time;

View File

@ -6,7 +6,7 @@ Attribute Rules
attribute_001
#############
This rule has been superceeded by:
This rule has been superseded by:
* `attribute_declaration_300 <attribute_declaration_rules.html#attribute-declaration-300>`_
* `attribute_specification_300 <attribute_specification_rules.html#attribute-specification-300>`_
@ -14,7 +14,7 @@ This rule has been superceeded by:
attribute_002
#############
This rule has been superceeded by:
This rule has been superseded by:
* `attribute_declaration_500 <attribute_declaration_rules.html#attribute-declaration-500>`_
* `attribute_specification_500 <attribute_specification_rules.html#attribute-specification-500>`_
@ -39,4 +39,3 @@ This rule checks predefined attributes have the proper case.
.. code-block:: vhdl
signal data : std_logic_vector(g_width'range);

View File

@ -155,4 +155,3 @@ This rule checks the **is** keyword has proper case.
.. code-block:: vhdl
attribute coordinate of comp_1 : component is (0.0, 17.5);

View File

@ -0,0 +1,50 @@
.. include:: includes.rst
Bit String Literal Rules
------------------------
bit_string_literal_500
######################
|phase_6| |error| |case|
This rule checks the base specifier has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
signal test : my_vector := X"FFF";
**Fix**
.. code-block:: vhdl
signal test : my_vector := x"FFF";
bit_string_literal_501
######################
|phase_6| |error| |case|
This rule checks the bit value has proper case.
|configuring_uppercase_and_lowercase_rules_link|
The default style is :code:`upper`.
**Violation**
.. code-block:: vhdl
signal test : my_vector := x"FFF";
**Fix**
.. code-block:: vhdl
signal test : my_vector := x"fff";

View File

@ -23,7 +23,7 @@ Block Comment Rules
block_comment_001
#################
|phase_1| |disabled| |error| |structure|
|phase_1| |disabled| |error| |unfixable| |structure|
This rule checks the block comment header is correct.
@ -50,7 +50,7 @@ This rule checks the block comment header is correct.
block_comment_002
#################
|phase_1| |disabled| |error| |structure|
|phase_1| |disabled| |error| |unfixable| |structure|
This rule checks the **comment_left** attribute exists for all comments.
@ -77,7 +77,7 @@ This rule checks the **comment_left** attribute exists for all comments.
block_comment_003
#################
|phase_1| |disabled| |error| |structure|
|phase_1| |disabled| |error| |unfixable| |structure|
This rule checks the block comment footer is correct.
@ -100,4 +100,3 @@ This rule checks the block comment footer is correct.
--| Comment
--| Comment
--+--------------------------[ Footer ]=

View File

@ -153,7 +153,7 @@ block_100
|phase_2| |error| |whitespace|
This rule checks for a single space between the following block elements: label, label colon, **block** keyword, guard open parenthesis, guart close parenthesis, and **is** keywords.
This rule checks for a single space between the following block elements: label, label colon, **block** keyword, guard open parenthesis, guard close parenthesis, and **is** keywords.
|configuring_whitespace_rules_link|
@ -644,7 +644,7 @@ This rule checks the label has proper case on the end block declaration.
block_600
#########
|phase_7| |disabled| |error| |naming|
|phase_7| |disabled| |error| |unfixable| |naming|
This rule checks for valid suffixes on block labels.
The default suffix is *_blk*.
@ -666,7 +666,7 @@ The default suffix is *_blk*.
block_601
#########
|phase_7| |disabled| |error| |naming|
|phase_7| |disabled| |error| |unfixable| |naming|
This rule checks for valid prefixes on block labels.
The default prefix is *blk_*.
@ -684,4 +684,3 @@ The default prefix is *blk_*.
.. code-block:: vhdl
blk_block_label : block is

View File

@ -3,6 +3,111 @@
Case Generate Alternative Rules
-------------------------------
case_generate_alternative_100
#############################
|phase_2| |error| |whitespace|
This rule checks for a single space after the **when** keyword.
|configuring_whitespace_rules_link|
**Violation**
.. code-block:: vhdl
case data generate
when 3 =>
**Fix**
.. code-block:: vhdl
case data generate
when 3 =>
case_generate_alternative_101
#############################
|phase_2| |error| |whitespace|
This rule checks for a single space before the **=>** operator.
|configuring_whitespace_rules_link|
**Violation**
.. code-block:: vhdl
case data generate
when 3 =>
**Fix**
.. code-block:: vhdl
case data generate
when 3 =>
case_generate_alternative_200
#############################
|phase_3| |error| |blank_line|
This rule checks for a blank line below the **=>** keyword.
|configuring_blank_lines_link|
**Violation**
.. code-block:: vhdl
when 0 =>
a <= b;
**Fix**
.. code-block:: vhdl
when 0 =>
a <= b;
case_generate_alternative_201
#############################
|phase_3| |error| |blank_line|
This rule checks for blank lines or comments above the **when** keyword.
|configuring_previous_line_rules_link|
The default style is :code:`allow_comment`.
**Violation**
.. code-block:: vhdl
case data is
when 3 =>
-- Comment
when 4 =>
**Fix**
.. code-block:: vhdl
case data is
when 3 =>
-- Comment
when 4 =>
case_generate_alternative_300
#############################
@ -13,7 +118,7 @@ case_generate_alternative_500
|phase_6| |error| |case| |case_keyword|
This rule checks the *when* keyword has proper case.
This rule checks the **when** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
@ -32,21 +137,4 @@ This rule checks the *when* keyword has proper case.
case_generate_alternative_501
#############################
|phase_6| |error| |case| |case_keyword|
This rule checks the *others* keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
when OTHERS =>
**Fix**
.. code-block:: vhdl
when others =>
This rule has been deprecated and replaced with rule `choice_500 <choice_rules.html#choice-500>`_.

View File

@ -3,6 +3,75 @@
Case Generate Statement Rules
-----------------------------
case_generate_statement_100
###########################
|phase_2| |error| |whitespace|
This rule checks for a single space after the **case** keyword.
|configuring_whitespace_rules_link|
**Violation**
.. code-block:: vhdl
case data generate
**Fix**
.. code-block:: vhdl
case data generate
case_generate_statement_101
###########################
|phase_2| |error| |whitespace|
This rule checks for a single space before the **generate** keyword.
|configuring_whitespace_rules_link|
**Violation**
.. code-block:: vhdl
case data generate
**Fix**
.. code-block:: vhdl
case data generate
case_generate_statement_200
###########################
|phase_3| |error| |blank_line|
This rule checks for blank lines or comments above the **end** keyword.
|configuring_blank_lines_link|
**Violation**
.. code-block:: vhdl
when others =>
null;
end generate;
**Fix**
.. code-block:: vhdl
when others =>
null;
end generate;
case_generate_statement_400
###########################
@ -39,7 +108,7 @@ case_generate_statement_500
|phase_6| |error| |case| |case_keyword|
This rule checks the *case* keyword has proper case.
This rule checks the **case** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
@ -60,7 +129,7 @@ case_generate_statement_501
|phase_6| |error| |case| |case_keyword|
This rule checks the *generate* keyword has proper case.
This rule checks the **generate** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
@ -75,4 +144,3 @@ This rule checks the *generate* keyword has proper case.
.. code-block:: vhdl
case expression generate

View File

@ -290,29 +290,7 @@ This rule checks for code after the **=>** operator.
case_013
########
|phase_4| |error| |indent|
This rule checks the indent of the **null** keyword.
**Violation**
.. code-block:: vhdl
when others =>
null;
when others =>
null;
**Fix**
.. code-block:: vhdl
when others =>
null;
when others =>
null;
This rule has been superseded by `null_statement_300 <null_statement_rules.html#null-statement-300>`_.
case_014
########
@ -555,3 +533,30 @@ The default style is :code:`allow_comment`.
-- Comment
when 4 =>
case_300
########
|phase_4| |error| |indent|
This rule checks the indentation of the label.
**Violation**
.. code-block:: vhdl
case_label : case data is
end case;
**Fix**
.. code-block:: vhdl
case_label : case data is
end case;
case_500
########
This rule has been deprecated and replaced with rule `choice_500 <choice_rules.html#choice-500>`_.

25
docs/choice_rules.rst Normal file
View File

@ -0,0 +1,25 @@
.. include:: includes.rst
Choice Rules
------------
choice_500
##########
|phase_6| |error| |case| |case_keyword|
This rule checks the **others** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
'0' when OTHERS;
**Fix**
.. code-block:: vhdl
'0' when others;

View File

@ -3,7 +3,7 @@ Code Tags
VSG supports inline tags embedded into code to enable or disable rules.
This can be useful in fine tuning rule exceptions within a file.
The code tags are embedded in comments similar to pragmas, and must be on it's own line.
The code tags are embedded in comments similar to pragmas, and must be on its own line.
Full rule exclusion
-------------------
@ -86,7 +86,7 @@ Multiple identifiers can be added to a single tag..
-- vsg_disable_next_line process_018
end process;
In the above example, process_016 will only be disabled for the line with the process keyword.
In the above example, process_016 will only be disabled for the line with the **process** keyword.
Successive processes without labels will be flagged by process_016.
Sequential next line exclusions will also be honored:
@ -102,7 +102,7 @@ Sequential next line exclusions will also be honored:
-- vsg_disable_next_line process_018
end process;
In the above example, both process_002 and process_016 will be disabled for the line starting with the process keyword.
In the above example, both process_002 and process_016 will be disabled for the line starting with the **process** keyword.
Comments in code tags
---------------------
@ -119,4 +119,3 @@ The colon character, :, can be used to document why the code tag exists.
b <= read;
end process;
-- vsg_on process_016 process_018 : Done with exclusion until VSG is fixed

View File

@ -33,12 +33,14 @@ comment_010
This rule checks the indent lines starting with comments.
|configuring_comment_indenting_link|
**Violation**
.. code-block:: vhdl
-- Libraries
libary ieee;
library ieee;
-- Define architecture
architecture rtl of fifo is
@ -54,7 +56,7 @@ This rule checks the indent lines starting with comments.
.. code-block:: vhdl
-- Libraries
libary ieee;
library ieee;
-- Define architecture
architecture rtl of fifo is
@ -91,7 +93,7 @@ The indent of the comment will be set to the indent of the current line.
comment_012
###########
|phase_1| |disabled| |warning| |structure|
|phase_1| |disabled| |warning| |unfixable| |structure|
This rule checks for user defined keywords in comments.
@ -136,4 +138,3 @@ This rule checks for a single space after the **--**.
--|Comment 2
---Comment
---------------------------

View File

@ -433,7 +433,7 @@ component_019
|phase_1| |error| |structure|
This rule checks for comments at the end of the port and generic clauses in component declarations.
These comments represent additional maintainence.
These comments represent additional maintenance.
They will be out of sync with the entity at some point.
Refer to the entity for port types, port directions and purpose.
@ -521,3 +521,27 @@ This rule inserts the optional **is** keyword if it does not exist.
end my_component;
component_022
#############
|phase_1| |error| |structure| |structure_optional|
This rule inserts the optional **component_simple_name** if it does not exist.
|configuring_optional_items_link|
**Violation**
.. code-block:: vhdl
component my_component
end component;
**Fix**
.. code-block:: vhdl
component my_component is
end component my_component;

View File

@ -59,7 +59,7 @@ concurrent_003
|phase_5| |error| |alignment|
This rule checks alignment of multiline concurrent simple signal assignments.
Succesive lines should align to the space after the assignment operator.
Successive lines should align to the space after the assignment operator.
However, there is a special case if there are parenthesis in the assignment.
If the parenthesis are not closed on the same line, then the next line will be aligned to the parenthesis.
Aligning to the parenthesis improves readability.
@ -363,4 +363,3 @@ This rule checks the alignment of multiline concurrent simple signal assignments
65535,
32768
);

View File

@ -128,4 +128,3 @@ This rule checks the **else** keyword has proper case.
.. code-block:: vhdl
wr_en <= '0' when (rd_en = '0') else '1';

View File

@ -176,4 +176,3 @@ This rule checks the **else** keyword has proper case.
.. code-block:: vhdl
wr_en <= '0' when (rd_en = '0') else '1';

View File

@ -18,7 +18,8 @@
#
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath(".."))
import vsg.version
@ -31,48 +32,47 @@ import vsg.version
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.coverage', 'sphinx.ext.autodoc', 'sphinx.ext.autosectionlabel', 'sphinx_rtd_theme']
extensions = ["sphinx.ext.coverage", "sphinx.ext.autodoc", "sphinx.ext.autosectionlabel", "sphinx_rtd_theme"]
suppress_warnings = ["autosectionlabel.*"]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
source_suffix = ".rst"
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# General information about the project.
project = u'vhdl-style-guide'
copyright = u'2017-2020, Jeremiah C Leary'
author = u'Jeremiah C Leary'
project = "vhdl-style-guide"
copyright = "2017-2020, Jeremiah C Leary"
author = "Jeremiah C Leary"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = str(vsg.version.sVersion)
# The full version, including alpha/beta/rc tags.
release = str(vsg.version.sVersion)
version = vsg.version.get_version()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
@ -83,31 +83,29 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = "sphinx_rtd_theme"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
'logo_only': False,
'display_version': True,
'prev_next_bottons_location': 'bottom',
'style_external_links': False,
'vcs_pageview_mode': '',
# 'style_nav_header_background': 'white',
# ToC options
'collapse_navigation': False,
'sticky_navigation': True,
'navigation_depth': 3,
'includehidden': False,
'titles_only': False
"logo_only": False,
"prev_next_buttons_location": "bottom",
"style_external_links": False,
"vcs_pageview_mode": "",
# ToC options
"collapse_navigation": False,
"sticky_navigation": True,
"navigation_depth": 3,
"includehidden": False,
"titles_only": False,
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# html_static_path = ["_static"]
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
@ -115,17 +113,17 @@ html_static_path = ['_static']
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
]
"**": [
"relations.html", # needs 'show_related': True theme option to display
"searchbox.html",
],
}
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'vhdl-style-guidedoc'
htmlhelp_basename = "vhdl-style-guidedoc"
# -- Options for LaTeX output ---------------------------------------------
@ -134,15 +132,12 @@ latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
@ -152,8 +147,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'vhdl-style-guide.tex', u'vhdl-style-guide Documentation',
u'Jeremiah C Leary', 'manual'),
(master_doc, "vhdl-style-guide.tex", "vhdl-style-guide Documentation", "Jeremiah C Leary", "manual"),
]
@ -161,10 +155,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'vhdl-style-guide', u'vhdl-style-guide Documentation',
[author], 1)
]
man_pages = [(master_doc, "vhdl-style-guide", "vhdl-style-guide Documentation", [author], 1)]
# -- Options for Texinfo output -------------------------------------------
@ -173,7 +164,5 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'vhdl-style-guide', u'vhdl-style-guide Documentation',
author, 'vhdl-style-guide', 'One line description of project.',
'Miscellaneous'),
(master_doc, "vhdl-style-guide", "vhdl-style-guide Documentation", author, "vhdl-style-guide", "One line description of project.", "Miscellaneous"),
]

View File

@ -9,6 +9,7 @@ Configuring
configuring_array_multiline_structure_rules.rst
configuring_blank_lines.rst
configuring_block_comments.rst
configuring_comment_indenting.rst
configuring_comment_keywords.rst
configuring_conditional_multiline_indent_rules.rst
configuring_consecutive_blank_line_rules.rst
@ -18,12 +19,15 @@ Configuring
configuring_indent_rules.rst
configuring_keyword_alignment_rules.rst
configuring_length_rules.rst
configuring_library_and_package_name_restriction_rules.rst
configuring_move_token_rules.rst
configuring_multiline_assert_rule.rst
configuring_multiline_constraint_rules.rst
configuring_multiline_indent_rules.rst
configuring_number_of_signals_in_signal_declaration.rst
configuring_number_of_variables_in_variable_declaration.rst
configuring_optional_items.rst
configuring_port_map_new_line.rst
configuring_port_mode_alignment.rst
configuring_pragmas.rst
configuring_prefix_and_suffix_rules.rst
@ -35,6 +39,7 @@ Configuring
configuring_type_of_instantiations.rst
configuring_uppercase_and_lowercase_rules.rst
configuring_use_clause_indenting.rst
configuring_user_error_messages.rst
configuring_whitespace_rules.rst
configuring_whitespace_after_comment_rules.rst
configuring_vhdl_reserved_words.rst

View File

@ -163,7 +163,7 @@ The following code snippet is used in the following examples:
constant c_stimulus : t_stimulus_array :=
(
(
name =>
name =>
"Hold in reset",
clk_in => "01",
rst_in => "11",
@ -187,10 +187,10 @@ Example: |first_paren_new_line| set to |yes|
.. code-block:: vhdl
constant c_stimulus : t_stimulus_array :=
constant c_stimulus : t_stimulus_array :=
((name => "Hold in reset", clk_in => "01", rst_in => "11", cnt_en_in => "00", cnt_out => "00"), (name => "Not enabled", clk_in => "01", rst_in => "00", cnt_en_in => "00", cnt_out => "00")); -- Define test vectors
constant c_stimulus : t_stimulus_array :=
constant c_stimulus : t_stimulus_array :=
(
(
name =>
@ -245,7 +245,7 @@ Example: |last_paren_new_line| set to |yes|
constant c_stimulus : t_stimulus_array := ((name => "Hold in reset", clk_in => "01", rst_in => "11", cnt_en_in => "00", cnt_out => "00"), (name => "Not enabled", clk_in => "01", rst_in => "00", cnt_en_in => "00", cnt_out => "00")
); -- Define test vectors
constant c_stimulus : t_stimulus_array :=
constant c_stimulus : t_stimulus_array :=
(
(
name =>
@ -300,7 +300,7 @@ Example: |open_paren_new_line| set to |yes|
name => "Hold in reset", clk_in => "01", rst_in => "11", cnt_en_in => "00", cnt_out => "00"), (
name => "Not enabled", clk_in => "01", rst_in => "00", cnt_en_in => "00", cnt_out => "00")); -- Define test vectors
constant c_stimulus : t_stimulus_array :=
constant c_stimulus : t_stimulus_array :=
(
(
name =>
@ -352,7 +352,7 @@ Example: |close_paren_new_line| set to |yes|
)
); -- Define test vectors
constant c_stimulus : t_stimulus_array :=
constant c_stimulus : t_stimulus_array :=
(
(
name =>
@ -408,7 +408,7 @@ Example: |new_line_after_comma| set to |yes|
cnt_en_in => "00",
cnt_out => "00")); -- Define test vectors
constant c_stimulus : t_stimulus_array :=
constant c_stimulus : t_stimulus_array :=
(
(
name =>
@ -444,10 +444,10 @@ Example: |assign_on_single_line| set to |yes|
.. code-block:: vhdl
constant c_stimulus : t_stimulus_array :=
constant c_stimulus : t_stimulus_array :=
((name => "Hold in reset", clk_in => "01", rst_in => "11", cnt_en_in => "00", cnt_out => "00"), (name => "Not enabled", clk_in => "01", rst_in => "00", cnt_en_in => "00", cnt_out => "00")); -- Define test vectors
constant c_stimulus : t_stimulus_array :=
constant c_stimulus : t_stimulus_array :=
(
(
name => "Hold in reset",
@ -523,7 +523,7 @@ would result in the following formatting:
.. code-block:: vhdl
constant c_stimulus : t_stimulus_array :=
constant c_stimulus : t_stimulus_array :=
(
(
name => "Hold in reset",
@ -566,4 +566,6 @@ Rules Enforcing Array Multiline Structure Rules
* `concurrent_012 <concurrent_rules.html#concurrent-012>`_
* `constant_016 <constant_rules.html#constant-016>`_
* `sequential_009 <sequential_rules.html#sequential-009>`_
* `signal_403 <signal_rules.html#signal-403>`_
* `variable_403 <variable_rules.html#variable-403>`_
* `variable_assignment_008 <variable_assignment_rules.html#variable-assignment-008>`_

View File

@ -146,6 +146,8 @@ Rules Enforcing Blank Lines
* `case_009 <case_rules.html#case-009>`_
* `case_010 <case_rules.html#case-010>`_
* `case_200 <case_rules.html#case-200>`_
* `case_generate_alternative_200 <case_generate_alternative_rules.html#case-generate-alternative-200>`_
* `case_generate_statement_200 <case_generate_statement_rules.html#case-generate-statement-200>`_
* `component_016 <component_rules.html#component-016>`_
* `component_018 <component_rules.html#component-018>`_
* `constant_200 <constant_rules.html#constant-200>`_
@ -166,10 +168,11 @@ Rules Enforcing Blank Lines
* `package_body_201 <package_body_rules.html#package-body-201>`_
* `package_body_202 <package_body_rules.html#package-body-202>`_
* `package_body_203 <package_body_rules.html#package-body-203>`_
* `package_instantiation_201 <package_instantiation_rules.html#package-instantiation-201>`_
* `port_001 <port_rules.html#port-001>`_
* `port_map_200 <port_map_rules.html#port-map-200>`_
* `pragma_401 <../pragma_rules.html#pragma-401>`_
* `pragma_403 <../pragma_rules.html#pragma-403>`_
* `pragma_401 <pragma_rules.html#pragma-401>`_
* `pragma_403 <pragma_rules.html#pragma-403>`_
* `process_011 <process_rules.html#process-011>`_
* `process_021 <process_rules.html#process-021>`_
* `process_022 <process_rules.html#process-022>`_
@ -183,5 +186,7 @@ Rules Enforcing Blank Lines
* `subprogram_body_203 <subprogram_body_rules.html#subprogram-body-203>`_
* `subprogram_body_204 <subprogram_body_rules.html#subprogram-body-204>`_
* `subprogram_body_205 <subprogram_body_rules.html#subprogram-body-205>`_
* `subtype_200 <subtype_rules.html#subtype-200>`_
* `subtype_202 <subtype_rules.html#subtype-202>`_
* `type_011 <type_rules.html#type-011>`_
* `type_200 <type_rules.html#type-200>`_

View File

@ -121,20 +121,20 @@ To configure the following example...
rule:
block_comment_001:
disable : False
header_left : ''
header_left_repeat : '-'
header_string : ''
header_right_repeat : ''
disable: false
header_left:
header_left_repeat: '-'
header_string:
header_right_repeat:
block_comment_002:
disable : False
comment_left : ''
disable: false
comment_left:
block_comment_003:
disable : False
footer_left : ''
footer_left_repeat : '-'
footer_string : ''
footer_right_repeat : ''
disable: false
footer_left:
footer_left_repeat: '-'
footer_string:
footer_right_repeat:
Complex Block Comment
^^^^^^^^^^^^^^^^^^^^^

View File

@ -0,0 +1,153 @@
.. _configuring-comment-indenting:
Configuring Comment Indenting
-----------------------------
The desired indenting of comments can vary depending on where the comment occurs.
There are currently two options for configuring indents.
.. |boolean_value| replace::
:code:`<boolean>`
.. |True| replace::
:code:`True`
.. |False| replace::
:code:`False`
.. |align_with_end_of_declarative_part| replace::
:code:`align_with_end_of_declarative_part`
.. |align_with_end_of_statement_part| replace::
:code:`align_with_end_of_statement_part`
.. |align_with_end_of_part_default| replace::
|False|
.. |align_with_end_of_part_True| replace::
|True| = Sets indent to current indent level.
.. |align_with_end_of_part_False| replace::
|False| = Sets indent to next indent level.
+--------------------------------------+-----------------+---------------+----------------------------------+
| Option | Values | Default | Description |
+======================================+=================+===============+==================================+
| |align_with_end_of_declarative_part| | |boolean_value| | :code:`False` | * |align_with_end_of_part_True| |
| | | | * |align_with_end_of_part_False| |
+--------------------------------------+-----------------+---------------+----------------------------------+
| |align_with_end_of_statement_part| | |boolean_value| | :code:`False` | * |align_with_end_of_part_True| |
| | | | * |align_with_end_of_part_False| |
+--------------------------------------+-----------------+---------------+----------------------------------+
This is an example of how to configure these options.
.. code-block:: yaml
indent:
options:
comment:
align_with_end_of_declarative_part: False
align_with_end_of_statement_part: False
The following code snippet is used for all examples.
.. code-block:: vhdl
architecture rtl of fifo is
signal a : std_logic;
-- end of signal declarations
begin
o_output <= a;
-- end of output assignments
end architecture rtl;
Example: |align_with_end_of_declarative_part| set to |True|
###########################################################
The |align_with_end_of_declarative_part| option controls the indent of comments at the end of a declarative part.
Setting this option to |True| will set the indent of the comment to the previous indent level.
.. code-block:: vhdl
architecture rtl of fifo is
signal a : std_logic;
-- end of signal declarations
begin
o_output <= a;
-- end of output assignments
end architecture rtl;
Example: |align_with_end_of_declarative_part| set to |False|
############################################################
The |align_with_end_of_declarative_part| option controls the indent of comments at the end of a declarative part.
Setting this option to |False| will set the indent of the comment to the next indent level.
.. code-block:: vhdl
architecture rtl of fifo is
signal a : std_logic;
-- end of signal declarations
begin
o_output <= a;
-- end of output assignments
end architecture rtl;
Example: |align_with_end_of_statement_part| set to |True|
#########################################################
The |align_with_end_of_statement_part| option controls the indent of comments at the end of a statement part.
Setting this option to |True| will set the indent of the comment to the previous indent level.
.. code-block:: vhdl
architecture rtl of fifo is
signal a : std_logic;
-- end of signal declarations
begin
o_output <= a;
-- end of output assignments
end architecture rtl;
Example: |align_with_end_of_statement_part| set to |False|
##########################################################
The |align_with_end_of_statement_part| option controls the indent of comments at the end of a statement part.
Setting this option to |False| will set the indent of the comment to the next indent level.
.. code-block:: vhdl
architecture rtl of fifo is
signal a : std_logic;
-- end of signal declarations
begin
o_output <= a;
-- end of output assignments
end architecture rtl;
Rules Enforcing Comment Indenting
#################################
* `comment_010 <comment_rules.html#comment-010>`_

View File

@ -59,7 +59,7 @@ There are several options to these rules:
:code:`yes`
.. |default_no| replace::
:code:`no`
:code:`no`
+-----------------------+----------+---------------+------------------------------+
| Option | Values | Default | Description |
@ -100,12 +100,12 @@ The following code snippet is used for all examples and is formatted with the co
output <= '1' when input = "0000" or (input = "1111" and
input2 = "0101") else
sig_a or sig_b when input = "0001" and
sig_a or sig_b when input = "0001" and
input2 = "1001" else
sig_c and sig_d when input = "0010" else
'0';
.. NOTE:: Formatting in the following exampes is performed by a separate rule.
.. NOTE:: Formatting in the following examples is performed by a separate rule.
Example: |align_left| set to |default_yes|
##########################################
@ -225,4 +225,3 @@ Rules Enforcing Conditional Expression Alignment
* `concurrent_009 <concurrent_rules.html#concurrent-009>`_
* `sequential_401 <sequential_rules.html#sequential-401>`_
* `variable_assignment_400 <variable_assignment_400.html#variable-assignment-400>`_

View File

@ -59,6 +59,9 @@ Rules Disabled by Default
* `generic_map_601 <generic_map_rules.html#generic-map-601>`_
* `instantiation_600 <instantiation_rules.html#instantiation-600>`_
* `instantiation_601 <instantiation_rules.html#instantiation-601>`_
* `interface_incomplete_type_declaration_600 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-600>`_
* `interface_incomplete_type_declaration_601 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-601>`_
* `library_012 <library_rules.html#library-012>`_
* `loop_statement_006 <loop_statement_rules.html#loop-statement-006>`_
* `loop_statement_007 <loop_statement_rules.html#loop-statement-007>`_
* `loop_statement_600 <loop_statement_rules.html#loop-statement-600>`_
@ -69,6 +72,8 @@ Rules Disabled by Default
* `package_017 <package_rules.html#package-017>`_
* `package_body_600 <package_body_rules.html#package-body-600>`_
* `package_body_601 <package_body_rules.html#package-body-601>`_
* `package_instantiation_600 <package_instantiation_rules.html#package-instantiation-600>`_
* `package_instantiation_601 <package_instantiation_rules.html#package-instantiation-601>`_
* `port_011 <port_rules.html#port-011>`_
* `port_025 <port_rules.html#port-025>`_
* `port_600 <port_rules.html#port-600>`_
@ -90,11 +95,13 @@ Rules Disabled by Default
* `signal_600 <signal_rules.html#signal-600>`_
* `subtype_004 <subtype_rules.html#subtype-004>`_
* `subtype_100 <subtype_rules.html#subtype-100>`_
* `subtype_200 <subtype_rules.html#subtype-200>`_
* `subtype_600 <subtype_rules.html#subtype-600>`_
* `type_015 <type_rules.html#type-015>`_
* `type_100 <type_rules.html#type-100>`_
* `type_200 <type_rules.html#type-200>`_
* `type_600 <type_rules.html#type-600>`_
* `use_clause_001 <use_clause_rules.html#use-clause-001>`_
* `variable_012 <variable_rules.html#variable-012>`_
* `variable_100 <variable_rules.html#variable-100>`_
* `variable_600 <variable_rules.html#variable-600>`_

View File

@ -89,7 +89,7 @@ The following code snippet is used in the following examples:
signal wr_empty : std_logic;
signal rd_empty : std_logic;
Example: |compact_alignment| set to |yes|
#########################################
@ -105,7 +105,7 @@ Example: |compact_alignment| set to |yes|
signal wr_empty : std_logic;
signal rd_empty : std_logic;
Example: |blank_line_ends_group| set to |yes| others set to |no|
################################################################
@ -148,3 +148,4 @@ Rules Enforcing Identifier Alignment
* `package_019 <package_rules.html#package-019>`_
* `package_body_400 <package_body_rules.html#package-body-400>`_
* `procedure_010 <procedure_rules.html#procedure-010>`_
* `protected_type_body_400 <protected_type_body_rules.html#protected-type-body-400>`_

View File

@ -39,7 +39,7 @@ The :code:`indent_style` option can be set globally for all rules and locally fo
.. code-block:: yaml
rules:
rule:
global:
indent_style: 'smart_tabs'
indent_size: 2
@ -65,9 +65,9 @@ Setting the |option| option to |spaces| will result in leading whitespace being
begin
\tb <= "1000" when a = "00" else
\t\t"0100" when a = "01" else
\t\t"0010" when a = "10" else
\tb <= "1000" when a = "00" else
\t\t"0100" when a = "01" else
\t\t"0010" when a = "10" else
\t\t"0001" when a = "11";
end architecture rtl;
@ -82,9 +82,9 @@ Setting the |option| option to |spaces| will result in leading whitespace being
begin
b <= "1000" when a = "00" else
"0100" when a = "01" else
"0010" when a = "10" else
b <= "1000" when a = "00" else
"0100" when a = "01" else
"0010" when a = "10" else
"0001" when a = "11";
end architecture rtl;
@ -105,13 +105,13 @@ Tabs set the indent and spaces are used for alignment.
begin
b <= "1000" when a = "00" else
"0100" when a = "01" else
"0010" when a = "10" else
b <= "1000" when a = "00" else
"0100" when a = "01" else
"0010" when a = "10" else
"0001" when a = "11";
end architecture rtl;
**Fix**
.. code-block:: text
@ -122,10 +122,9 @@ Tabs set the indent and spaces are used for alignment.
begin
\tb <= "1000" when a = "00" else
\t "0100" when a = "01" else
\t "0010" when a = "10" else
\tb <= "1000" when a = "00" else
\t "0100" when a = "01" else
\t "0010" when a = "10" else
\t "0001" when a = "11";
end architecture rtl;

View File

@ -5,7 +5,7 @@ Configuring Indentation
-----------------------
VSG follows a predefined set of rules when indenting VHDL code.
The indenting alogrithm is driven by a YAML file.
The indenting algorithm is driven by a YAML file.
The indent values feeding the algorithm can be obtained by using the **-oc** command line argument.
There will be a section starting with **indent**.
@ -46,7 +46,7 @@ where:
| | "+<integer>" | |
| | "-<integer>" | |
+-------------+--------------+-------------------------------------------------------------------+
The **group_name** and **token_name** keys provide unique identifier which can be matched to types of tokens after the file has been parsed.
There are more tokens than are currently defined in the indent configuration, as not all tokens require indenting rules.
@ -139,7 +139,7 @@ This file can then be applied with the **-c** option.
Example 2
#########
Instantions default the indentation of port map and generic map to one more than the label:
Instantiations default the indentation of port map and generic map to one more than the label:
.. code-block:: vhdl
@ -182,33 +182,33 @@ In this case, there is a file named `component_instantiation_statement.py` file:
.. code-block:: python
from vsg import parser
class instantiation_label(parser.label):
'''
unique_id = component_instantiation_statement : instantiation_label
'''
def __init__(self, sString):
parser.label.__init__(self, sString)
super().__init__(sString)
class label_colon(parser.label_colon):
'''
unique_id = component_instantiation_statement : label_colon
'''
def __init__(self):
parser.label_colon.__init__(self)
super().__init__()
class semicolon(parser.semicolon):
'''
unique_id = component_instantiation_statement : semicolon
'''
def __init__(self, sString=None):
parser.semicolon.__init__(self)
super().__init__()
Export indent configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -260,7 +260,7 @@ Update indent configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^
The default indent is to increase the indent by 1 after the `instantiation_label` is found and then decrease the indent by 1 when the `semicolon` is found.
To enforce the desired indent, change the `after` entiry for both `instantiation_label` and `semicolon` to `"current"`.
To enforce the desired indent, change the `after` entry for both `instantiation_label` and `semicolon` to `"current"`.
Using `"current"` tells VSG to not change the indent after the label and semicolon are encountered.
Extract the `component_instantiation_statement` section out of the JSON file and save it to a new configuration file or add it to an existing one.
@ -299,25 +299,25 @@ Using the above configuration on the following file...
architecture rtl of fifo is
begin
U_FIFO : FIFO
generic map ();
a <= b;
U_FIFO : FIFO
port map ();
a <= b;
U_FIFO : FIFO
generic map ()
port map ();
a <= b;
end architecture rtl;
...results in the following updates:
@ -325,23 +325,23 @@ Using the above configuration on the following file...
.. code-block:: vhdl
architecture rtl of fifo is
begin
u_fifo : component fifo
generic map ();
a <= b;
u_fifo : component fifo
port map ();
a <= b;
u_fifo : component fifo
generic map ()
port map ();
a <= b;
end architecture rtl;

View File

@ -41,10 +41,10 @@ There are several options to these rules:
:code:`separate_generic_port_alignment`
.. |separate_generic_port_alignment__yes| replace::
:code:`yes` = stop if port keyword detected.
:code:`yes` = stop if **port** keyword detected.
.. |separate_generic_port_alignment__no| replace::
:code:`no` = continue if port keyword detected.
:code:`no` = continue if **port** keyword detected.
.. |if_control_statements_ends_group| replace::
:code:`if_control_statements_ends_group`
@ -904,7 +904,7 @@ In the example below, the others aggregates are ignored which will allow the ENU
Example: |align_to| set to :code:`current_indent`
#################################################
For example in rule :code:`process_028` the close parenthesis will be aligned with the process keyword.
For example in rule :code:`process_028` the close parenthesis will be aligned with the **process** keyword.
**Violation**
@ -986,7 +986,11 @@ Rules Enforcing Keyword Alignment
* `process_035 <process_rules.html#process-035>`_
* `process_400 <process_rules.html#process-400>`_
* `process_401 <process_rules.html#process-401>`_
* `protected_type_body_401 <protected_type_body_rules.html#protected-type-body-401>`_
* `protected_type_body_402 <protected_type_body_rules.html#protected-type-body-402>`_
* `sequential_400 <sequential_rules.html#sequential-400>`_
* `signal_401 <signal_rules.html#signal-401>`_
* `subprogram_body_400 <subprogram_body_rules.html#subprogram-body-400>`_
* `subprogram_body_401 <subprogram_body_rules.html#subprogram-body-401>`_
* `type_400 <type_rules.html#type-400>`_
* `variable_401 <variable_rules.html#variable-401>`_

View File

@ -22,7 +22,7 @@ Use the following configuration to change the line length to 180.
length_001 :
length : 180
Overridding File Line Length
Overriding File Line Length
############################
Limiting the length of a VHDL file can improve readability.
@ -37,7 +37,7 @@ Use the following configuration to change the file length to 5000.
length_002 :
length : 5000
Overridding Process Line Length
Overriding Process Line Length
###############################
Limiting the length of a VHDL processes can improve readability.

View File

@ -0,0 +1,70 @@
.. _configuring-library-and-package-name-restriction-rules:
Configuring Library and Package Name Restriction Rules
------------------------------------------------------
There are rules which will check for invalid package names in library and use clauses.
These rules are disabled by default and must be enabled before they will perform any checks.
There is one option for these rules:
.. |names| replace::
:code:`names`
.. |default| replace::
:code:`std_logic_arith` for **use_clause_001**. None for **library_012**
.. |values__names| replace::
List of strings
.. |action__names| replace::
Search for libraries and packages with the user defined names
+--------------------------------------+-----------------+-----------+------------------------------------------------+
| Option | Values | Default | Description |
+======================================+=================+===========+================================================+
| |names| | |values__names| | |default| | * |action__names| |
+--------------------------------------+-----------------+-----------+------------------------------------------------+
This is an example of how to configure the option.
.. code-block:: yaml
rule :
library_012:
names:
- "work"
- "std_logic_arith"
.. NOTE:: All examples below are using the rule **use_clause_001**.
Example: |names| set to list ["std_logic_arith"]
################################################
The following code would fail with this option:
.. code-Block:: vhdl
library ieee;
use ieee.std_logic_arith.all;
Example: |names| set to ["std_logic_arith", "my_package"]
##############################################
The following code would fail three times with this option:
.. code-block:: vhdl
library ieee;
use ieee.std_logic_arith.all;
library work;
use work.my_package.all;
Rules Enforcing Valid Names
###########################
* `library_012 <library_rules.html#library-012>`_
* `use_clause_001 <use_clause_rules.html#use-clause-001>`_

View File

@ -14,13 +14,13 @@ The method of indenting can be configured using one of the following options:
The setting :code:`left` enforces multiline report statements using indents.
.. |report_description| replace::
The setting :code:`report` aligns multiline report statements to the report keyword.
The setting :code:`report` aligns multiline report statements to the **report** keyword.
.. |values| replace::
:code:`left`, :code:`report`
.. |default_value| replace::
:code:`left`
:code:`report`
.. |report| replace::
:code:'report`
@ -46,7 +46,7 @@ This is an example of how to configure these options.
Example: |alignment| set to |report|
####################################
Align report expressions with the report keyword.
Align report expressions with the **report** keyword.
.. code-block:: vhdl
@ -58,7 +58,7 @@ Align report expressions with the report keyword.
Example: |alignment| set to |left|
##################################
Align report expressions an additional indent level from the report keyword.
Align report expressions an additional indent level from the **report** keyword.
.. code-block:: vhdl
@ -72,4 +72,3 @@ Rules Enforcing Alignment
* `assert_400 <assert_rules.html#assert-400>`_
* `report_statement_400 <report_statement_rules.html#report-statement-400>`_

View File

@ -53,7 +53,7 @@ There are several options to the structure rules:
The setting :code:`all_in_one_line` will combine :code:`array_constraints` into a single line
.. |one_line_per_dimension| replace::
The setting :code:`one_line_per_dimension` will place each dimension on it's own line
The setting :code:`one_line_per_dimension` will place each dimension on its own line
.. |exceptions| replace::
Refer to :ref:`exceptions` for more information.

View File

@ -38,10 +38,10 @@ There are several options to these rules:
+---------------+----------+---------------+----------------------+
| Option | Values | Default | Description |
+===============+==========+===============+======================+
| |align_left| | |values| | |default_yes| | * |align_left__yes| |
| |align_left| | |values| | |default_no| | * |align_left__yes| |
| | | | * |align_left__no| |
+---------------+----------+---------------+----------------------+
| |align_paren| | |values| | |default_no| | * |align_paren__yes| |
| |align_paren| | |values| | |default_yes| | * |align_paren__yes| |
| | | | * |align_paren__no| |
+---------------+----------+---------------+----------------------+
@ -127,6 +127,8 @@ Rules Enforcing Multiline Indent Rules
* `sequential_004 <sequential_rules.html#sequential-004>`_
* `sequential_402 <sequential_rules.html#sequential-402>`_
* `signal_400 <signal_rules.html#signal-400>`_
* `signal_402 <signal_rules.html#signal-402>`_
* `variable_400 <signal_rules.html#variable-400>`_
* `variable_402 <variable_rules.html#variable-402>`_
* `variable_assignment_004 <variable_assignment_rules.html#variable-assignment-004>`_
* `variable_assignment_401 <variable_assignment_rules.html#variable-assignment-401>`_

View File

@ -5,7 +5,7 @@ Configuring Number of Signals in Signal Declaration
---------------------------------------------------
VHDL allows of any number of signals to be declared within a single signal declaration.
While this may be allowed, in practice there are limits impossed by the designers.
While this may be allowed, in practice there are limits imposed by the designers.
Limiting the number of signals declared improves the readability of VHDL code.
The default number of signals allowed, 2, can be set by configuring rule **signal_015**.

View File

@ -0,0 +1,30 @@
.. _configuring-number-of-variables-in-variable-declaration:
Configuring Number of Variables in Variable Declaration
-------------------------------------------------------
VHDL allows of any number of variables to be declared within a single variable declaration.
While this may be allowed, in practice there are limits imposed by the designers.
Limiting the number of variables declared improves the readability of VHDL code.
The default number of variables allowed, 2, can be set by configuring rule **variable_015**.
Overriding Number of variables
##############################
The default setting can be changed using a configuration.
We can use the following configuration to change the number of variables allowed to 1.
.. code-block:: yaml
---
rule :
variable_015 :
consecutive : 1
Rules Enforcing Number of variables
###################################
* `variable_015 <variable_rules.html#variable-015>`_

View File

@ -89,19 +89,23 @@ Rules Enforcing Optional Items
* `block_002 <block_rules.html#block-002>`_
* `block_007 <block_rules.html#block-007>`_
* `component_021 <component_rules.html#component-021>`_
* `component_022 <component_rules.html#component-022>`_
* `context_021 <context_rules.html#context-021>`_
* `context_022 <context_rules.html#context-022>`_
* `entity_015 <entity_rules.html#entity-015>`_
* `entity_019 <entity_rules.html#entity-019>`_
* `function_018 <function_rules.html#function-018>`_
* `function_020 <function_rules.html#function-020>`_
* `generate_011 <generate_rules.html#generate-011>`_
* `instantiation_033 <instantiation_rules.html#instantiation-033>`_
* `instantiation_036 <instantiation_rules.html#instantiation-036>`_
* `loop_statement_007 <loop_statement_rules.html#loop-statement-007>`_
* `package_007 <package_rules.html#package-007>`_
* `package_014 <package_rules.html#package-014>`_
* `package_body_002 <package_body_rules.html#package-body-002>`_
* `package_body_003 <package_body_rules.html#package-body-003>`_
* `procedure_012 <procedure_rules.html#procedure-012>`_
* `procedure_014 <procedure_rules.html#procedure-014>`_
* `process_012 <process_rules.html#process-012>`_
* `process_018 <process_rules.html#process-018>`_
* `record_type_definition_005 <record_type_definition_rules.html#record-type-definition-005>`_

View File

@ -1,7 +1,7 @@
Overview
========
VSG can use a configuration file to alter it's behavior and/or include a list of files to analyze.
VSG can use a configuration file to alter its behavior and/or include a list of files to analyze.
This is accomplished by passing JSON and/or YAML file(s) through the **--configuration** command line argument.
This is the basic form of a configuration file in JSON:
@ -10,18 +10,22 @@ This is the basic form of a configuration file in JSON:
{
"file_list": [
"fifo.vhd",
"source/spi.vhd": {
"rule": {
"ruleId_ruleNumber": "blah"
{
"source/spi.vhd": {
"rule": {
"ruleId_ruleNumber": "blah"
}
}
},
"$PATH_TO_FILE/spi_master.vhd",
"$OTHER_PATH/src/*.vhd"
],
"file_rules": [
"source/i2c.vhd": {
"rule": {
"ruleId_ruleNumber": "blah"
{
"source/i2c.vhd": {
"rule": {
"ruleId_ruleNumber": "blah"
}
}
}
],
@ -120,7 +124,7 @@ rule
Any attribute of any rule can be configured.
Using **global** will set the attribute for every rule.
Using **group** will set attributes for groups of rules.
Each rule is addressable by using it's unique **ruleId** and **ruleNumber** combination. For example, whitespace_006 or port_010.
Each rule is addressable by using its unique **ruleId** and **ruleNumber** combination. For example, whitespace_006 or port_010.
.. NOTE::
If **global** and unique attributes are set at the same time, the unique attribute will take precedence.
@ -192,12 +196,14 @@ If the same rule is defined in all four locations as in the example below, then
{
"file_list": [
"entity.vhd": {
"rule": {
"length_001":{
"disable": true
{
"entity.vhd": {
"rule": {
"length_001":{
"disable": true
}
}
}
}
},
"architecture.vhd",
"package.vhd"

View File

@ -0,0 +1,118 @@
.. _configuring-port-map-new-line:
Configuring Port Map New Line
-----------------------------
There is a rule which will check for new lines before the **port** keyword in port map aspects relative to what preceded it.
.. code-block:: text
block_header ::=
[ generic_clause [ generic_map_aspect ; ] ]
[ port_clause [ port_map_aspect ; ] ]
component_instantiation_statement ::=
instantiation_label :
instantiated_unit
[ generic_map_aspect ]
[ port_map_aspect ]
There are separate rules for the structure of the constraint and the indenting.
Both rules are required to ensure proper formatting of multiline constraints.
There are several options to the structure rules:
.. |values| replace::
:code:`add_new_line`, :code:`remove_new_line`
.. |add_new_line| replace::
The setting :code:`add_new_line` enforces a carriage return (alias "new line") [and, consequently by indentation rules kicking in, also (indirectly) enforces the indentation of the new line]
.. |remove_new_line| replace::
The setting :code:`remove_new_line` enforces the removal of any potential space and carriage return
.. |default_value| replace::
:code:`add_new_line`
+---------------------------------------+-----------+----------------------------+----------------------------+
| Option | Values | Default Value | Description |
+=======================================+===========+============================+============================+
| :code:`after_port_clause` | |values| | |default_value| | * |add_new_line| |
+---------------------------------------+ | | * |remove_new_line| |
| :code:`after_instantiated_unit` | | | |
+---------------------------------------+ | | |
| :code:`after_generic_map_aspect` | | | |
+---------------------------------------+-----------+----------------------------+----------------------------+
Example: :code:`after_port_clause` set to :code:`remove_new_line`
#################################################################
Setting the :code:`after_port_clause` option to :code:`remove_new_line` will result in the following formatting:
.. code-block:: vhdl
port (
); port map (
)
Example: :code:`after_port_clause` set to :code:`add_new_line`
##############################################################
Setting the :code:`after_port_clause` option to :code:`add_new_line` will result in the following formatting:
.. code-block:: vhdl
port (
);
port map (
)
Example: :code:`after_instantiated_unit` set to :code:`remove_new_line`
#######################################################################
Setting the :code:`after_instantiated_unit` option to :code:`remove_new_line` will result in the following formatting:
.. code-block:: vhdl
U_FIFO : FIFO port map (
)
Example: :code:`after_instantiated_unit` set to :code:`add_new_line`
####################################################################
Setting the :code:`after_instantiated_unit` option to :code:`add_new_line` will result in the following formatting:
.. code-block:: vhdl
U_FIFO : FIFO
port map (
)
Example: :code:`after_generic_map_aspect` set to :code:`remove_new_line`
########################################################################
Setting the :code:`after_generic_map_aspect` option to :code:`remove_new_line` will result in the following formatting:
.. code-block:: vhdl
generic map (
) port map (
)
Example: :code:`after_generic_map_aspect` set to :code:`add_new_line`
#####################################################################
Setting the :code:`after_generic_map_aspect` option to :code:`add_new_line` will result in the following formatting:
.. code-block:: vhdl
generic map (
)
port map (
)
Rules Enforcing This Configuration
##################################
* `instantiation_005 <instantiation_rules.html#instantiation-005>`_

View File

@ -93,8 +93,8 @@ would result in the following format being enforced:
O_OUTPUT : out std_logic;
IO_INOUT : inout std_logic;
Rules Enforcing Aligment
########################
Rules Enforcing Alignment
#########################
* `port_007 <port_rules.html#port-007>`_
* `port_008 <port_rules.html#port-008>`_

View File

@ -5,7 +5,7 @@ Configuring Pragmas
-------------------
Pragmas are comments with meta data used by various vendors.
These pragmas communicate information which can change how vendor tools interprate code.
These pragmas communicate information which can change how vendor tools interpret code.
There does not appear to be a standard for defining pragmas.
This presents a challenge to detecting them across all vendor tools.
@ -68,4 +68,3 @@ Rules Using Pragmas
* `pragma_401 <pragma_rules.html#pragma-401>`_
* `pragma_402 <pragma_rules.html#pragma-402>`_
* `pragma_403 <pragma_rules.html#pragma-403>`_

View File

@ -54,48 +54,52 @@ Exceptions to enforcing prefixes and suffixes can be given using the :code:`exce
# Each suffix rule needs to be enabled explicitly.
disable: false
suffixes: ['_i', '_o']
exceptions: ['CLK']
exceptions: ['CLK', '.*_FIELD']
The exceptions option provides a list of keywords, that when matched, prevents the rule from validating the prefix or suffix.
The keywords are treated as case insensitive.
The keywords are treated as case insensitive and support regular expressions.
Rules Enforcing Prefixes and Suffixes
#####################################
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| **Element** | **Prefix Rule** | **Suffix Rule** |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Block Label | `block_601 <block_rules.html#block-601>`_ | `block_600 <block_rules.html#block-600>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Constant Identifier | `constant_015 <constant_rules.html#constant-015>`_ | `constant_600 <constant_rules.html#constant-600>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Function Designator | `function_600 <function_rules.html#function-600>`_ | `function_601 <function_rules.html#function-601>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Generate Label | `generate_017 <generate_rules.html#generate-017>`_ | `generate_600 <generate_rules.html#generate-600>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Generate Parameter Identifier | `generate_601 <generate_rules.html#generate-601>`_ | `generate_602 <generate_rules.html#generate-602>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Generic Identifier | `generic_020 <generic_rules.html#generic-020>`_ | `generic_600 <generic_rules.html#generic-600>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Generic Map Identifier | `generic_map_601 <generic_map_rules.html#generic-map-601>`_ | `generic_map_600 <generic_map_rules.html#generic-map-600>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Loop Label | `loop_600 <loop_statement_rules.html#loop-statement-600>`_ | `loop_601 <loop_statement_rules.html#loop-statement-601>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Loop Parameter Identifier | `loop_602 <loop_statement_rules.html#loop-statement-602>`_ | `loop_603 <loop_statement_rules.html#loop-statement-603>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Package Identifier | `package_017 <package_rules.html#package-017>`_ | `package_016 <package_rules.html#package-016>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Package Body Identifier | `package_body_601 <package_body_rules.html#package-body-601>`_ | `package_body_600 <package_body_rules.html#package-body-600>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Port Identifier | `port_011 <port_rules.html#port-011>`_ | `port_025 <port_rules.html#port-025>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Process Label | `process_036 <process_rules.html#process-036>`_ | `process_600 <process_rules.html#process-600>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Signal Identifier | `signal_008 <signal_rules.html#signal-008>`_ | `signal_600 <signal_rules.html#signal-600>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Subtype Identifier | `subtype_004 <subtype_rules.html#subtype-004>`_ | `subtype_600 <subtype_rules.html#subtype-600>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Type Identifier | `type_definition_015 <type_rules.html#type-015>`_ | `type_definition_600 <type_rules.html#type-600>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Variable Identifier | `variable_012 <variable_rules.html#variable-012>`_ | `variable_600 <variable_rules.html#variable-600>`_ |
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| **Element** | **Prefix Rule** | **Suffix Rule** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Block Label | `block_601 <block_rules.html#block-601>`_ | `block_600 <block_rules.html#block-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Constant Identifier | `constant_015 <constant_rules.html#constant-015>`_ | `constant_600 <constant_rules.html#constant-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Function Designator | `function_600 <function_rules.html#function-600>`_ | `function_601 <function_rules.html#function-601>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Generate Label | `generate_017 <generate_rules.html#generate-017>`_ | `generate_600 <generate_rules.html#generate-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Generate Parameter Identifier | `generate_601 <generate_rules.html#generate-601>`_ | `generate_602 <generate_rules.html#generate-602>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Generic Identifier | `generic_020 <generic_rules.html#generic-020>`_ | `generic_600 <generic_rules.html#generic-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Generic Map Identifier | `generic_map_601 <generic_map_rules.html#generic-map-601>`_ | `generic_map_600 <generic_map_rules.html#generic-map-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Loop Label | `loop_600 <loop_statement_rules.html#loop-statement-600>`_ | `loop_601 <loop_statement_rules.html#loop-statement-601>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Loop Parameter Identifier | `loop_602 <loop_statement_rules.html#loop-statement-602>`_ | `loop_603 <loop_statement_rules.html#loop-statement-603>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Generic Type Identifier | `interface_incomplete_type_declaration_600 <interface_incomplete_type_declaration.html#interface-incomplete-type-declaration-600>`_ | `interface_incomplete_type_declaration_601 <interface_incomplete_type_declaration.html#interface-incomplete-type-declaration-601>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Package Identifier | `package_017 <package_rules.html#package-017>`_ | `package_016 <package_rules.html#package-016>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Package Body Identifier | `package_body_601 <package_body_rules.html#package-body-601>`_ | `package_body_600 <package_body_rules.html#package-body-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Package Instantiation Identifier | `package_instantiation_601 <package_instantiation_rules.html#package-instantiation-601>`_ | `package_instantiation_600 <package_instantiation_rules.html#package-instantiation-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Port Identifier | `port_011 <port_rules.html#port-011>`_ | `port_025 <port_rules.html#port-025>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Process Label | `process_036 <process_rules.html#process-036>`_ | `process_600 <process_rules.html#process-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Signal Identifier | `signal_008 <signal_rules.html#signal-008>`_ | `signal_600 <signal_rules.html#signal-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Subtype Identifier | `subtype_004 <subtype_rules.html#subtype-004>`_ | `subtype_600 <subtype_rules.html#subtype-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Type Identifier | `type_definition_015 <type_rules.html#type-015>`_ | `type_definition_600 <type_rules.html#type-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Variable Identifier | `variable_012 <variable_rules.html#variable-012>`_ | `variable_600 <variable_rules.html#variable-600>`_ |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+

View File

@ -59,10 +59,10 @@ There are several options to these rules, which can be selected by using the :co
+======================+================+===================+===================================================+
| |style| | |style_values| | |default_value| | * |style__no_blank_line| |
| | | | * |style__require_blank_line| |
| | | | * |style__no_code| |
| | | | * |style__allow_comment| |
| | | | * |style__require_comment| |
| | | | * |style__no_blank_line_unless_different_library| |
| | | | * |style__no_code| |
| | | | * |style__allow_comment| |
| | | | * |style__require_comment| |
| | | | * |style__no_blank_line_unless_different_library| |
+----------------------+----------------+-------------------+---------------------------------------------------+
.. NOTE:: Unless stated in the rule description, the default style is :code:`require_blank_line`.
@ -241,6 +241,7 @@ Rules Enforcing Previous Lines
* `block_200 <block_rules.html#block-200>`_
* `case_007 <case_rules.html#case-007>`_
* `case_201 <case_rules.html#case-201>`_
* `case_generate_alternative_201 <case_generate_alternative_rules.html#case-generate-alternative-201>`_
* `component_003 <component_rules.html#component-003>`_
* `context_003 <context_rules.html#context-003>`_
* `entity_003 <entity_rules.html#entity-003>`_
@ -254,9 +255,11 @@ Rules Enforcing Previous Lines
* `loop_statement_202 <loop_statement_rules.html#loop-statement-202>`_
* `package_003 <package_rules.html#package-003>`_
* `package_body_200 <package_body_rules.html#package-body-200>`_
* `pragma_400 <../pragma_rules.html#pragma-400>`_
* `pragma_402 <../pragma_rules.html#pragma-402>`_
* `package_instantiation_200 <package_instantiation_rules.html#package-instantiation-200>`_
* `pragma_400 <pragma_rules.html#pragma-400>`_
* `pragma_402 <pragma_rules.html#pragma-402>`_
* `procedure_200 <procedure_rules.html#procedure-200>`_
* `process_015 <process_rules.html#process-015>`_
* `record_type_definition_201 <record_type_definition_rules.html#record-type-definition-201>`_
* `subtype_201 <subtype_rules.html#subtype-201>`_
* `type_010 <type_rules.html#type-010>`_

View File

@ -28,4 +28,3 @@ The following example configures the rules to:
disable: True
naming:
disable: True

View File

@ -636,4 +636,4 @@ The above configuration when applied to the code snippet will result in the foll
Rules Enforcing Selected Assignment Structure Rules
###################################################
* `selected_assignment_001 <selected_assingment_rules.html#selected-assignment-001>`_
* `selected_assignment_001 <selected_assignment_rules.html#selected-assignment-001>`_

View File

@ -7,10 +7,10 @@ Configuring Simple Multiline Structure Rules
:code:`new_line_after_assign`
.. |new_line_after_assign__yes| replace::
:code:`yes` = Adds a carriage return (alias "new line") after the assigment operator.
:code:`yes` = Adds a carriage return (alias "new line") after the assignment operator.
.. |new_line_after_assign__no| replace::
:code:`no` = Removes a carriage return (alias "new line") after the assigment operator.
:code:`no` = Removes a carriage return (alias "new line") after the assignment operator.
.. |new_line_after_assign__ignore| replace::
:code:`ignore` = Ignores any formatting after the assignment operator.
@ -43,7 +43,7 @@ There are several options to these rules:
+-------------------------+-------------+---------------+-----------------------------------+
| Method | Values | Default | Description |
+=========================+=============+===============+===================================+
| |new_line_after_assign| | |values1| | |default_yes| | * |new_line_after_assign__yes| |
| |new_line_after_assign| | |values1| | |default_no| | * |new_line_after_assign__yes| |
| | | | * |new_line_after_assign__no| |
| | | | * |new_line_after_assign__ignore| |
+-------------------------+-------------+---------------+-----------------------------------+

View File

@ -41,7 +41,7 @@ This is an example of how to configure these options.
.. code-block:: yaml
rule :
instantiation_010:
instantiation_034:
method: 'component'
Example: |method| set to |component_option|

View File

@ -23,14 +23,20 @@ There are several options to these rules:
.. |camelCase_value| replace::
:code:`camelCase`
.. |relaxedCamelCase_value| replace::
:code:`relaxedCamelCase`
.. |PascalCase_value| replace::
:code:`PascalCase`
.. |upper_snake_case_value| replace::
:code:`UPPER_SNAKE_CASE`
.. |RelaxedPascalCase_value| replace::
:code:`RelaxedPascalCase`
.. |lower_snake_case_value| replace::
:code:`lower_snake_case`
.. |PascalSnakeCase_value| replace::
:code:`Pascal_Snake_Case`
.. |regex_value| replace::
:code:`regex`
.. |case_option__upper| replace::
|upper_value| = Enforce upper case
@ -42,13 +48,25 @@ There are several options to these rules:
|upper_or_lower_value| = Allow upper or lower case
.. |case_option__camelCase| replace::
|camelCase_value| = Enforce camelCase
|camelCase_value| = Enforce camelCase with two allowed uppercase characters in a row
.. |case_option__relaxedCamelCase| replace::
|relaxedCamelCase_value| = Enforce camelCase with any number of uppercase characters in a row
.. |case_option__PascalCase| replace::
|PascalCase_value| = Enforce PascalCase
|PascalCase_value| = Enforce PascalCase with two allowed uppercase characters in a row
.. |case_option__RelaxedPascalCase| replace::
|RelaxedPascalCase_value| = Enforce PascalCase with any number of uppercase characters in a row
.. |case_option__PascalSnakeCase| replace::
|PascalSnakeCase_value| = Enforce Pascal_Snake_Case
.. |case_option__regex| replace::
|regex_value| = Enforce user defined regex
.. |case_values| replace::
|upper_value|, |lower_value|, |upper_or_lower_value|, |camelCase_value|, |PascalCase_value|
|upper_value|, |lower_value|, |upper_or_lower_value|, |camelCase_value|, |relaxedCamelCase_value|, |PascalCase_value|, |RelaxedPascalCase_value|, |regex_value|
.. |case_default_value| replace::
|lower_value|
@ -83,28 +101,45 @@ There are several options to these rules:
.. |ce_values| replace::
List of strings
.. |regex_values| replace::
String
.. |ce_default_value| replace::
Empty list
.. |regex_default_value| replace::
Empty String
.. |ce_description| replace::
Enforce case for items in the list.
+----------------------------+------------------------+----------------------+-----------------------------------+
| Option | Values | Default Value | Description |
+============================+========================+======================+===================================+
| |case_option| | |case_values| | |case_default_value| | * |case_option__upper| |
| | | | * |case_option__lower| |
| | | | * |case_option__upper_or_lower| |
| | | | * |case_option__camelCase| |
| | | | * |case_option__PascalCase| |
+----------------------------+------------------------+----------------------+-----------------------------------+
| |prefix_exceptions_option| | |pe_values| | |pe_default_value| | |pe_description| |
+----------------------------+------------------------+----------------------+-----------------------------------+
| |suffix_exceptions_option| | |se_values| | |se_default_value| | |se_description| |
+----------------------------+------------------------+----------------------+-----------------------------------+
| |case_exceptions_option| | |ce_values| | |ce_default_value| | |ce_description| |
+----------------------------+------------------------+----------------------+-----------------------------------+
.. |regex_option| replace::
:code:`regex`
.. |regex_description| replace::
Enforce case based on regex string
+----------------------------+---------------------------+-----------------------+------------------------------------+
| Option | Values | Default Value | Description |
+============================+===========================+=======================+====================================+
| |case_option| | |upper_value| | |case_default_value| | * |case_option__upper| |
| | |lower_value| | | * |case_option__lower| |
| | |upper_or_lower_value| | | * |case_option__upper_or_lower| |
| | |camelCase_value| | | * |case_option__camelCase| |
| | |relaxedCamelCase_value| | | * |case_option__relaxedCamelCase| |
| | |PascalCase_value| | | * |case_option__PascalCase| |
| | |RelaxedPascalCase_value| | | * |case_option__RelaxedPascalCase| |
| | |PascalSnakeCase_value| | | * |case_option__PascalSnakeCase| |
| | |regex_value| | | * |case_option__regex| |
+----------------------------+---------------------------+-----------------------+------------------------------------+
| |prefix_exceptions_option| | |pe_values| | |pe_default_value| | |pe_description| |
+----------------------------+---------------------------+-----------------------+------------------------------------+
| |suffix_exceptions_option| | |se_values| | |se_default_value| | |se_description| |
+----------------------------+---------------------------+-----------------------+------------------------------------+
| |case_exceptions_option| | |ce_values| | |ce_default_value| | |ce_description| |
+----------------------------+---------------------------+-----------------------+------------------------------------+
| |regex_option| | |regex_values| | |regex_default_value| | |regex_description| |
+----------------------------+---------------------------+-----------------------+------------------------------------+
This is an example of how to configure these options.
@ -118,7 +153,8 @@ This is an example of how to configure these options.
suffix_exceptions:
- '_G'
case_exceptions:
= 'IEEE'
- 'IEEE'
regex: ''
The following code snippet is used in the following examples:
@ -179,6 +215,16 @@ Example: |case_option| set to |upper_value| and |case_exceptions_option| set to
constant C_DATA_WIDTH : positive := 32;
constant addr_WIDTH_c : positive := 8;
Example: |case_option| set to |regex_value| and |regex_option| set to :code:`[A-Z][A-Za-z\d]*`
##############################################################################################
The following constant identifiers would pass with the defined regular expression.
.. code-block:: vhdl
constant SPIAccess : std_logic;
constant ADCRegisters : std_logic;
Example: Changing Multiple Case Rules
#####################################
@ -196,6 +242,8 @@ For example, if you want to uppercase everything except the entity name, you cou
Rules Enforcing Case
####################
* `after_500 <after_rules.html#after-500>`_
* `alias_declaration_500 <alias_declaration_rules.html#alias-declaration-500>`_
* `alias_declaration_501 <alias_declaration_rules.html#alias-declaration-501>`_
* `alias_declaration_502 <alias_declaration_rules.html#alias-declaration-502>`_
@ -210,6 +258,8 @@ Rules Enforcing Case
* `architecture_021 <architecture_rules.html#architecture-021>`_
* `architecture_028 <architecture_rules.html#architecture-028>`_
* `array_constraint_500 <../array_constraint_rules.html#array-constraint-500>`_
* `assert_500 <assert_rules.html#assert-500>`_
* `assert_501 <assert_rules.html#assert-501>`_
* `assert_502 <assert_rules.html#assert-502>`_
@ -225,6 +275,9 @@ Rules Enforcing Case
* `attribute_specification_502 <attribute_specification_rules.html#attribute-specification-502>`_
* `attribute_specification_503 <attribute_specification_rules.html#attribute-specification-503>`_
* `bit_string_literal_500 <bit_string_literal_rules.html#bit-string-literal-500>`_
* `bit_string_literal_501 <bit_string_literal_rules.html#bit-string-literal-501>`_
* `block_500 <block_rules.html#block-500>`_
* `block_501 <block_rules.html#block-501>`_
* `block_502 <block_rules.html#block-502>`_
@ -240,11 +293,12 @@ Rules Enforcing Case
* `case_018 <case_rules.html#case-018>`_
* `case_generate_alternative_500 <case_generate_alternative_rules.html#case-generate-alternative-500>`_
* `case_generate_alternative_501 <case_generate_alternative_rules.html#case-generate-alternative-501>`_
* `case_generate_statement_500 <case_generate_statement_rules.html#case-generate-statement-500>`_
* `case_generate_statement_501 <case_generate_statement_rules.html#case-generate-statement-501>`_
* `choice_500 <choice_rules.html#choice-500>`_
* `component_004 <component_rules.html#component-004>`_
* `component_006 <component_rules.html#component-006>`_
* `component_008 <component_rules.html#component-008>`_
@ -261,6 +315,9 @@ Rules Enforcing Case
* `constant_002 <constant_rules.html#constant-002>`_
* `constant_004 <constant_rules.html#constant-004>`_
* `constrained_array_definition_500 <constrained_array_definition_rules.html#constrained-array-definition-500>`_
* `constrained_array_definition_501 <constrained_array_definition_rules.html#constrained-array-definition-501>`_
* `context_004 <context_rules.html#context-004>`_
* `context_012 <context_rules.html#context-012>`_
* `context_013 <context_rules.html#context-013>`_
@ -272,6 +329,10 @@ Rules Enforcing Case
* `context_ref_500 <context_ref_rules.html#context-ref-500>`_
* `context_ref_501 <context_ref_rules.html#context-ref-501>`_
* `delay_mechanism_500 <delay_mechanism_rules.html#delay-mechanism-500>`_
* `delay_mechanism_501 <delay_mechanism_rules.html#delay-mechanism-501>`_
* `delay_mechanism_502 <delay_mechanism_rules.html#delay-mechanism-502>`_
* `entity_004 <entity_rules.html#entity-004>`_
* `entity_006 <entity_rules.html#entity-006>`_
* `entity_008 <entity_rules.html#entity-008>`_
@ -284,9 +345,26 @@ Rules Enforcing Case
* `entity_specification_501 <entity_specification_rules.html#entity-specification-501>`_
* `entity_specification_503 <entity_specification_rules.html#entity-specification-503>`_
* `exit_statement_500 <exit_statement_rules.html#exit-statement-500>`_
* `exit_statement_501 <exit_statement_rules.html#exit-statement-501>`_
* `exponent_500 <exponent_rules.html#exponent-500>`_
* `external_constant_name_500 <external_constant_name_rules.html#external-constant-name-500>`_
* `external_signal_name_500 <external_signal_name_rules.html#external-signal-name-500>`_
* `external_variable_name_500 <external_variable_name_rules.html#external-variable-name-500>`_
* `file_open_information_500 <file_open_information_rules.html#file-open-information-500>`_
* `file_open_information_501 <file_open_information_rules.html#file-open-information-501>`_
* `file_open_information_502 <file_open_information_rules.html#file-open-information-502>`_
* `file_002 <file_rules.html#file-002>`_
* `file_500 <file_rules.html#file-500>`_
* `file_type_definition_500 <file_type_definition_rules.html#file-type-definition-500>`_
* `file_type_definition_501 <file_type_definition_rules.html#file-type-definition-501>`_
* `for_generate_statement_500 <for_generate_statement_rules.html#for-generate-statement-500>`_
* `for_generate_statement_501 <for_generate_statement_rules.html#for-generate-statement-501>`_
@ -294,11 +372,15 @@ Rules Enforcing Case
* `function_004 <function_rules.html#function-004>`_
* `function_005 <function_rules.html#function-005>`_
* `function_013 <function_rules.html#function-013>`_
* `function_014 <function_rules.html#function-014>`_
* `function_017 <function_rules.html#function-017>`_
* `function_501 <function_rules.html#function-501>`_
* `function_502 <function_rules.html#function-502>`_
* `function_506 <function_rules.html#function-506>`_
* `function_507 <function_rules.html#function-507>`_
* `function_509 <function_rules.html#function-509>`_
* `function_510 <function_rules.html#function-510>`_
* `function_511 <function_rules.html#function-511>`_
* `function_512 <function_rules.html#function-512>`_
* `generate_005 <generate_rules.html#generate-005>`_
* `generate_009 <generate_rules.html#generate-009>`_
@ -309,13 +391,10 @@ Rules Enforcing Case
* `generic_007 <generic_rules.html#generic-007>`_
* `generic_009 <generic_rules.html#generic-009>`_
* `generic_017 <generic_rules.html#generic-017>`_
* `generic_map_001 <generic_map_rules.html#generic-map-001>`_
* `generic_map_002 <generic_map_rules.html#generic-map-002>`_
* `ieee_500 <ieee_rules.html#ieee-500>`_
* `if_generate_statement_500 <if_generate_statement_rules.html#if-generate-statement-500>`_
* `if_generate_statement_501 <if_generate_statement_rules.html#if-generate-statement-501>`_
* `if_generate_statement_502 <if_generate_statement_rules.html#if-generate-statement-502>`_
@ -328,11 +407,17 @@ Rules Enforcing Case
* `if_029 <if_rules.html#if-029>`_
* `if_034 <if_rules.html#if-034>`_
* `index_subtype_definition_500 <index_subtype_definition_rules.html#index-subtype-definition-500>`_
* `instantiation_008 <instantiation_rules.html#instantiation-008>`_
* `instantiation_009 <instantiation_rules.html#instantiation-009>`_
* `instantiation_027 <instantiation_rules.html#instantiation-027>`_
* `instantiation_028 <instantiation_rules.html#instantiation-028>`_
* `instantiation_031 <instantiation_rules.html#instantiation-031>`_
* `instantiation_500 <instantiation_rules.html#instantiation-500>`_
* `interface_incomplete_type_declaration_500 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-500>`_
* `interface_incomplete_type_declaration_501 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-501>`_
* `iteration_scheme_500 <iteration_scheme_rules.html#iteration-scheme-500>`_
* `iteration_scheme_501 <iteration_scheme_rules.html#iteration-scheme-501>`_
@ -349,6 +434,11 @@ Rules Enforcing Case
* `loop_statement_503 <loop_statement_rules.html#loop-statement-503>`_
* `loop_statement_504 <loop_statement_rules.html#loop-statement-504>`_
* `next_statement_500 <next_statement_rules.html#next-statement-500>`_
* `next_statement_501 <next_statement_rules.html#next-statement-501>`_
* `null_statement_500 <null_statement_rules.html#null-statement-500>`_
* `package_004 <package_rules.html#package-004>`_
* `package_006 <package_rules.html#package-006>`_
* `package_008 <package_rules.html#package-008>`_
@ -365,26 +455,36 @@ Rules Enforcing Case
* `package_body_506 <package_body_rules.html#package-body-506>`_
* `package_body_507 <package_body_rules.html#package-body-507>`_
* `package_instantiation_500 <package_instantiation_rules.html#package-instantiation-500>`_
* `package_instantiation_501 <package_instantiation_rules.html#package-instantiation-501>`_
* `package_instantiation_502 <package_instantiation_rules.html#package-instantiation-502>`_
* `package_instantiation_503 <package_instantiation_rules.html#package-instantiation-503>`_
* `package_instantiation_504 <package_instantiation_rules.html#package-instantiation-504>`_
* `parameter_specification_500 <parameter_specification_rules.html#parameter-specification-500>`_
* `parameter_specification_501 <parameter_specification_rules.html#parameter-specification-501>`_
* `port_010 <port_rules.html#port-010>`_
* `port_017 <port_rules.html#port-017>`_
* `port_018 <port_rules.html#port-018>`_
* `port_019 <port_rules.html#port-019>`_
* `port_map_001 <port_map_rules.html#port-map-001>`_
* `port_map_002 <port_map_rules.html#port-map-002>`_
* `procedure_008 <procedure_rules.html#procedure-008>`_
* `procedure_009 <procedure_rules.html#procedure-009>`_
* `procedure_500 <procedure_rules.html#procedure-500>`_
* `procedure_501 <procedure_rules.html#procedure-501>`_
* `procedure_502 <procedure_rules.html#procedure-502>`_
* `procedure_503 <procedure_rules.html#procedure-503>`_
* `procedure_504 <procedure_rules.html#procedure-504>`_
* `procedure_505 <procedure_rules.html#procedure-505>`_
* `procedure_506 <procedure_rules.html#procedure-506>`_
* `procedure_508 <procedure_rules.html#procedure-508>`_
* `procedure_510 <procedure_rules.html#procedure-510>`_
* `procedure_511 <procedure_rules.html#procedure-511>`_
* `procedure_call_500 <procedure_call_rules.html#procedure-call-500>`_
* `procedure_call_501 <procedure_call_rules.html#procedure-call-501>`_
* `procedure_call_502 <procedure_call_rules.html#procedure-call-502>`_
* `process_004 <process_rules.html#process-004>`_
* `process_005 <process_rules.html#process-005>`_
@ -394,6 +494,18 @@ Rules Enforcing Case
* `process_017 <process_rules.html#process-017>`_
* `process_019 <process_rules.html#process-019>`_
* `protected_type_500 <protected_type_rules.html#protected-type-500>`_
* `protected_type_501 <protected_type_rules.html#protected-type-501>`_
* `protected_type_502 <protected_type_rules.html#protected-type-502>`_
* `protected_type_body_500 <protected_type_rules.html#protected-type-body-500>`_
* `protected_type_body_501 <protected_type_rules.html#protected-type-body-501>`_
* `protected_type_body_502 <protected_type_rules.html#protected-type-body-502>`_
* `protected_type_body_503 <protected_type_rules.html#protected-type-body-503>`_
* `protected_type_body_504 <protected_type_rules.html#protected-type-body-504>`_
* `range_constraint_500 <../range_constraint_rules.html#range-constraint-500>`_
* `range_001 <range_rules.html#range-001>`_
* `range_002 <range_rules.html#range-002>`_
@ -411,18 +523,33 @@ Rules Enforcing Case
* `selected_assignment_502 <selected_assignment_rules.html#selected-assignment-502>`_
* `selected_assignment_503 <selected_assignment_rules.html#selected-assignment-503>`_
* `shift_operator_500 <shift_operator_rules.html#shift-operator-500>`_
* `signal_002 <signal_rules.html#signal-002>`_
* `signal_004 <signal_rules.html#signal-004>`_
* `subtype_500 <../subtype_rules.html#subtype-500>`_
* `subtype_501 <../subtype_rules.html#subtype-501>`_
* `subtype_502 <../subtype_rules.html#subtype-502>`_
* `subprogram_instantiation_500 <subprogram_instantiation_rules.html#subprogram-instantiation-500>`_
* `subprogram_instantiation_501 <subprogram_instantiation_rules.html#subprogram-instantiation-501>`_
* `subprogram_instantiation_502 <subprogram_instantiation_rules.html#subprogram-instantiation-502>`_
* `subprogram_instantiation_503 <subprogram_instantiation_rules.html#subprogram-instantiation-503>`_
* `subprogram_kind_500 <subprogram_kind_rules.html#subprogram-kind-500>`_
* `subprogram_kind_501 <subprogram_kind_rules.html#subprogram-kind-501>`_
* `subtype_500 <subtype_rules.html#subtype-500>`_
* `subtype_501 <subtype_rules.html#subtype-501>`_
* `subtype_502 <subtype_rules.html#subtype-502>`_
* `type_002 <type_rules.html#type-002>`_
* `type_004 <type_rules.html#type-004>`_
* `type_013 <type_rules.html#type-013>`_
* `type_500 <type_rules.html#type-500>`_
* `type_mark_500 <type_mark_rules.html#type-mark-500>`_
* `unbounded_array_definition_500 <unbounded_array_definition_rules.html#unbounded-array-definition-500>`_
* `unbounded_array_definition_501 <unbounded_array_definition_rules.html#unbounded-array-definition-501>`_
* `use_clause_500 <use_clause_rules.html#use-clause-500>`_
* `use_clause_501 <use_clause_rules.html#use-clause-501>`_
* `use_clause_502 <use_clause_rules.html#use-clause-502>`_
@ -430,3 +557,9 @@ Rules Enforcing Case
* `variable_002 <variable_rules.html#variable-002>`_
* `variable_004 <variable_rules.html#variable-004>`_
* `variable_500 <variable_rules.html#variable-500>`_
* `wait_500 <wait_rules.html#wait-500>`_
* `wait_501 <wait_rules.html#wait-501>`_
* `wait_502 <wait_rules.html#wait-502>`_
* `wait_503 <wait_rules.html#wait-503>`_

View File

@ -52,9 +52,10 @@ This is an example of how to configure these options.
indent:
tokens:
use_clause:
token_after_library_clause: '+1'
token_if_no_matching_library_clause: '+1'
use_clause:
keyword:
token_after_library_clause: '+1'
token_if_no_matching_library_clause: '+1'
The following code snippet is used for all examples.
@ -65,7 +66,6 @@ The following code snippet is used for all examples.
use work.my_package.all;
Example: |token_if_no_matching_library_clause| set to |current_value|
#####################################################################
@ -110,7 +110,7 @@ Example: |token_after_library_clause| set to :code:`'+1'`
use work.my_package.all;
Rules Enforcing Keyword Alignment
#################################
Rules Enforcing Use Clause Indenting
####################################
* `library_008 <library_rules.html#library-008>`_

View File

@ -0,0 +1,79 @@
.. _configuring-user-error-messages:
Configuring User Error Messages
-------------------------------
There is an option to provide additional information to the user when a violation is found.
This is accomplished by using the :code:`user_error_message` option.
Setting this option for a rule will append the message to the normal output.
Example without :code:`user_error_message` defined
##################################################
Applying a custom regex does not provide additional information to the user.
Given the following configuration file which defines a custom regex:
.. code-block:: yaml
rule:
group:
case::name:
case: regex
regex: (?![a-z||0-9]\u005F)(?!.*\u005F[a-z||0-9]$)([a-z||0-9]+(?:\u005F[a-z||0-9]+)*)
The following error report is generated:
.. code-block:: bash
$vsg -f original.vhd -c config.yaml
================================================================================
File: original.vhd
================================================================================
Phase 6 of 7... Reporting
Total Rules Checked: 857
Total Violations: 2
Error : 2
Warning : 0
-------------+------------+------------+--------------------------------------
Rule | severity | line(s) | Solution
-------------+------------+------------+--------------------------------------
entity_008 | Error | 2 | Format FIFO to match defined regex
entity_012 | Error | 3 | Format FIFO to match defined regex
-------------+------------+------------+--------------------------------------
NOTE: Refer to online documentation at https://vhdl-style-guide.readthedocs.io/en/latest/index.html for more information.
Example with :code:`user_error_message` defined
###############################################
Adding a custom error message can provide additional information to the user:
.. code-block:: yaml
rule:
group:
case::name:
case: regex
regex: (?![a-z||0-9]\u005F)(?!.*\u005F[a-z||0-9]$)([a-z||0-9]+(?:\u005F[a-z||0-9]+)*)
user_error_message: "UPPERCASE and single letter prefix/suffix not allowed"
The following error report is generated:
.. code-block:: bash
$vsg -f original.vhd -c config.yaml
================================================================================
File: original.vhd
================================================================================
Phase 6 of 7... Reporting
Total Rules Checked: 857
Total Violations: 2
Error : 2
Warning : 0
-------------+------------+------------+--------------------------------------
Rule | severity | line(s) | Solution
-------------+------------+------------+--------------------------------------
entity_008 | Error | 2 | Format FIFO to match defined regex [user_error_message: UPPERCASE and single letter prefix/suffix not allowed]
entity_012 | Error | 3 | Format FIFO to match defined regex [user_error_message: UPPERCASE and single letter prefix/suffix not allowed]
-------------+------------+------------+--------------------------------------
NOTE: Refer to online documentation at https://vhdl-style-guide.readthedocs.io/en/latest/index.html for more information.

View File

@ -28,11 +28,14 @@ These rules provide the following options:
.. |standard__2008| replace::
:code:`2008` = Use reserved keywords from 2008 standard
.. |standard__2019| replace::
:code:`2019` = Use reserved keywords from 2019 standard
.. |standard__all| replace::
:code:`all` = Use reserved keywords from all standards
.. |values| replace::
:code:`1987`, :code:`1993`, :code:`2000`, :code:`2002`, :code:`2008`
:code:`1987`, :code:`1993`, :code:`2000`, :code:`2002`, :code:`2008`, :code:`2019`
.. |default_value| replace::
:code:`all`
@ -45,6 +48,7 @@ These rules provide the following options:
| | | | * |standard__2000| |
| | | | * |standard__2002| |
| | | | * |standard__2008| |
| | | | * |standard__2019| |
| | | | * |standard__all| |
+----------------------+----------+-----------------+----------------------------+
@ -96,8 +100,20 @@ The :code:`context` keyword is a reserved word in the 2008 standard.
end entity;
Example: |standard_option| set to :code:`2019`
##############################################
The :code:`private` keyword is a reserved word in the 2019 standard.
**Violation**
.. code-block:: yaml
entity private is
end entity;
Rules Enforcing Optional Items
##############################
* `reserved_001 <reserved_rules.html#reserved-001>`_

View File

@ -33,7 +33,7 @@ This behavior can be modified by using the :code:`exceptions` and :code:`pattern
+==========================+=======================+==========================+
| |exceptions_option| | |exceptions_defaults| | |exceptions_description| |
+--------------------------+-----------------------+--------------------------+
| |patterns_option| | |patterns_defaults| | |patterns_description| |
| |patterns_option| | |patterns_defaults| | |patterns_description| |
+--------------------------+-----------------------+--------------------------+
This is an example of how to configure these options.

View File

@ -14,9 +14,6 @@ There are a couple of options to these rules:
| number_of_spaces | Determines the number of whitespace characters to allow. |
+--------------------------+----------------------------------------------------------+
.. | align_to_next_tab | When true, will add spaces to align with next valid tab. |
.. +--------------------------+----------------------------------------------------------+
The :code:`number_of_spaces` option can accept several values:
+-----------------------+----------------------------------------------------------+
@ -30,6 +27,10 @@ The :code:`number_of_spaces` option can accept several values:
+-----------------------+----------------------------------------------------------+
| [0-9][0-9]*+ | The minimum number of spaces to enforce. |
+-----------------------+----------------------------------------------------------+
| <[0-9][0-9]* | The maximum number of spaces to enforce. |
+-----------------------+----------------------------------------------------------+
| <=[0-9][0-9]* | The maximum number of spaces to enforce. |
+-----------------------+----------------------------------------------------------+
These options combined with the values allow complete control over the number of whitespaces allowed.
@ -90,6 +91,24 @@ The same result could be achieved using this yaml:
signal_006:
number_of_spaces: '1+'
Example: allow at most 4 spaces before colon
#############################################
.. code-block:: yaml
rule :
signal_006:
number_of_spaces: '<=4'
In this example, there must be at most four whitespaces before the colon.
The third signal declaration would be a violation.
.. code-Block:: vhdl
signal wr_en : std_logic;
signal wr_en : std_logic;
signal wr_en : std_logic;
Rules Enforcing Whitespace
##########################
@ -103,6 +122,7 @@ Rules Enforcing Whitespace
* `architecture_031 <architecture_rules.html#architecture-031>`_
* `architecture_032 <architecture_rules.html#architecture-032>`_
* `architecture_033 <architecture_rules.html#architecture-033>`_
* `array_constraint_100 <array_constraint_rules.html#array-constraint-100>`_
* `assert_100 <assert_rules.html#assert-100>`_
* `assert_101 <assert_rules.html#assert-101>`_
* `assert_102 <assert_rules.html#assert-102>`_
@ -117,6 +137,10 @@ Rules Enforcing Whitespace
* `case_004 <case_rules.html#case-004>`_
* `case_005 <case_rules.html#case-005>`_
* `case_006 <case_rules.html#case-006>`_
* `case_generate_alternative_100 <case_generate_alternative_rules.html#case-generate-alternative-100>`_
* `case_generate_alternative_101 <case_generate_alternative_rules.html#case-generate-alternative-101>`_
* `case_generate_statement_100 <case_generate_statement_rules.html#case-generate-statement-100>`_
* `case_generate_statement_101 <case_generate_statement_rules.html#case-generate-statement-101>`_
* `comment_004 <comment_rules.html#comment-004>`_
* `component_002 <component_rules.html#component-002>`_
* `component_007 <component_rules.html#component-007>`_
@ -137,6 +161,8 @@ Rules Enforcing Whitespace
* `constant_010 <constant_rules.html#constant-010>`_
* `constant_100 <constant_rules.html#constant-100>`_
* `constant_101 <constant_rules.html#constant-101>`_
* `constrained_array_definition_100 <constrained_array_definition_rules.html#constrained-array-definition-100>`_
* `constrained_array_definition_101 <constrained_array_definition_rules.html#constrained-array-definition-101>`_
* `context_002 <context_rules.html#context-002>`_
* `context_017 <context_rules.html#context-017>`_
* `context_018 <context_rules.html#context-018>`_
@ -150,7 +176,27 @@ Rules Enforcing Whitespace
* `entity_013 <entity_rules.html#entity-013>`_
* `entity_specification_100 <entity_specification_rules.html#entity-specification-100>`_
* `entity_specification_101 <entity_specification_rules.html#entity-specification-101>`_
* `external_constant_name_100 <external_constant_name_rules.html#external-constant-name-100>`_
* `external_constant_name_101 <external_constant_name_rules.html#external-constant-name-101>`_
* `external_constant_name_102 <external_constant_name_rules.html#external-constant-name-102>`_
* `external_constant_name_103 <external_constant_name_rules.html#external-constant-name-103>`_
* `external_constant_name_104 <external_constant_name_rules.html#external-constant-name-104>`_
* `external_signal_name_100 <external_signal_name_rules.html#external-signal-name-100>`_
* `external_signal_name_101 <external_signal_name_rules.html#external-signal-name-101>`_
* `external_signal_name_102 <external_signal_name_rules.html#external-signal-name-102>`_
* `external_signal_name_103 <external_signal_name_rules.html#external-signal-name-103>`_
* `external_signal_name_104 <external_signal_name_rules.html#external-signal-name-104>`_
* `external_variable_name_100 <external_variable_name_rules.html#external-variable-name-100>`_
* `external_variable_name_101 <external_variable_name_rules.html#external-variable-name-101>`_
* `external_variable_name_102 <external_variable_name_rules.html#external-variable-name-102>`_
* `external_variable_name_103 <external_variable_name_rules.html#external-variable-name-103>`_
* `external_variable_name_104 <external_variable_name_rules.html#external-variable-name-104>`_
* `file_open_information_100 <file_open_information_rules.html#file-open-information-100>`_
* `file_open_information_101 <file_open_information_rules.html#file-open-information-101>`_
* `file_open_information_102 <file_open_information_rules.html#file-open-information-102>`_
* `file_open_information_103 <file_open_information_rules.html#file-open-information-103>`_
* `file_100 <file_rules.html#file-100>`_
* `file_101 <file_rules.html#file-101>`_
* `function_100 <function_rules.html#function-100>`_
* `function_101 <function_rules.html#function-101>`_
* `generate_002 <generate_rules.html#generate-002>`_
@ -163,10 +209,15 @@ Rules Enforcing Whitespace
* `generic_014 <generic_rules.html#generic-014>`_
* `generic_map_006 <generic_map_rules.html#generic-map-006>`_
* `generic_map_007 <generic_map_rules.html#generic-map-007>`_
* `generic_map_100 <generic_map_rules.html#generic-map-100>`_
* `generic_map_101 <generic_map_rules.html#generic-map-101>`_
* `if_003 <if_rules.html#if-003>`_
* `if_004 <if_rules.html#if-004>`_
* `if_005 <if_rules.html#if-005>`_
* `if_015 <if_rules.html#if-015>`_
* `index_constraint_100 <index_constraint_rules.html#index-constraint-100>`_
* `index_subtype_definition_100 <index_subtype_definition_rules.html#index-subtype-definition-100>`_
* `index_subtype_definition_101 <index_subtype_definition_rules.html#index-subtype-definition-101>`_
* `instantiation_002 <instantiation_rules.html#instantiation-002>`_
* `instantiation_003 <instantiation_rules.html#instantiation-003>`_
* `instantiation_032 <instantiation_rules.html#instantiation-032>`_
@ -183,9 +234,18 @@ Rules Enforcing Whitespace
* `package_009 <package_rules.html#package-009>`_
* `package_body_100 <package_body_rules.html#package-body-100>`_
* `package_body_101 <package_body_rules.html#package-body-101>`_
* `package_instantiation_100 <package_instantiation_rules.html#package-instantiation-100>`_
* `package_instantiation_101 <package_instantiation_rules.html#package-instantiation-101>`_
* `package_instantiation_102 <package_instantiation_rules.html#package-instantiation-102>`_
* `package_instantiation_103 <package_instantiation_rules.html#package-instantiation-103>`_
* `port_003 <port_rules.html#port-003>`_
* `port_020 <port_rules.html#port-020>`_
* `port_100 <port_rules.html#port-100>`_
* `port_101 <port_rules.html#port-101>`_
* `port_map_006 <port_map_rules.html#port-map-006>`_
* `port_map_007 <port_map_rules.html#port-map-007>`_
* `port_map_100 <port_map_rules.html#port-map-100>`_
* `port_map_101 <port_map_rules.html#port-map-101>`_
* `procedure_100 <procedure_rules.html#procedure-100>`_
* `procedure_101 <procedure_rules.html#procedure-101>`_
* `procedure_call_100 <procedure_call_rules.html#procedure-call-100>`_
@ -195,6 +255,8 @@ Rules Enforcing Whitespace
* `process_014 <process_rules.html#process-014>`_
* `process_024 <process_rules.html#process-024>`_
* `process_025 <process_rules.html#process-025>`_
* `range_constraint_100 <range_constraint_rules.html#range-constraint-100>`_
* `range_constraint_101 <range_constraint_rules.html#range-constraint-101>`_
* `record_type_definition_100 <record_type_definition_rules.html#record-type-definition-100>`_
* `record_type_definition_101 <record_type_definition_rules.html#record-type-definition-101>`_
* `report_statement_100 <report_statement_rules.html#report-statement-100>`_
@ -214,13 +276,28 @@ Rules Enforcing Whitespace
* `signal_100 <signal_rules.html#signal-100>`_
* `signal_101 <signal_rules.html#signal-101>`_
* `signal_102 <signal_rules.html#signal-102>`_
* `subprogram_instantiation_100 <subprogram_instantiation_rules.html#subprogram-instantiation-100>`_
* `subprogram_instantiation_101 <subprogram_instantiation_rules.html#subprogram-instantiation-101>`_
* `subprogram_instantiation_102 <subprogram_instantiation_rules.html#subprogram-instantiation-102>`_
* `subprogram_instantiation_103 <subprogram_instantiation_rules.html#subprogram-instantiation-103>`_
* `subprogram_instantiation_104 <subprogram_instantiation_rules.html#subprogram-instantiation-104>`_
* `subtype_100 <subtype_rules.html#subtype-100>`_
* `subtype_101 <subtype_rules.html#subtype-101>`_
* `subtype_102 <subtype_rules.html#subtype-102>`_
* `type_006 <type_rules.html#type-006>`_
* `type_007 <type_rules.html#type-007>`_
* `type_100 <type_rules.html#type-100>`_
* `variable_005 <variable_rules.html#variable-002>`_
* `variable_006 <variable_rules.html#variable-002>`_
* `variable_100 <variable_rules.html#variable-002>`_
* `unbounded_array_definition_100 <unbounded_array_definition_rules.html#unbounded-array-definition-100>`_
* `unbounded_array_definition_101 <unbounded_array_definition_rules.html#unbounded-array-definition-101>`_
* `unbounded_array_definition_102 <unbounded_array_definition_rules.html#unbounded-array-definition-102>`_
* `variable_005 <variable_rules.html#variable-005>`_
* `variable_006 <variable_rules.html#variable-006>`_
* `variable_100 <variable_rules.html#variable-100>`_
* `variable_101 <variable_rules.html#variable-101>`_
* `variable_102 <variable_rules.html#variable-102>`_
* `variable_103 <variable_rules.html#variable-103>`_
* `variable_assignment_002 <variable_assignment_rules.html#variable-assignment-002>`_
* `variable_assignment_003 <variable_assignment_rules.html#variable-assignment-003>`_
* `whitespace_007 <whitespace_rules.html#whitespace-007>`_
* `whitespace_102 <whitespace_rules.html#whitespace-102>`_
* `whitespace_103 <whitespace_rules.html#whitespace-103>`_

View File

@ -17,7 +17,7 @@ This rule checks the indent of a constant declaration.
architecture RTL of FIFO is
constant size : integer := 1;
constant width : integer := 32
constant width : integer := 32;
**Fix**
@ -26,7 +26,7 @@ This rule checks the indent of a constant declaration.
architecture RTL of FIFO is
constant size : integer := 1;
constant width : integer := 32
constant width : integer := 32;
constant_002
############
@ -126,7 +126,7 @@ constant_007
|phase_1| |error| |structure|
This rule checks the **:=** is on the same line at the **constant** keyword.
This rule checks the **:=** is on the same line as the **constant** keyword.
**Violation**
@ -144,7 +144,7 @@ This rule checks the **:=** is on the same line at the **constant** keyword.
constant size : integer :=
1;
constant width : integer :=
32
32;
constant_010
############
@ -173,9 +173,9 @@ Having a space makes it clearer where the assignment occurs on the line.
constant_011
############
The function of this rule has been superceeded by the following rules:
The function of this rule has been superseded by the following rules:
* ieee_500
* type_mark_500
* subtype_002
* type_014
@ -303,10 +303,10 @@ This rule checks the indent of multiline constants that do not contain arrays.
constant_015
############
|phase_7| |disabled| |error| |naming|
|phase_7| |disabled| |error| |unfixable| |naming|
This rule checks for valid prefixes on constant identifiers.
The default constant prefix is *c\_*.
The default constant prefix is *c_*.
|configuring_prefix_and_suffix_rules_link|
@ -482,10 +482,10 @@ This rule checks the alignment of assignment keywords in constant declarations.
constant_600
############
|phase_7| |disabled| |error| |naming|
|phase_7| |disabled| |error| |unfixable| |naming|
This rule checks for valid suffixes on constant identifiers.
The default constant suffix is *\_c*.
The default constant suffix is *_c*.
|configuring_prefix_and_suffix_rules_link|
@ -500,4 +500,3 @@ The default constant suffix is *\_c*.
.. code-block:: vhdl
constant my_const_c : integer;

View File

@ -0,0 +1,88 @@
.. include:: includes.rst
Constrained Array Definition Rules
----------------------------------
constrained_array_definition_100
################################
|phase_2| |error| |whitespace|
This rule checks for a single space before the **of** keyword.
|configuring_whitespace_rules_link|
**Violation**
.. code-block:: vhdl
type t_u_array is array(1 downto 0) of unsigned;
**Fix**
.. code-block:: vhdl
type t_u_array is array(1 downto 0) of unsigned;
constrained_array_definition_101
################################
|phase_2| |error| |whitespace|
This rule checks for a single space after the **of** keyword.
|configuring_whitespace_rules_link|
**Violation**
.. code-block:: vhdl
type t_u_array is array(1 downto 0) of unsigned;
**Fix**
.. code-block:: vhdl
type t_u_array is array(1 downto 0) of unsigned;
constrained_array_definition_500
################################
|phase_6| |error| |case| |case_keyword|
This rule checks the **array** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
type t_u_array is ARRAY(1 downto 0) of unsigned;
**Fix**
.. code-block:: vhdl
type t_u_array is array(1 downto 0) of unsigned;
constrained_array_definition_501
################################
|phase_6| |error| |case| |case_keyword|
This rule checks the **of** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
type t_u_array is ARRAY(1 downto 0) of unsigned;
**Fix**
.. code-block:: vhdl
type t_u_array is array(1 downto 0) of unsigned;

View File

@ -241,4 +241,3 @@ This rule checks the context name called out in the selected name has proper cas
.. code-block:: vhdl
context my_lib.interfaces;

View File

@ -196,7 +196,7 @@ context_009
|phase_1| |error| |structure|
This rule checks the **context** keyword is on the same line as the end context keyword.
This rule checks the **context** keyword is on the same line as the **end** context keyword.
**Violation**
@ -217,7 +217,7 @@ context_010
|phase_1| |error| |structure|
This rule checks the context identifier is on the same line as the end context keyword.
This rule checks the context identifier is on the same line as the **end** context keyword.
**Violation**
@ -335,7 +335,7 @@ context_015
|phase_6| |error| |case| |case_keyword|
This rule checks the context keyword has proper case in the end context declaration.
This rule checks the **context** keyword has proper case in the end context declaration.
|configuring_uppercase_and_lowercase_rules_link|
@ -620,4 +620,3 @@ This rule checks for alignment of inline comments in the context declaration.
library ieee; -- Other comment
use ieee.std_logic_1164.all; -- Comment 3
end context c1; -- Comment 4

View File

@ -17,7 +17,7 @@ JUnit Report
VSG can generate a report of an analysis in JUnit XML format.
This report will include the filename along with any errors detected.
The rule which was violated, the line number where the violation occured, and the proposed solution are provided.
The rule which was violated, the line number where the violation occurred, and the proposed solution are provided.
This report can be used in most CI server applications to create a test report.
Refer to the documentation of your CI server application for how to integrate the JUnit report.
@ -62,7 +62,7 @@ The following items in the spec are populated.
A relative path to the file with code quality issues.
.. |location_lines_begin| replace::
The line number where the code quality issue occured.
The line number where the code quality issue occurred.
+----------------------+------------------------+
| Code Climate Spec | Description |
@ -91,7 +91,7 @@ An example of a code quality report is shown below:
"fingerprint": "323039ccd1801791163d7a302cfd5b25",
"severity": "critical",
"location": {
"path": "vsg/tests/tool_integration/quality_report/example.vhd",
"path": "tests/tool_integration/quality_report/example.vhd",
"lines": {
"begin": 8
}

View File

@ -57,8 +57,6 @@ VSG was developed using a Test Driven Development (TDD) process.
There are over 1000 tests which cover individual rules and other features of VSG.
For each pull request, an accompanying test to validate the pull request would be appreciated.
Refer to `Setting up a Development Environment <setting_up_a_development_environment.html#running-unit-tests>`_ for more information on how to get started.
Quality Control
###############
@ -69,4 +67,3 @@ This project uses the following open source tools to help with code quality:
* *Codcov* to check the code coverage of the tests.
The results will be available on the pull request GitHub page.

View File

@ -0,0 +1,67 @@
.. include:: includes.rst
Delay Mechanism Rules
---------------------
delay_mechanism_500
###################
|phase_6| |error| |case| |case_keyword|
This rule checks the **transport** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
a <= TRANSPORT 1 after 10 ns;
**Fix**
.. code-block:: vhdl
a <= transport 1 after 10 ns;
delay_mechanism_501
###################
|phase_6| |error| |case| |case_keyword|
This rule checks the **inertial** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
a <= INERTIAL 1 after 10 ns;
**Fix**
.. code-block:: vhdl
a <= inertial 1 after 10 ns;
delay_mechanism_502
###################
|phase_6| |error| |case| |case_keyword|
This rule checks the **reject** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
a <= REJECT 2ns inertial 1 after 10 ns;
**Fix**
.. code-block:: vhdl
a <= reject 2ns inertial 1 after 10 ns;

View File

@ -0,0 +1,316 @@
Adding a rule
-------------
Following the steps in the given order ensures everything is covered.
#. Create documentation
#. Create test
#. Create rule
.. NOTE:: If a similar rule already exists, copy that rules elements for each of the following steps.
Create Documentation
====================
A documentation first approach clarifies what a rule will address.
The documentation is located in the `docs` directory.
All rules for a rule group are kept in a file with the following pattern: :code:`<rule_group>_rules.rst`.
The rules are in alphabetical order within the documentation.
Rule documentation contains the following items:
#. Rule ID
#. Icons
#. Summary
#. Link to configuration options
#. Violation example
#. Fixed example
.. code-block:: rst
architecture_001
################
|phase_4| |error| |indent|
This rule checks for blank spaces before the **architecture** keyword.
**Violation**
.. code-block:: vhdl
architecture rtl of fifo is
begin
**Fix**
.. code-block:: vhdl
architecture rtl of fifo is
begin
The Rule ID identifies the rule and is unique through all versions of VSG.
A Rule ID will never be re-used.
Icons provide information about the rule at a quick glance.
These icons indicate the phase in which the rule is ran, whether it is disabled by default, etc...
Links to the icons are stored in a file named :code:`icons.rst` and is included into each file using an include at the top of every file.
The summary is a very brief description of what issue the rule is attempting to resolve.
If the rule has configuration options, a link to the configuration information will be given.
The links are stored in a file named :code:`links.rst` and in included into each file using an include at the top of every file.
The Violation Example provides a visual indicating what the issue is.
The Fixed example provides a visual indicating what the end state should be.
Create Test
===========
The next step is to create a test for the new rule.
Test directory structure
^^^^^^^^^^^^^^^^^^^^^^^^
The directory structure of the tests closely matches the rules directory.
Every rule group has its own directory.
.. code-block:: text
tests
├── after
├── alias_declaration
├── architecture
...
└── whitespace
Each rule will typically consist of at least three files:
#. test file of the form :code:`test_rule_[0-9][0-9][0-9].py`
#. input vhdl file with violations in the form of :code:`rule_[0-9][0-9][0-9]_test_input.vhd`
#. fixed vhdl file without violations in the form of :code:`rule_[0-9][0-9][0-9]_test_input.fixed.vhd`
.. code-block:: text
tests
└── architecture
   ├── rule_001_test_input.fixed.vhd
   ├── rule_001_test_input.vhd
└── test_rule_001.py
Test File Structure
^^^^^^^^^^^^^^^^^^^
The test file contains a class with the name of :code:`test_rule`.
The minimum number of tests will be one for those rules for which a fix is not available.
For rules in which a fix is available, a minimum of two tests will be required: one for detecting violations and another for verifying the violations can be fixed.
If the rule has configurable options, then additional tests are required based on the number of configurable items.
.. code-block:: python
class test_rule(unittest.TestCase):
def test_rule_001(self):
oRule = architecture.rule_001()
def test_fix_rule_001(self):
oRule = architecture.rule_001()
The :code:`test_rule_001` method operates on the test input file and returns a list of lines where a violation was detected.
The line numbers are then validated.
The :code:`test_fix_rule_001` method operations on the test input file and attempts to fix the violations.
The resulting fix is compared against the :code:`rule_001_test_input.fixed.vhd` file.
Any discrepancies are flagged.
Test Input File
^^^^^^^^^^^^^^^
The test input file provides examples of code passing and violating the particular rule.
It provides the conditions where the rule is checked.
Depending on the rule, this file can range from very simple to quite complex.
If configuration options are available for the rule, then this file should provide conditions for each configurable item.
.. code-block:: vhdl
architecture RTL of FIFO is begin end architecture RTL;
-- This should fail
architecture RTL of FIFO is
begin
end architecture RTL;
Fixed Input File
^^^^^^^^^^^^^^^^
This file provides the output product of running the rule in isolation.
Additional rules are not applied.
If configuration options are available for the rule, then additional files are required for each configuration.
.. code-block:: vhdl
architecture RTL of FIFO is begin end architecture RTL;
-- This should fail
architecture RTL of FIFO is
begin
end architecture RTL;
Run failing test
^^^^^^^^^^^^^^^^
VSG uses pytest and individual tests can be executed:
.. code-block:: text
$ pytest tests/architecture/test_rule_001.py
======================================== test session starts =========================================
platform linux -- Python 3.10.13, pytest-8.1.1, pluggy-1.4.0
rootdir: /home/jcleary/projects/vsg-master
configfile: pyproject.toml
plugins: html-4.1.1, html-reporter-0.2.9, metadata-3.1.1
collected 2 items
tests/architecture/test_rule_001.py FF [100%]
============================================== FAILURES ==============================================
______________________________ test_architecture_rule.test_fix_rule_001 ______________________________
self = <tests.architecture.test_rule_001.test_architecture_rule testMethod=test_fix_rule_001>
def test_fix_rule_001(self):
> oRule = architecture.rule_001()
E AttributeError: module 'vsg.rules.architecture' has no attribute 'rule_001'. Did you mean: 'rule_002'?
tests/architecture/test_rule_001.py:39: AttributeError
________________________________ test_architecture_rule.test_rule_001 ________________________________
self = <tests.architecture.test_rule_001.test_architecture_rule testMethod=test_rule_001>
def test_rule_001(self):
> oRule = architecture.rule_001()
E AttributeError: module 'vsg.rules.architecture' has no attribute 'rule_001'. Did you mean: 'rule_002'?
tests/architecture/test_rule_001.py:28: AttributeError
====================================== short test summary info =======================================
FAILED tests/architecture/test_rule_001.py::test_architecture_rule::test_fix_rule_001 - AttributeError: module 'vsg.rules.architecture' has no attribute 'rule_001'. Did you mean: 'rule_...
FAILED tests/architecture/test_rule_001.py::test_architecture_rule::test_rule_001 - AttributeError: module 'vsg.rules.architecture' has no attribute 'rule_001'. Did you mean: 'rule_...
========================================= 2 failed in 0.43s ==========================================
The test failed because the rule does not yet exist.
Create Rule
===========
Updating __init__.py file
^^^^^^^^^^^^^^^^^^^^^^^^^
In order for a rule to be used, it must be added to the :code:`__init__.py` file in the rule group directory.
.. code-block:: python
# -*- coding: utf-8 -*-
from .rule_001 import rule_001
from .rule_002 import rule_002
Rule file structure
^^^^^^^^^^^^^^^^^^^
#. class name
#. docstring
#. rule implementation
The class name of the rule must follow this pattern: :code:`rule_[0-9][0-9][0-9]`.
The docstring must match the documentation but does not include the header or the icons.
The rule implementation could be unique or it could call a base rule.
.. code-block:: python
# -*- coding: utf-8 -*-
from vsg.rules import token_indent
from vsg.token import architecture_body as token
class rule_001(token_indent):
"""
This rule checks for blank spaces before the **architecture** keyword.
**Violation**
.. code-block:: vhdl
architecture rtl of fifo is
begin
**Fix**
.. code-block:: vhdl
architecture rtl of fifo is
begin
"""
def __init__(self):
super().__init__([token.architecture_keyword])
In this case the :code:`token_indent` base rule is used to check the indent of the architecture keyword.
Run passing test
^^^^^^^^^^^^^^^^
Re-run the test and make any changes until the test passes.
.. code-block:: text
======================================== test session starts =========================================
platform linux -- Python 3.10.13, pytest-8.1.1, pluggy-1.4.0
rootdir: /home/jcleary/projects/vsg-master
configfile: pyproject.toml
plugins: html-4.1.1, html-reporter-0.2.9, metadata-3.1.1
collected 2 items
tests/architecture/test_rule_001.py .. [100%]
========================================= 2 passed in 0.34s ==========================================
Run regression tests
^^^^^^^^^^^^^^^^^^^^
Now that the single test runs, the entire suite of tests must be ran to ensure there no side effects.
.. code-block:: text
$ tox -e test-py38
======================================== test session starts =========================================
platform linux -- Python 3.8.10, pytest-8.1.1, pluggy-1.4.0
cachedir: .tox/test-py38/.pytest_cache
rootdir: /home/jcleary/projects/vsg-master
configfile: pyproject.toml
plugins: cov-5.0.0, html-4.1.1, xdist-3.5.0, html-reporter-0.2.9, metadata-3.1.1
8 workers [3005 items]
.............................................................................................. [ 3%]
.............................................................................................. [ 6%]
.............................................................................................. [ 97%]
....................................................................................... [100%]
---------- coverage: platform linux, python 3.8.10-final-0 -----------
Coverage HTML written to dir build.out/test-py38/coverage
Coverage XML written to file build.out/test-py38/coverage.xml
- Generated html report: file:///home/jcleary/projects/vsg-master/build.out/test-py38/test/pytest.html -
================================== 3005 passed in 72.67s (0:01:12) ===================================
test-py38: OK (81.82=setup[8.52]+cmd[73.30] seconds)
congratulations :) (81.87 seconds)

View File

@ -0,0 +1,38 @@
Development Environment
-----------------------
Follow these steps to setup the development environment.
Clone the repo
##############
Clone the repo with the following command:
.. code-block:: bash
$ git clone https://github.com/jeremiah-c-leary/vhdl-style-guide.git
Setup alias
###########
Set an alias to VSG as follows:
.. code-block:: bash
$ set alias vsg='python3 <path_to_clone_directory>/bin/vsg'
This allows you to execute VSG without installing it.
Install prerequisites
#####################
.. code-block:: bash
$ pip install PyYAML
$ pip install tox
Build locally, artifacts will appear in ``dist`` directory.
.. code-block:: bash
tox

View File

@ -0,0 +1,70 @@
Helpful Tools
-------------
vsg_parser
==========
:code:`vsg_parser` is a tool which will show the mapping of tokens to a given file.
It is located in the bin directory and can be invoked with:
.. code-block:: bash
$ bin/vsg_parser -f <filename>
This is the output when ran against the :code:`tests/architecture/rule_001_test_input.vhd` file:
.. code-block:: text
--------------------------------------------------------------------------------
0 |
--------------------------------------------------------------------------------
1 |
<class 'vsg.parser.blank_line'>
--------------------------------------------------------------------------------
2 | architecture RTL of FIFO is begin end architecture RTL;
<class 'vsg.token.architecture_body.architecture_keyword'>
<class 'vsg.token.architecture_body.identifier'>
<class 'vsg.token.architecture_body.of_keyword'>
<class 'vsg.token.architecture_body.entity_name'>
<class 'vsg.token.architecture_body.is_keyword'>
<class 'vsg.token.architecture_body.begin_keyword'>
<class 'vsg.token.architecture_body.end_keyword'>
<class 'vsg.token.architecture_body.end_architecture_keyword'>
<class 'vsg.token.architecture_body.architecture_simple_name'>
<class 'vsg.token.architecture_body.semicolon'>
--------------------------------------------------------------------------------
3 |
<class 'vsg.parser.blank_line'>
--------------------------------------------------------------------------------
4 | -- This should fail
<class 'vsg.parser.comment'>
--------------------------------------------------------------------------------
5 |
<class 'vsg.parser.blank_line'>
--------------------------------------------------------------------------------
6 | architecture RTL of FIFO is
<class 'vsg.token.architecture_body.architecture_keyword'>
<class 'vsg.token.architecture_body.identifier'>
<class 'vsg.token.architecture_body.of_keyword'>
<class 'vsg.token.architecture_body.entity_name'>
<class 'vsg.token.architecture_body.is_keyword'>
--------------------------------------------------------------------------------
7 |
<class 'vsg.parser.blank_line'>
--------------------------------------------------------------------------------
8 | begin
<class 'vsg.token.architecture_body.begin_keyword'>
--------------------------------------------------------------------------------
9 |
<class 'vsg.parser.blank_line'>
--------------------------------------------------------------------------------
10 | end architecture RTL;
<class 'vsg.token.architecture_body.end_keyword'>
<class 'vsg.token.architecture_body.end_architecture_keyword'>
<class 'vsg.token.architecture_body.architecture_simple_name'>
<class 'vsg.token.architecture_body.semicolon'>
Each line is printed and then each token is listed in the order they appear on the line.
Whitespace tokens can be shown using the :code:`-w` option.
:code:`vsg_parser` can be useful in rule generation to determine how vsg is assigning token types.

12
docs/developing/index.rst Normal file
View File

@ -0,0 +1,12 @@
Developing
==========
Before developing for VSG, familiarize yourself with the **Theory of Operation** and **Processes** sections of the documentation.
.. toctree::
:maxdepth: 2
development_environment
helpful_tools
adding_a_rule
prepare_for_pull_request

View File

@ -0,0 +1,13 @@
Prepare for pull request
------------------------
Before creating a pull request use tox to perform all checks against the code base:
.. code-block:: bash
$ tox
This will run code style checks, unittests against multiple versions of python and attempt to perform a build.
When this passes create a pull request.
.. NOTE:: `Issue 1157 <https://github.com/jeremiah-c-leary/vhdl-style-guide/issues/1157>`_ is still being resolved and should not gate any PR creation.

View File

@ -23,7 +23,7 @@ Linting/Diagnostics with ALE
A custom linter can be defined for 'ALE <https://github.com/dense-analysis/ale>'_ if you use this. You can place the following contents into a file somewhere in your runtime path under `ale_linters/vhdl/`, this will generate a Linter that can give you diagnostics in Vim
.. code-block:: viml
.. code-block:: vim
function! ale_linters#vhdl#vsg_ale#GetCommand(buffer)
return "vsg --config ./vsg_config.yaml -of syntastic -f " . expand('%p')
@ -104,7 +104,7 @@ This works by taking the current buffer's contents and passing it into the stand
groups = { 'severity', 'row', 'code', 'message' },
overrides = {
severities = {
-- 2 is for warnings, nvim showing as an erorr can be obnoxious. Change if desired
-- 2 is for warnings, nvim showing as an error can be obnoxious. Change if desired
["ERROR"] = 2,
["WARNING"] = 3,
["INFORMATION"] = 3,

View File

@ -27,7 +27,7 @@ This will create a template **task.json** file:
Replace the contents of the template file with the following...
.. code-block:: text
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
@ -175,4 +175,3 @@ The violations are shown in the Problems tab:
The violations can be fixed manually, or by using `ctrl+f`...
.. image:: vscode_file_fixed.png

View File

@ -44,4 +44,3 @@ This rule checks for a single space after the => in an element_association.
.. code-block:: vhdl
a <= (others => (others => '0'));

View File

@ -52,7 +52,7 @@ entity_003
|phase_3| |error| |blank_line|
This rule checks for blank lines or comments above the entity keyword.
This rule checks for blank lines or comments above the **entity** keyword.
|configuring_previous_line_rules_link|
@ -903,4 +903,3 @@ This rule checks for consistent capitalization of generic names in entity declar
O_DATA : std_logic_vector(G_WIDTH - 1 downto 0)
);
end entity fifo;

View File

@ -118,4 +118,3 @@ This rule checks the *entity_class* has proper case.
.. code-block:: vhdl
attribute coordinate of comp_1 : component is (0.0, 17.5);

View File

@ -1,13 +1,13 @@
{
"rule":{
"global":{
"phase":1
"rule": {
"global": {
"phase": 1
},
"architecture_010":{
"disable":"True"
"architecture_010": {
"disable": "True"
},
"port_011":{
"port_direction":"Suffix"
"port_011": {
"port_direction": "Suffix"
}
}
}

View File

@ -26,3 +26,67 @@ This rule checks the indent of the **exit** keyword.
exit;
exit_statement_301
##################
|phase_4| |error| |indent|
This rule checks the indent of the label.
**Violation**
.. code-block:: vhdl
end if;
exit_label : exit;
**Fix**
.. code-block:: vhdl
end if;
exit_label : exit;
exit_statement_500
##################
|phase_6| |error| |case| |case_keyword|
This rule checks the **exit** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
EXIT when condition;
**Fix**
.. code-block:: vhdl
exit when condition;
exit_statement_501
##################
|phase_6| |error| |case| |case_keyword|
This rule checks the **when** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
exit WHEN condition;
**Fix**
.. code-block:: vhdl
exit when condition;

View File

@ -8,7 +8,7 @@ exponent_500
|phase_6| |error| |case| |case_keyword|
This rule checks the e keyword has proper case.
This rule checks the **e** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
@ -25,4 +25,3 @@ This rule checks the e keyword has proper case.
12.5e-90
6e57

Some files were not shown because too many files have changed in this diff Show More