Merge recent commits from master

Author: Thomas Heuschling

.github/workflows/release.yml

@@ -42,7 +42,7 @@ jobs:
             --variable=colorlinks
             --variable=papersize:a4
             -o svlint_MANUAL_${{github.ref_name}}.pdf
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: pdf
           path: svlint_MANUAL_${{github.ref_name}}.pdf

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change Log
 
-## [Unreleased](https://github.com/dalance/svlint/compare/v0.9.3...Unreleased) - ReleaseDate
+## [Unreleased](https://github.com/dalance/svlint/compare/v0.9.4...Unreleased) - ReleaseDate
+
+## [v0.9.4](https://github.com/dalance/svlint/compare/v0.9.3...v0.9.4) - 2025-09-11
+
+* [Changed] Ignore compiler directive if commented in style_directives [#308](https://github.com/dalance/svlint/pull/308)
+* [Added] Add rule to prevent mixing operators with confusing precedence [#301](https://github.com/dalance/svlint/pull/301)
+* [Fixed] Fix crash in style_keyword_0or1space [#300](https://github.com/dalance/svlint/pull/300)
+* [Added] feat: add style_keyword_1spaceornewline rule [#297](https://github.com/dalance/svlint/pull/297)
+* [Added] feat: add support for file encoding detection [#294](https://github.com/dalance/svlint/pull/294)
 
 ## [v0.9.3](https://github.com/dalance/svlint/compare/v0.9.2...v0.9.3) - 2024-06-03
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "svlint"
-version = "0.9.3"
+version = "0.9.4"
 authors = ["dalance@gmail.com"]
 repository = "https://github.com/dalance/svlint"
 keywords = ["SystemVerilog", "Verilog", "lint", "svls"]

MANUAL.md

@@ -408,6 +408,9 @@ Compiler directives should not cause whitespace issues or hide in other code.
 `resetall
 /* This FILE is `__FILE__ */
 /* This LINE is `__LINE__ */
+// This directive is commented `celldefine
+module testmodule(); //Those directives are also commented `ifdef FOO Foo `else Bar `endif
+endmodule
 `include "testcases/syntaxrules/pass/blocking_assignment_in_always_ff.sv"
 `define FOO 5
 `ifdef FOO
@@ -418,17 +421,18 @@ Compiler directives should not cause whitespace issues or hide in other code.
 `endif
 `undef FOO
 `undefineall
-
+`ifdef FOO // `ifdef BAR
+`endif
 ```
 
-### Fail Example (1 of 3)
+### Fail Example (1 of 4)
 ```systemverilog
 module `ifdef FOO Foo `else Bar `endif
   (); // ifdef, else, and endif are on a single line.
 endmodule
 ```
 
-### Fail Example (2 of 3)
+### Fail Example (2 of 4)
 ```systemverilog
 `ifdef FOO
   `ifdef BAR
@@ -439,7 +443,7 @@ endmodule
 `endif
 ```
 
-### Fail Example (3 of 3)
+### Fail Example (3 of 4)
 ```systemverilog
 module M ();
   always_comb
@@ -455,6 +459,12 @@ module M ();
 endmodule
 ```
 
+### Fail Example (4 of 4)
+```systemverilog
+ `ifdef FOO // The ifdef is not commented and indented
+`endif
+```
+
 ### Explanation
 
 Check that (most) preprocessor and compiler directives are not indented, and

snapcraft.yaml

@@ -1,5 +1,5 @@
 name: svlint
-version: &version v0.9.3
+version: &version v0.9.4
 summary: SystemVerilog linter
 description: |
   A lint checker supporting SystemVerilog ( IEEE Std. 1800-2017 )

src/textrules/style_directives.rs

@@ -5,6 +5,7 @@ use regex::Regex;
 #[derive(Default)]
 pub struct StyleDirectives {
     re: Option<Regex>,
+    re_comment: Option<Regex>,
 }
 
 impl TextRule for StyleDirectives {
@@ -46,20 +47,23 @@ impl TextRule for StyleDirectives {
 
             self.re = Some(Regex::new(format!("^(.+)`({})", keywords).as_str()).unwrap());
         }
+        if self.re_comment.is_none() {
+            self.re_comment = Some(Regex::new(format!(r"//").as_str()).unwrap());
+        }
         let re = self.re.as_ref().unwrap();
+        let re_comment = self.re_comment.as_ref().unwrap();
 
         if let Some(caps) = re.captures(line) {
             if let Some(m) = caps.get(1) {
-                TextRuleResult::Fail {
-                    offset: 0,
-                    len: m.as_str().chars().count(),
+                if !re_comment.is_match(m.as_str()) {
+                    return TextRuleResult::Fail {
+                        offset: 0,
+                        len: m.as_str().chars().count(),
+                    }
                 }
-            } else {
-                TextRuleResult::Pass
             }
-        } else {
-            TextRuleResult::Pass
         }
+        TextRuleResult::Pass
     }
 
     fn name(&self) -> String {

testcases/textrules/fail/style_directives.sv

@@ -22,3 +22,6 @@ module M ();
       b = e;
     `endif
 endmodule
+////////////////////////////////////////////////////////////////////////////////
+ `ifdef FOO // The ifdef is not commented and indented
+`endif

testcases/textrules/pass/style_directives.sv

@@ -12,6 +12,9 @@
 `resetall
 /* This FILE is `__FILE__ */
 /* This LINE is `__LINE__ */
+// This directive is commented `celldefine
+module testmodule(); //Those directives are also commented `ifdef FOO Foo `else Bar `endif
+endmodule
 `include "testcases/syntaxrules/pass/blocking_assignment_in_always_ff.sv"
 `define FOO 5
 `ifdef FOO
@@ -22,4 +25,5 @@
 `endif
 `undef FOO
 `undefineall
-
+`ifdef FOO // `ifdef BAR
+`endif