feat: add verilator as a linter tool

.github/workflows/tests.yaml

@@ -53,10 +53,13 @@ jobs:
         echo "${{ env.VERILATOR_INSTALL }}/bin" >> $GITHUB_PATH
         echo "${{ github.workspace }}/contrib/svunit/bin" >> $GITHUB_PATH
 
-    - name: Run tests for package
+    - name: Lint the package
+      run: make lint_verilator
+
+    - name: Test the package
       run: make -C tests test_verilator
 
-    - name: Run tests for examples
+    - name: Test documentation examples
       run: make -C docs/modules/ROOT/examples/selftest test_verilator
 
     - name: Parse test results

Makefile

@@ -1,15 +1,28 @@
-.PHONY: all test test_src test_examples
+.PHONY: all lint lint_verilator test test_src test_examples
 
-all: test
+export SVJSON_ROOT := $(realpath .)
+
+all: lint test
+
+lint: lint_verilator
+
+# VARHIDDEN - too strict, method arguments may overlap with class property names
+# UNDRIVEN - has false positives on interface classes and custom constructors
+lint_verilator:
+	@echo "Lint sources with Verilator"
+	verilator --lint-only -f $(SVJSON_ROOT)/src/filelist.f \
+	-Wall -Wno-VARHIDDEN -Wno-UNDRIVEN
 
 test: test_src test_examples
 
 test_src:
+	@echo "Run tests for main sources"
 	make -C tests test
 
 test_examples:
+	@echo "Run tests for documentation example snippets"
 	make -C docs/modules/ROOT/examples/selftest test
 
 clean:
 	make -C tests clean
-	make -C docs/modules/ROOT/examples/selftest clean
+	make -C docs/modules/ROOT/examples/selftest clean

docs/modules/ROOT/pages/changelog.adoc

@@ -12,6 +12,7 @@ and this project adheres to {url-semantic-versioning}[Semantic Versioning].
 === Added
 
 *  Add a table of supported EDA tools
+*  Add Verilator as a linter
 
 === Fixed
 === Changed

src/json_decoder.sv

@@ -107,9 +107,8 @@ function json_result json_decoder::load_string(string str);
   case (1)
     result.matches_ok(parsed): begin
       parser_result check_result = decoder.check_trailing_chars(str, parsed.end_pos + 1);
-      parsed_s ok;
       case (1)
-        check_result.matches_ok(ok): return json_result#()::ok(parsed.value);
+        check_result.is_ok(): return json_result#()::ok(parsed.value);
         check_result.matches_err(error): return json_result#()::err(error);
       endcase
     end

tests/Makefile

@@ -13,6 +13,7 @@ all: test
 test: test_verilator
 
 test_verilator:
+	@echo Test sources with Verilator
 	runSVUnit \
 		-s verilator \
 		-l run.log \