lint.yml

# GitHub workflow configuration file: Linting
#
# Copyright (C) 2022    Lucas Ritzdorf, Luca Zeuch
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

---
name: Lint

on:
  push:
    paths-ignore:
      - '*.txt'
  pull_request:
    paths-ignore:
      - '*.txt'

jobs:

  lint-vim:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v2

      - name: Ensure pip is installed
        run: |
          sudo apt update -y && sudo apt install python3-pip -y

      - name: Install vim-vint
        run: |
          python3 -m pip install --upgrade pip
          pip install vim-vint

      - name: Run VimL linter
        run: make lint

  lint-python:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v2

      - name: Lint with Pyright
        uses: jakebailey/pyright-action@v1

  lint-markdown:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v2

      - name: Lint with Markdownlint
        uses: actionshub/markdownlint@main
        with:
          filesToIgnoreRegex: "LICENSE.*|permission\\.md"