[ lint ] Add linter to the CI

Author: buzden

.derive-in-parallel

@@ -32,7 +32,7 @@ indent_size = 2
 [{*.sh,run,*.bat}]
 indent_style = space
 indent_size = 2
-shell_variant = posix
+shell_variant = bash
 switch_case_indent = true
 space_redirects = true
 

.editorconfig

@@ -0,0 +1,5 @@
+{
+  "Disable": {
+    "IndentSize": true
+  }
+}

.github/linters/.ecrc

@@ -0,0 +1,8 @@
+{
+  "ignore": [
+    "**/thirdparty/**",
+    "**/.github/**"
+  ],
+  "noSymlinks": "true",
+  "exitCode": 10
+}

.github/linters/.jscpd.json

@@ -0,0 +1,5 @@
+first-line-h1: false
+blanks-around-fences: false
+MD013:
+  line_length: 152
+  code_block_line_length: 152

.github/linters/.markdown-lint.yml

@@ -111,10 +111,10 @@ jobs:
         run: pack test ${{ env.PACKAGE_NAME }}
       - name: Gen SystemVerilog modules
         if: matrix.upstream-mode == 'latest-pack-collection'
-        run : pack run ${{ env.PACKAGE_NAME }} --to "${{ env.GENERATION_DIR }}" -n 128 --seed-name --seed-content --coverage mcov  # Generate modules
+        run: pack run ${{ env.PACKAGE_NAME }} --to "${{ env.GENERATION_DIR }}" -n 128 --seed-name --seed-content --coverage mcov  # Generate modules
       - name: Show mcov
         if: matrix.upstream-mode == 'latest-pack-collection'
-        run : cat mcov
+        run: cat mcov
       - uses: actions/upload-artifact@v4
         if: matrix.upstream-mode == 'latest-pack-collection'
         with:
@@ -399,11 +399,11 @@ jobs:
           extract: true
           fileName: ${{ matrix.tool.third_party_release_name_wildcard }}
       - name: Pre-Build tool
-        run : |
+        run: |
           ${{ matrix.tool.pre_build }}
       - name: Build tool
         if: steps.cache-build.outputs.cache-hit != 'true'
-        run : |
+        run: |
           cd ${{ matrix.tool.path }}
           ${{ matrix.tool.build }}
       - name: Save build
@@ -413,7 +413,7 @@ jobs:
           path: ${{ matrix.tool.path }}
           key: ${{ steps.cache-build.outputs.cache-primary-key }}
       - name: Install tool
-        run : |
+        run: |
           cd ${{ matrix.tool.path }}
           ${{ matrix.tool.install }}
       - name: Print version
@@ -431,7 +431,7 @@ jobs:
           python3 -m pip install --upgrade pip
           pip install plotly pandas scikit-learn numpy textdistance pyyaml ${{ matrix.tool.python_runner_deps }}
       - name: Run
-        run : |
+        run: |
           set +e
           source .venv/bin/activate
 
@@ -487,7 +487,7 @@ jobs:
         with:
           path: ${{ env.BUILD_DIR }}
           key: build-${{ hashFiles('src/**', 'verilog-model.ipkg', 'pack.toml') }}-latest-pack-collection
-      
+
       - name: Touch ${{ env.BUILD_DIR }} dir (-_-)
         run: |
           set +e

.github/workflows/ci-package.yml

@@ -0,0 +1,45 @@
+---
+name: Lint
+
+on:
+  push:
+    branches:
+      - '**'
+    tags:
+      - '**'
+  pull_request:
+    branches:
+      - main
+      - master
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+permissions:
+  statuses: write
+
+concurrency:
+  group: ${{ github.workflow }}@${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Lint Code Base
+    # Disable PR from the same repo
+    if: github.event_name != 'pull_request' ||
+        github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # Full git history is needed to get a proper
+          # list of changed files within `super-linter`
+          fetch-depth: 0
+
+      - name: Lint Code Base
+        uses: super-linter/super-linter/slim@v8
+        env:
+          DEFAULT_BRANCH: master
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          IGNORE_GENERATED_FILES: true

.github/workflows/ci-super-linter.yml

@@ -1,2 +1,2 @@
 buzden
-L3odr0id
+L3odr0id

.github/workflows/runner/rename_tests.sh

@@ -28,7 +28,7 @@ TBD
 Currently we have found several bugs in open-source instruments working with SystemVerilog.
 We are on the way of reporting them officially.
 
-To see the bugs and issues we have discovered, please visit our [website](https://deptycheck.github.io/verilog-model/).
+To see the bugs and issues we have discovered, please visit our [site](https://deptycheck.github.io/verilog-model/).
 
 ## Installation
 
@@ -65,13 +65,13 @@ verilog-model --help
 
 ### Usage
 
-The generator produces SystemVerilog test designs.  
+The generator produces SystemVerilog test designs.
 Each generated file corresponds to a **separate test**.
 
 - By default, tests are printed to the console, but you can specify a directory to save files using `--to`.
-- Every run produces different tests. You can set the seed manually to make results reproducible with `--seed` (the `--seed` option expects two numbers). 
-  
-  To see which seeds are actually used, add the `--seed-name` flag to include the seed in file names, and the `--seed-content` flag to print the seed inside the file.
+- Every run produces different tests. You can set the seed manually to make results reproducible with `--seed` (the `--seed` option expects two numbers).
+
+  To see which seeds are actually used, add the `--seed-name` flag to include the seed in filenames, and the `--seed-content` flag to print the seed inside the file.
 
 
 For all available options, run: