This action was originally developed by Arhia and it worked great but I ran into issues specifically with outputs being too long. This PR by ChrisWiles fixes those issues but it seems the original action creator never merged in the change. So this action is just the action created by Arhia with fixes by ChrisWiles and re-published in case others ran into the same issue I did. I don't want to take any credit here!

action-check-typescript is a GitHub action designed to compile TypeScript files and display the errors found throughout the entire codebase as well as in files changed in pull requests (PRs).

This action is currently used in production at Arhia.

• Detects and utilizes yarn or npm ci automatically when lockfiles are detected
• Builds your PR, then runs tsc to detect any errors 🔍
• Compares TypeScript errors between the base branch and PR branch to identify new errors (automatically handles line number offsets) 💪
• Does not upload any data or rely on centralized storage 👐

action-check-typescript relies on two other actions (big thanks to the authors ! ❤️) to:

• Equip-Collaboration/diff-line-numbers: Retrieve line numbers of added and removed lines in changed files.
• futuratrepadeira/changed-files: List files added, modified, and deleted.

To use action-check-typescript, add a workflow (for example, .github/workflows/check_ts.yml):

name: check-ts
on:
  pull_request:
jobs:
  ts:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Get diff lines
        id: diff
        uses: Equip-Collaboration/[email protected]
        with:
          include: '["\\.ts$"]'
      - name: Detecting files changed
        id: files
        uses: umani/[email protected]
        with:
          repo-token: ${{ github.token }}
          pattern: '^.*\.ts$'
      - name: List files changed (you can remove this step, for monitoring only)
        run: |
          echo 'Files modified: ${{steps.files.outputs.files_updated}}'
          echo 'Files added: ${{steps.files.outputs.files_created}}'
          echo 'Files removed: ${{steps.files.outputs.files_deleted}}'
      - uses: Arhia/[email protected]
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          use-check: true
          check-fail-mode: added
          files-changed: ${{steps.files.outputs.files_updated}}
          files-added: ${{steps.files.outputs.files_created}}
          files-deleted: ${{steps.files.outputs.files_deleted}}
          line-numbers: ${{steps.diff.outputs.lineNumbers}}
          output-behaviour: both
          comment-behaviour: new

By default, this action does not perform a status check (i.e., pass or fail).

You need to set use-check to true to enable a status check:

use-check: true

The determination of check status is based on the value of check-fail-mode.

The output behaviour is determined by the value of output-behaviour:

The comment behaviour depends on the value of comment-behaviour:

By default, this action uses the tsconfig file located at ./tsconfig.json.

If you need to use a different file for this action to change the behavior of tsc, you can create a specific tsconfig file (e.g., tsconfig.check.json) and set the ts-config-path parameter accordingly:

ts-config-path: "./tsconfig.check.json"

For instance, if you use watch:true in your regular tsconfig file, you should disable the watching mode for this action.