Use updated API for svlint v0.8.0

[DaveMcEwan]

• Add some basic test infrastructure, extending Setup basic CI flow #6.
  This PR can be merged either after or instead of Setup basic CI flow #6.
• Superceeds Updated example for Vec of Rule #5 by supporting a list of rules which may be either TextRule or SyntaxRule.
  Thanks @skjdbg :)
• Should not be merged until svlint v0.8.0 is released.
  After that, another commit is required to this PR: Cargo.toml dependency on svlint should be "0.8", not the pin to a specific commit in my fork. DONE
• Updates to README.

[DaveMcEwan]

As per dalance/svlint#253, this will be changed from draft to proper after svlint v0.8.0 is released.

[skjdbg]

On my local version of svlint (where I had pulled some of your changes) the SyntaxRules work fine, but the TextRule reports errors multiple lines before the actual errors.

I'm recompiling to check with your last commits, but it take a very long time on this machine. I'll tell you if anything changes.

[skjdbg]

@DaveMcEwan I tested with your last commits and I still have the error. It seems to only work properly if the regex "XXX" matches on the first line of the file.
I don't see any obvious mistakes in textrules_check or in forbidden_regex and I don't see any changes in the printer so I'm not sure what could be causing this.

[DaveMcEwan]

Does that mean cargo test reports basic_text_fail_2of3 and basic_text_fail_3of3 are failing? I see all 3 passing like https://github.com/DaveMcEwan/svlint-plugin-sample/actions/runs/5333285376/jobs/9663558718

[skjdbg]

All tests pass, yet when I call ./target/debug/svlint.exe -p ../path/to/svlint_plugin_sample.dll ./path/to/test_file.sv (content of test_file.sv at the end of this comment)

• The first mistake is treated properly.
• The second mistake is detected on the right line. but no text is shown
• All other mistakes are detected, but the line at which it is detected is wrong (and so the text shown is also wrong

Here is the console output

Fail: forbidden_regex
   --> path\to\test_file.sv:1:1
  |
1 | class driver extends uvm_driver#(seq_item); // XXX
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ hint  : Remove the string 'XXX' from all lines.
  |                                                    reason: XXX is not meaningful enough.

Fail: forbidden_regex
   --> path\to\test_file.sv:2:0
  |
2 |
  |  hint  : Remove the string 'XXX' from all lines.
  |  reason: XXX is not meaningful enough.

Fail: forbidden_regex
   --> path\to\test_file.sv:3:35
  |
3 |   task run_phase (uvm_phase phase);
  |                                   ^ hint  : Remove the string 'XXX' from all lines.
  |                                     reason: XXX is not meaningful enough.

Fail: forbidden_regex
   --> path\to\test_file.sv:5:11
  |
5 |       // Test
  |           ^^^ hint  : Remove the string 'XXX' from all lines.
  |               reason: XXX is not meaningful enough.

Fail: forbidden_regex
   --> path\to\test_file.sv:7:14
  |
7 |       foo <= bar;
  |              ^^^^ hint  : Remove the string 'XXX' from all lines.
  |                   reason: XXX is not meaningful enough.

and the content of test_file.sv

class driver extends uvm_driver#(seq_item); // XXX
//XXX
  task run_phase (uvm_phase phase);
      foobar.get_next_item(XXX);
      // Test
      foo <= bar; //XXX
      foo <= bar;

      baz <= XXX;
  endtask
endclass : droiver

[DaveMcEwan]

I can't reproduce this. I've just tried in a clean workspace and get this:

The commands I'm running to reproduce:

cd /work/damc/ # A new working area.
vim test_file.sv # Copy your testcase.

# Build the plugin.
git clone https://github.com/DaveMcEwan/svlint-plugin-sample.git
pushd svlint-plugin-sample && git checkout api && cargo build && cargo test && popd

# Get the matching branch for svlint.
git clone https://github.com/DaveMcEwan/svlint.git
cd svlint && git checkout api

# Run the test.
cargo run -- -p ../svlint-plugin-sample/target/debug/libsvlint_plugin_sample.so ../test_file.sv

[DaveMcEwan]

I get consistent behaviour between Linux (previous comment) and Windows.

[skjdbg]

I think it's a matter of CRLF vs LF. I repeated your steps on a linux machine, but wrote test_file.sv from vscode on windows and nothing changed.
Then I deleted test_file.sv and rewrote it manually from within a linux terminal editor, and I got your results

[DaveMcEwan]

Ok cool. I can reproduce that with set ff=dos in Vim.
I think it's related to https://github.com/dalance/svlint/blob/master/src/main.rs#L278-L280,
LintFailed, and a few places in src/printer.rs that results in a mis-count of the line number.

Summary of issue: svlint reports wrong line numbers for TextRule failures in DOS-format files (CRLF).

From a quick look, it doesn't look trivial to fix! However, a fix shouldn't conflict with any of the open PRs.

[skjdbg]

On another note, in forbidden_regex.rs, why do you format the regex ?
As far as I know, this

let r = format!(r"XXX");
self.re = Some(Regex::new(&r).unwrap());

should be the same as this

let r = r"XXX";
self.re = Some(Regex::new(r).unwrap());

[DaveMcEwan]

On another note, in forbidden_regex.rs, why do you format the regex ?

You're right, I just copied from https://github.com/dalance/svlint/blob/master/src/textrules/header_copyright.rs for the example, but it isn't necessary.

[skjdbg]

Well then I have no more issues. =)

[DaveMcEwan]

@skjdbg I put a fix for the CRLF issue into the api branch of svlint. Would you mind checking that it's fixed for you too?

[skjdbg]

It works on my side !