From 37dd3ce1ffed3bd3671c3902381f8e389b76efd4 Mon Sep 17 00:00:00 2001 From: BSKY Date: Sat, 4 Apr 2020 10:49:33 +0900 Subject: [PATCH 1/2] Update README.md --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a68c538..ad2f5f0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # 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. @@ -6,25 +7,29 @@ This Action will provide you the easiest way to run type checks and see the resu ![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. ```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/typescript-error-reporter-action@v1.0.0 + run: yarn --frozen-lockfile + - name: Typecheck + uses: andoshin11/typescript-error-reporter-action@v1.0.0 ``` whereas your `tsconfig.json` should look like this. From f16fdab75e0305d523ce2ae0ec4b3a6e1eec8b96 Mon Sep 17 00:00:00 2001 From: BSKY Date: Sat, 4 Apr 2020 11:25:55 +0900 Subject: [PATCH 2/2] Tweaks --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ad2f5f0..a8e13ec 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # TypeScript Error Reporter Action -Ensuring type-safetiness is one of the most critical responsibility for modern software developers. +Ensuring type safety is one of the most important responsibilities of modern software developers. -This Action will provide you the easiest way to run type checks and see the result for each Pull Requests. +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 +## Example Configuration -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. +`.github/workflows/test.yml`: ```yaml name: Test @@ -32,7 +32,7 @@ jobs: uses: andoshin11/typescript-error-reporter-action@v1.0.0 ``` -whereas your `tsconfig.json` should look like this. +`tsconfig.json`: ```json {