Skip to content
check-circle

GitHub Action

TypeScript Error Reporter

v1.0.2 Latest version

TypeScript Error Reporter

check-circle

TypeScript Error Reporter

Report type check result on PR diff view

Installation

Copy and paste the following snippet into your .yml file.

              

- name: TypeScript Error Reporter

uses: andoshin11/[email protected]

Learn more about this action in andoshin11/typescript-error-reporter-action

Choose a version

TypeScript Error Reporter Action GitHub release (latest SemVer) GitHub

Ensuring type safety is one of the most important responsibilities of modern software developers.

This action uses the TypeScript Compiler API to run a static type check on your code and display the results of the check.

TypeScript Error Reporter Action

Example Configuration

.github/workflows/test.yml:

name: Test

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [13.x]
    steps:
      - uses: actions/checkout@v1
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v1
        with:
          node-version: ${{ matrix.node-version }}
      - name: Install dependencies
        run: yarn install --frozen-lockfile
      - name: Typecheck
        uses: andoshin11/[email protected]

tsconfig.json:

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "skipLibCheck": true,
    "moduleResolution": "node",
    "types": ["node"],
    "lib": ["ES2017"]
  },
  "include": ["src/**/*.ts"]
}