lint.yml

name: Lint

on:
  push:
    branches:
      - main

  pull_request:
    branches:
      - main

permissions:
  contents: read

jobs:
  super-linter:
    name: Lint Code Base
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
      actions: read
      checks: read
      statuses: write
    steps:
      - name: Checkout Code
        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@v6
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          VALIDATE_ALL_CODEBASE: false
          DEFAULT_BRANCH: master
          LINTER_RULES_PATH: .
          MARKDOWN_CONFIG_FILE: .markdownlint.json

  docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout VSL
        uses: actions/checkout@v4
        with:
          path: vsl
      - name: Setup V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true
      - name: Setup VSL as V module
        run: mv vsl ~/.vmodules/
      - name: Validate Docs
        run: v check-md -hide-warnings ~/.vmodules/vsl

  fmt:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout VSL
        uses: actions/checkout@v4
        with:
          path: vsl
      - name: Setup V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true
      - name: Setup VSL as V module
        run: mv vsl ~/.vmodules/
      - name: Check Formatting
        # NOTE: `cd` into module dir required. Currently, running `v fmt -verify` from outside the module dir
        # would encounter errors and `v fmt -w` would even break the module.
        run: cd ~/.vmodules/vsl && v fmt -verify .