Skip to content

Commit

Permalink
Merge pull request #1 from imbsky/readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
andoshin11 authored Apr 4, 2020
2 parents 573c023 + f16fdab commit d6fec06
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,38 @@
# TypeScript Error Reporter Action
Ensuring type-safetiness is one of the most critical responsibility for modern software developers.

This Action will provide you the easiest way to run type checks and see the result for each Pull Requests.
Ensuring type safety is one of the most important responsibilities of modern software developers.

This action uses the [TypeScript Compiler API](https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API) to run a static type check on your code and display the results of the check.

![TypeScript Error Reporter Action](https://user-images.githubusercontent.com/8381075/78413929-a40f0680-7654-11ea-8365-0ef72fb4d6b3.png)

## Usage
This Action uses [TypeScript Compiler API](https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API) to satically run diagnostics over your app and shows you the result of the checks.
## Example Configuration

`.github/workflows/test.yml`:

```yaml
name: main
name: Test

on: [push]
on: [push, pull_request]

jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [13.x]
steps:
- name: Setting up Node.js v12.13.0
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Install dependencies
run: |
yarn install
- uses: andoshin11/[email protected]
run: yarn --frozen-lockfile
- name: Typecheck
uses: andoshin11/[email protected]
```
whereas your `tsconfig.json` should look like this.
`tsconfig.json`:

```json
{
Expand Down

0 comments on commit d6fec06

Please sign in to comment.