lint.yml

---
name: Lint

#############################
# Start the job on push #
#############################
on:
  push:
    branches-ignore: [main]
  pull_request:
    branches: [main]

###############
# Set the Job #
###############
jobs:
  build:
    # Name the Job
    name: Run ESLint, Prettier, and TypeScript compiler
    # Set the agent to run on
    runs-on: ubuntu-latest

    ##################
    # Load all steps #
    ##################
    steps:
      ##########################
      # Checkout the code base #
      ##########################
      - name: Checkout Code
        uses: actions/checkout@v3
        with:
          # Full git history is needed to get a proper
          # list of changed files within `super-linter`
          fetch-depth: 0

      ################################
      # Install packages #
      ################################
      - name: Install packages
        run: npm ci
      ################################
      # Lint codebase #
      ################################
      - name: Run ESLint
        run: npx eslint .
      ################################
      # Check Prettier on codebase #
      ################################
      - name: Run Prettier
        run: npx prettier --check .
      ################################
      # Check for TypeScript errors #
      ################################
      - name: Run TypeScript compiler (tsc)
        run: npx tsc --noEmit