zxc-lint-snap.yaml

name: "ZXC: ESLint Snap"
on:
  workflow_call:
    inputs:
      snap-package-dir:
        description: "The directory of the snap package to lint:"
        type: string
        required: true
      custom-job-label:
        description: "Custom Job Label:"
        type: string
        required: false
        default: "Lint"

defaults:
  run:
    shell: bash

permissions:
  contents: read

env:
  PROJECT_DIRECTORY: packages/${{ inputs.snap-package-dir }}
  SNAP_DIRECTORY: packages/${{ inputs.snap-package-dir }}/packages/snap

jobs:
  eslint:
    name: ${{ inputs.custom-job-label || 'ESLint' }}
    runs-on: smart-contracts-linux-medium

    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
        with:
          egress-policy: audit
          disable-sudo: true

      - name: Checkout Code
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      - name: Setup Node
        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
        with:
          node-version: 18

      - name: Setup Yarn
        run: npm install -g corepack && corepack enable

      - name: Yarn Cache
        uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2
        with:
          path: ${{ env.PROJECT_DIRECTORY }}/.yarn/cache
          key: yarn-cache-${{ runner.os }}-${{ runner.arch }}-${{ inputs.snap-package-dir }}-${{ hashFiles(format('packages/{0}/yarn.lock', inputs.snap-package-dir)) }}
          restore-keys: |
            yarn-cache-${{ runner.os }}-${{ runner.arch }}-${{ inputs.snap-package-dir }}-
            yarn-cache-${{ runner.os }}-${{ inputs.snap-package-dir }}-

      - name: Node Modules Cache
        uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2
        with:
          path: |
            ${{ env.PROJECT_DIRECTORY }}/node_modules
            ${{ env.PROJECT_DIRECTORY }}/packages/snap/node_modules
            ${{ env.PROJECT_DIRECTORY }}/packages/site/node_modules
          key: node-modules-cache-${{ runner.os }}-${{ runner.arch }}-${{ inputs.snap-package-dir }}-${{ hashFiles(format('packages/{0}/yarn.lock', inputs.snap-package-dir)) }}
          restore-keys: |
            node-modules-cache-${{ runner.os }}-${{ runner.arch }}-${{ inputs.snap-package-dir }}-
            node-modules-cache-${{ runner.os }}-${{ inputs.snap-package-dir }}-

      - name: Install Snap Dependencies
        working-directory: ${{ env.PROJECT_DIRECTORY }}
        run: yarn install

      - name: Check Snap Formatting
        working-directory: ${{ env.SNAP_DIRECTORY }}
        run: yarn lint