test.yml

name: Test

on: [push, pull_request]

jobs:
  test:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
      fail-fast: false

    steps:
      - name: Set git to use LF
        run: |
          git config --global core.autocrlf false
          git config --global core.eol lf

      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 18

      # The vue I18next framework fixture tests rely on the documents getting recognized as `vue` documents by VSCode.
      # We set the `file.association` in the tests' .vscode/settings.json. However, `vue` is not a language identifier
      # that VSCode knows about by default, so those are ignored. It requires extensions to teach it about the `vue`
      # identifier, otherwise it marks the files as `plaintext`, the vue I18next framework doesn't run, and the tests
      # fail.
      # Instead of installing a separate Vue extension just for this identifier, for the tests, we have i18n-ally itself
      # tell VSCode about the `vue` language identifier.
      - name: Register `vue` as a VSCode language identifier
        if: runner.os != 'Windows'
        run: 'contents="$(jq ''.contributes.languages += [{"id": "vue"}]'' package.json)" && echo -E "${contents}" > package.json'

      - name: Install jq (Windows)
        if: runner.os == 'Windows'
        run: |
          Invoke-WebRequest -Uri "https://github.com/stedolan/jq/releases/download/jq-1.6/jq-win64.exe" -OutFile "C:\jq.exe"
          $env:Path += ";C:\"

      - name: Register `vue` as a VSCode language identifier (Windows)
        if: runner.os == 'Windows'
        run: |
          jq --ascii-output '.contributes.languages += [{\"id\": \"vue\"}]' package.json | Out-File -Encoding ascii "package.json.tmp"
          Move-Item -Path package.json.tmp -Destination package.json -Force
        shell: powershell

      - name: Install
        run: yarn install --frozen-lockfile
        env:
          CI: true

      - name: Build
        run: yarn build
        env:
          CI: true

      - name: Unit Tests
        run: yarn test:unit
        env:
          CI: true

      - name: E2E Tests
        run: yarn run test:e2e && yarn run test:fixture
        if: runner.os != 'Linux'
        env:
          CI: true

      - name: E2E Tests (Linux)
        run: xvfb-run -a yarn run test:e2e && xvfb-run -a yarn run test:fixture
        if: runner.os == 'Linux'
        env:
          CI: true