Tags give the ability to mark specific points in history as being important
This project is mirrored from https://github.com/jeremiah-c-leary/vhdl-style-guide.git.
Pull mirroring updated .
Successfully updated .
-
3.35.0
8adacd48 · ·Announcements ------------- This is the first release in which I did not create any pull requests to add features or fix bugs. I would like to thank @benthie, @JHertz5, and @linknum33 for all their hard work. New Features ------------ Issue #1397 Added whitespace rules for file declarations and file type definitions. Issue #1474 Added VHDL 2019 keywords to keyword rule. Issue #1475 Added parsing of VHDL 2019 interfaces. Issue #1479 Added regex ability to rule architecture_025. Issue #1504 Added rules to check for invalid libraries and packages. Bug Fixes --------- Issue #1451 Rule concurrent_003 was not detecting arrays correctly. Issue #1484 Removed conflict between rules variable_assign_400 and variable_assignment_004. Issue #1496 Documentation update Retired Issues -------------- None Acknowledgements ---------------- I would like to thank the following bug finders and feature requestors: @ekigwana @maltaisn @psi-chuffine I would like to thank the following contributors: @benthie @JHertz5 @linknum23 -
3.34.0
7a7ad605 · ·Announcements ------------- None New Features ------------ None Bug Fixes --------- Issue #1469 File rules configuration option without a matching file would crash. Issue #1471 Improved UTF-8 tests. Retired Issues -------------- Issue #1404 Issue #1418 Issue #1419 Issue #1429 Issue #1445 Issue #1461 Acknowledgements ---------------- I would like to thank the following bug finders and feature requestors: @ruck314 @Igu-appear @yotarid @GCHQDeveloper211 @ru551n I would like to thank the following contributors: @JFMarten @linknum23 -
3.33.0
587052b2 · ·Announcements ------------- Rules variable_400 and signal_400 were adding an extra space during alignment. It is expected these rules will trigger when running against code from previous versions. New Features ------------ Issue #1289 Issue #1438 Added rule to enforce case of shared keyword in a shared variable declaration. Issue #1431 Added rule variable_015. Issue #1459 Added rule to enforce optional architecture identifier in entity instantiations. Bug Fixes --------- Issue #1250 Fixed alignment for range declarations of unconstrained record elements. Issue #1403 Issue #1454 Fixed VHDL-2008 reference in subtype. Issue #1415 Fixed misclassification of signs. Issue #1442 Output file encoding now matches input file encoding. Issue #1444 Fixed misclassification of array definitions as record definition. Issue #1446 Added configuration to adjust indenting of trailing comments at end of declaration and statement productions. Issue #1425 Fixed globbing in file_rules attribute. Retired Issues -------------- Issue #1430 Acknowledgements ---------------- I would like to thank the following bug finders and feature requestors: @benthie @GCHQDeveloper211 @jack-mil @JakubFranek @jamesglong @JHertz5 @jorkrohn @maltaisn @masubious @obruendl @urbite I would like to thank the following contributors: @benthie @JHertz5 @malsheimer -
3.32.0
78b7cf3b · ·Announcements ------------- None at this time. New Features ------------ None Bug Fixes --------- Issue #1426 Fixed invalid escape sequence issues in documentation. Issue #1433 Fixed mis-classification of negative sign. Retired Issues -------------- Issue #1398 Issue #1423 Issue #1424 Acknowledgements ---------------- I would like to thank the following bug finders and feature requestors: @fimtrey @PelleEikeberg -
3.31.0
bf505789 · ·Announcements ------------- None at this time. New Features ------------ Issue #1358 Added ability to add custom error messages. Issue #1402 Added rules for interface incomplete tyupe declarations. Issue #1407 Date/timestamps of unmodified files are not changed. Bug Fixes --------- Issue #1409 Fixed crash if entity name was not present when checking architecture body. Issue #1411 Add parsing of PSL statements. Issue #1413 Documentation update. Issue #1420 Fixed detection of delimited comments. Retired Issues -------------- Issue #1240 Issue #1421 Acknowledgements ---------------- I would like to thank the following bug finders and feature requestors: @ekigwana @JakubFranek @jamesglong @JennToo @PelleEikeberg @xtrollyj00 -
3.30.0
cc678cb2 · ·Announcements ------------- The regex definitions for camelCase and PascalCase are going to be changing for release 3.30.0 to better align with industry "standards". The current regex allows for an unlimited number of uppercase characters in a row: myFIFO MyFIFO A more strict version of camelCase and PascalCase will be implemented to limit the number of consecutive uppercase characters to 2. myFIfo MyFIfo The original regex definition for camelCase will be moved to relaxedCamelCase. The original regex definition for PascalCase will be moved to RelaxedPascalCase. New Features ------------ Issue #1202 Added Pascal_Snake_Case regular expression. Refer to announcements for more information. Issue #1318 Whitespace rules added for subprogram instantiations. Issue #1363 Adding case rules for array definitions. Issue #1364 Adding case rules for subprogram instantiation declarations. Issue #1366 Adding structure rules for subprogram instantiation declarations. Issue #1376 Case rules for parameters in for loops/generates. Issue #1383 Case rules for file declarations and file type declarations. Issue #1385 Replaced rules interation_scheme_502 and for_generate_statement with parameter_specification_501. Pull Request #1388 Added python 3.13 to tox. Issue #1389 Added whitespace rules for case generate statements. Bug Fixes --------- Issue #1232 Added rule to apply case to identifiers which are not caught by the consistent case rules. Issue #1334 Fixed tests that were failing on Windows. Issue #1372 Issue #1377 Issue #1392 Documentation updates. Issue #1394 Removed unused code. Retired Issues -------------- Issue #1247 Issue #1255 Acknowledgements ---------------- I would like to thank the following bug finders and feature requestors: @blmaier @JennySmith888 @JHertz5 @obruendl @patrick-studer I would like to thank the following contributors: @blmaier @JHertz5 @valerionew -
3.29.0
ae0e7b14 · ·Announcements ------------- None at this time. New Features ------------ Issue #1280 Added rules to enforce capitalization on others keywords. Issue #1320 Added rules to force map keyword to be on the same line as port and generic keywords. Issue #1306 Issue #1322 Issue #1323 Issue #1324 Issue #1325 Issue #1330 Added rules for package instantiation declarations. Issue #1310 Added rules for consistent case of parameter names in subprograms. Issue #1323 Added indent and blank line rules for package instantiation declarations. Issue #1324 Added structure rules for package instantiation declarations. Issue #1341 Added case rules for delay machanisms. Issue #1359 Added case rules for the range keyword. Pull Request #1351 Updated md5sum calculator to when running VSG on FIPS enabled systems. Issue #1361 Added case rule for the open keyword in array constraints. Bug Fixes --------- Issue #1234 Fixed rule architecture_600 so it applies inside generic maps. Issue #1287 Fixed indent inside protected types. Issue #1290 Subprograms declared in a generic map were not being formated correctly. Issue #1291 Aggregate parts were occasionally misaligned by one space. Issue #1295 Rule variable_assignment_004 was conflicting with rule variable_assignment_401. Issue #1302 Issue #1350 Adding rules for shift operators. Issue #1314 The rule column in the output report now changes to match the length of the rule. Issue #1316 Rule generic_map_006 was applying to port maps. Additional rule added for just port maps. Issue #1319 Generic map rules now apply to all instances of generic maps. Issue #1335 Rule variable_011 now works on procedure calls. Issue #1369 Rules procedure_505 and procedure_009 are duplicates. Removed rule procedure_009. Retired Issues -------------- Issue #1078 Issue #1209 Issue #1343 Issue #1357 Code Cleanup ------------ Issue #1300 Removed duplication in code to improve readability. Issue #1347 Removed commented out code. Issue #1367 Added missing __init__.py file in tests. Documentation Updates --------------------- Issue #1297 Fixed references to package body. Issue #1353 Changed reference to port clause in rule port_015. Pull Request #1353 Spelling updates and removal of invalid link. Acknowledgements ---------------- I would like to thank the following bug finders and feature requestors: @maltaisn @thbge I would like to thank the following contributors: @JHertz5 @larshb @rpatel3001 -
3.28.0
ec19e1de · ·Announcements ------------- None at this time. New Features ------------ Issue #1228 New subtype rules added. Issue #1248 Additional indentation option added for function specifications to allow for more user control. Issue #1249 Issue #1251 Added rules to check the case for function and procedure parameter names. Issue #1252 Added rules to check the case of function and procedure parameter modes. Issue #1253 Added rules to check the case of the pure and impure function keywords. Issue #1261 Added rules to enforce case on wait statements. Issue #1263 Added rules to enforce case on parameter types. Issue #1265 Added rules for next statements. Issue #1267 Added indent rule for return statement labels. Issue #1269 Added rules to check the case of exit statements. Issue #1271 Added rules for null statements. Issue #1273 Added case rules for the *in* keyword in loops. Issue #1275 Added case rule for library in entity instantiations. Issue #1277 Added case rules for others keyword in case statements. Issue #1279 Added case rules for others statements in aggregates. Issue #1283 Indent rules split for labels versus keywords. Issue #1285 Added case rules for the *protected* keyword. Issue #1288 Added indent rules for end of protected type declarations. Bug Fixes --------- Issue #1245 Fixed documentation on regex. Issue #1256 Updated camelCase to allow for a single capital letter at the end. Issue #1281 Fixed typos in documentation. Issue #1284 Deprecated duplicate rule case_013 Issue #1286 VSG was not honoring the original file permissions of fixed files. Issue #1305 Additional classification tests added. Issue #1339 VSG failed to parse type_marks with an attribute. Retired Issues -------------- Issue #291 Issue #1204 Issue #1337 Acknowledgements ---------------- I would like to thank the following bug finders and feature requestors: @ALL-SPACE-Anju @ArnePret @avelure @DmytroLevit @JennySmith888 @obruendl @urbite I would like to thank the following contributors: @JHertz5 -
3.27.0
33a2ae75 · ·Announcements ------------- None at this time. New Features ------------ Issue #1170 Added support for external names. Added rules for whitespace enforcement in port and generic maps. Issue #1236 Added case enforcement of hexidecimal constants and base specifiers. Issue #1241 Improved testing. Bug Fixes --------- Issue #1230 Documentation updates. Issue #1243 Fixes for parenthesis in external names. Retired Issues -------------- None Acknowledgements ---------------- I would like to thank the following contributors: @JHertz5 I would like to thank the following bug finders and feature requestors: @LarsAsplund @ru551n @thgbe -
3.26.0
7c345ebb · ·Announcements ------------- None at this time. New Features ------------ None Bug Fixes --------- Issue #1207 Issue #1214 Issue #1216 Issue #1220 Documentation updates. Issue #1210 Filename printed if an error is encountered when parsing a file. Issue #1212 Issue #1219 Issue #1227 Fixed issue with generates crashing VSG. Issue #1223 Fixed deprecation warning when running tests. Issue #1226 vsg_rule_doc_gen script was not running. Retired Issues -------------- Issue #1201 Issue #1205 Issue #1206 Issue #1211 Acknowledgements ---------------- I would like to thank the following contributors: @alonbl @JHertz5 I would like to thank the following bug finders and feature requestors: @ciarantoner @larshb @JvWesterveld -
3.25.0
0dbc78a3 · ·Announcements ------------- None at this time. New Features ------------ Issue #911 Rule whitespace_013 does not operate on logical unary operators. Issue #1171 Rule whitespace_100 enforces spaces around operators. Issue #1176 Added options to rule instantiation_005 to enforce newlines before port map keywords. Issue #1178 Added rule component_022 to enforce component simple names. Issue #1182 Added regex option to case rules. Issue #1186 Additional rules to enforce spacing: * generic_map_100 * port_100 * port_101 * port_map_100 * variable_101 * variable_102 * variable_103 Issue #1189 Improved error reporting for invalid indent configurations. Issue #1190 Added <= option to whitespace rules. Issue #1196 Added rule function_020 and procedure_014 to add/remove option function/procedure name. Bug Fixes --------- Issue #1177 Fixed prefix and suffix checks to allow either if both are enabled. Issue #1188 Comments with */ would be mistaken for block comments. Issue #1198 Added regex to rule port_map_002. Retired Issues -------------- Issue #1184 Issue #1195 Acknowledgements ---------------- I would like to thank the following bug finders and feature requestors: @abyszuk @domWalters @maltaisn @tossegus @ungultig1 -
3.24.0
872884d3 · ·Announcements ------------- None at this time. New Features ------------ Issue #1059 Performance improvements Issue #1135 Added documentation for rules which can not be fixed. Issue #1145 Updated JSON documentation on proper formatting of file rules. Bug Fixes --------- Issue #1168 Formal part mis-classification in prodecure/function arguments. Issue #1166 Code tag did not work for rule length_003 Retired Issues -------------- None Acknowledgements ---------------- I would like to thank the following bug finders and feature requestors: @alonbl @el-coder-sb @SittingDuc @willkamp -
3.23.0
e02d5124 · ·Announcements ------------- None at this time. New Features ------------ Issue #1119 Added documentation for developers. Issue #1159 Prefix and Suffix exceptions now except regular expressions. Bug Fixes --------- Issue #947 Rule generate_015 coudl produce invalid code. Issue #1132 Improved efficiency of interface_list classifier. Issue #1137 Fixed rules variable_001 and variable_assignment_008 after merging. Issue #1143 Fixed typo in pre-commit documentation. Issue #1141 Issue #1149 Adding quality of life improvements for development: tox, pre-commit, black, version capture update, release process update Issue #1146 Fixed invalid escape sequences in strings. Issue #1150 Fixed warnings in documentation generation. Issue #1160 Fixed warnings while processing Manifest.in Issue #1163 Fixed configuring use clause indenting yaml example. Retired Issues -------------- Issue #353 Issue #1139 Issue #1142 Acknowledgements ---------------- I would like to thank the following contributors: @alonbl I would like to thank the following bug finders and feature requestors: @avelure @jfcliche @LarsAsplund @vornkat-iis -
3.22.0
3b596686 · ·Announcements ------------- In an attempt to be more consistent in the configuration files, the following options are changing from camelCase to snake_case: +---------------+--------------+ | 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. New Features ------------ Issue #866 Added documentation which documents how to number future rules. Issue #1117 Rules automatically assign their unique identifiers. Bug Fixes --------- Issue #967 Added options to rule signal_012 to allow for grouping of signals for alignment. Issue #1096 Changed option indentStyle to indent_style Changed option indentSize to indent_size Issue #1097 Fixed JUnit reporting failures in testsuite tag when there were no failures. Removed classname from testcase tag. Issue #1123 VSG would hang on missing close parenthesis. Issue #1124 Rule port_026 would drop close parenthesis in certain conditions. Issue #1127 Issue #1129 Documentation updates Issue #1130 Rule procedure_call_003 now aligns parameters without a formal_part. Retired Issues -------------- Issue #1122 Acknowledgements ---------------- I would like to thank the following contributors: @JHertz5 I would like to thank the following bug finders and feature requestors: @alonbl @allbydnco @maltaisn @MDXZ-delti @t-aras -
3.21.0
14672c0a · ·Announcements ------------- The scoping of consistent case rules was significantly improved on this release. New Features ------------ Issue #1076 Added ignore_single_line option to rule procedure_call_003. Issue #1081 Added hierarchical alignment of => for rules constant_400, procedure_400 and sequential_400. Added ability to ignore single line aggregates. Issue #1103 Added rules procedure_006 and function_300 to enforce the structure of the formal_parameter_list. Issue #1107 Added option to allow alignment of close parenthesis of process sensitivity list. Issue #1110 Added rules generate_601 and generate_602 to enforce prefix/suffix of the identifier in for_generate_statement. Added rules loop_statement_602 and loop_statement_603 to enforce prefix/suffix of the identifier in for loops. Bug Fixes --------- Issue #551 Issue #755 Issue #998 Issue #1023 Issue #1062 Updated scoping of consistent case rules to address greedy nature of current rules. Issue #1079 Rule procedure_410 will now align on a file parameter. Issue #1082 Additional whitespace and case rules for assert statements. Issue #1084 Issue #1086 Issue #1104 Issue #1106 Issue #1113 Documentation spelling, grammar and clarification updates. Issue #1088 Added support for conditional waveforms to rule process_400. Issue #1089 Issue #1120 Unittest cleanup. Issue #1091 Issue #1100 VSG would crash if a keyword was on the first line of a file. Retired Issues -------------- Issue #1095 Issue #1100 Acknowledgements ---------------- I would like to thank the following contributors: @JHertz5 I would like to thank the following bug finders and feature requestors: @alonbl @bae-pabr @masubious @nfrancque @t-aras @Timandrias -
3.20.0
22beaa35 · ·Announcements ------------- None at this time. New Features ------------ Issue #1047 Added option 'upper_or_lower' to all case rules Issue #1065 Added rules for blank lines above and below pragmas. Redefined pragmas into open, close, and individual Issue #1070 Added keyword exception for prefix and suffix rules. Bug Fixes --------- Issue #1066: Fixed default style of rule process_021. Issue #1069: Fixed improper comment alignment in rule component_020. Issue #1074: Rule procedure_call_003 now works on sequential procedure calls. Retired Issues -------------- Issue #1073 Acknowledgements ---------------- I would like to thank the following bug finders and feature requestors: @larshb @javValverde @SittingDuc -
3.19.0
c3e408e9 · ·Announcements ------------- None at this time. New Features ------------ Issue #369 Issue #999 Assignment operator => in constant declarations are now aligned. Issue #924 Added support for camelCase and PascalCase. Issue #1000 ALPHA: Added feature to apply rules to parts of a file which are valid. Issue #1053 Rule reserved_001 added to check VHDL keywords used as identifiers. Issue #1054 Issue #1061 Added user classification of pragmas. Bug Fixes --------- Issue #815 Added several rules to assist with specific user formatting. NOTE: These rules are disabled by default. Issue #882 Moved rule concurrent_007 to conditional_waveforms_001. Issue #961 Fixed indent of comments in return functions. Issue #966 Fixed parsing of subtype_declaration with a subtype. Issue #994 Fixed detection of function calls. Issue #1034 Sub-arrays in arrays were not being detected correctly resulting in newlines being added. Issue #1057 Slice definitions in targets of generic_map were triggering generic_map_001. Retired Issues -------------- Issue #926 Acknowledgements ---------------- I would like to thank the following contributors: @SittingDuc I would like to thank the following bug finders and feature requestors: @abyszuk @JHertz @JimLewis @mkuklewski @njm295 @Scafir @t-aras @ungultig1 -
3.18.0
545ab569 · ·Announcements ------------- There were several alignment rules which were ignoring the `comment_line_ends_group` option. Please be aware that some alignment rules may trigger from the previous release. Refer to issue #988 for more details. There was also an issue with YAML configurations with options using `yes` and `no`. These options could be converted to booleans by PyYAML according to the YAML spec if they were not strings. Due to this an effort was made to change all the `True` and `False` options to `yes` and `no` strings. The original `True` and `False` are still supported, but going forward all options will be strings. Refer to issue #1009 for more details. Platform independent features were added in this release. This includes line separators and file path separators. The type of line separator can be based on the platform or hard coded. New Features ------------ Issue #896 Ability to read VHDL file from standard input Issue #945 Issue #949 Adds rules for return keywords Issue #969 Adds grouping of use clauses Issue #983 Added alignment of concurrent selected signal assignments Issue #1003 Added case rules for subtype_declarations Issue #1015 Platform independent updates Issue #1016 file_list option added to configurations Issue #1030 Added more options for indenting use clauses Issue #1010 Issue #1011 Issue #1012 Issue #1014 Issue #1017 Added pre-commit hook support Added line seperator configuration Added atomic write of files Bug Fixes --------- Issue #942 Moved instantiation_023 to port_map_010 Issue #950 procedure_012 could produce invalid code. Issue #988 Fixing alignment rules which did not honor the comment_line_ends_group Issue #990 constant_016 did not raise errors when a constraint was present. Issue #995 architecture_025 did not provide a solution message Issue #992 Issue #1001 Issue #1005 Issue #1006 Issue #1008 Issue #1035 Documentation updates Issue #1009 Fixed issue with yes and no being converted to booleans in YAML files Issue #1022 function_018 could produce invalid code Issue #1033 fixed rule conflict with selected assignments Issue #1041 Coverage updates Retired Issues -------------- Issue #908 Issue #921 Acknowledgements ---------------- I would like to thank the following contributors: @alonbl @cla5323 @cschlaak @JHertz5 @masubious @SethGower @t-aras I would like to thank the following bug finders and feature requestors: @avelure @flyinged @sibeov @zack-vii -
3.17.0
2a6f1d0f · ·Announcements ------------- None New Features ------------ Issue #952 Added case consistency for enumerated types. Issue #976: Added rule function_600 for function prefixes. Added rule function_601 for function suffixes. Bug Fixes --------- Issue #947: Rule generate_015 could create invalid code. Issue #970: Issue #973: Issue #977: Issue #979: Documentation updates Issue #975: Added action option to rule generate_011. Issue #981: Updated block comment configuration to accept empty quotes instead of "None". Issue #982: Fixed issue with closing delimited comment not being detected. Issue #984: Clarified solution for rule package_body_003. Retired Issues -------------- Issue #916 Issue #946 Issue #997 Acknowledgements ---------------- I would like to thank the following contributors: @JHertz5 I would like to thank the following bug finders and feature requestors: @el-coder-sb @flyinged @javValverde @JHertz5 @olagrottvik -
3.16.0
00518a46 · ·Announcements ------------- None New Features ------------ None Bug Fixes --------- Issue #910: Rule constant_017 misfiring on non-alinged assignment token. Issue #912: Subtypes with a resolution function crashes vsg Issue #913: Fixed reporting of correct line length violation for length_001 Issue #943: Simple concurrent assignments were being considered as arrays. Issue #951: Issue #959: Blank lines were being considered for suffix rules. Issue #960: Fixed issue with code tags causing vsg to crash Retired Issues -------------- Issue #906 Issue #944 Issue #948 Acknowledgements ---------------- I would like to thank the following contributors: I would like to thank the following bug finders and feature requestors: @abyszuk @alexsh3 @flyinged @pdanders11 @scafir