Skip to content

GitHub Action to diagnose TypeScript errors and report the result on PR.

License

Notifications You must be signed in to change notification settings

quantizor/typescript-error-reporter-action

 
 

Repository files navigation

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/typescript-error-reporter-action@v1.0.2

tsconfig.json:

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

About

GitHub Action to diagnose TypeScript errors and report the result on PR.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.9%
  • JavaScript 0.1%