{"id":28513075,"url":"https://github.com/lowlydba/tsc-check","last_synced_at":"2026-05-06T08:36:17.226Z","repository":{"id":297839927,"uuid":"989755882","full_name":"lowlydba/tsc-check","owner":"lowlydba","description":"🛡️🐶 GitHub Action to check TypeScript errors with tsc and ReviewDog, enforcing error thresholds and incremental type safety.","archived":false,"fork":false,"pushed_at":"2025-12-09T19:07:28.000Z","size":21,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-10T20:54:03.472Z","etag":null,"topics":["github-actions","reviewdog","transpile","tsc","typescript"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/tsc-check","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lowlydba.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-24T19:01:02.000Z","updated_at":"2025-12-09T19:06:46.000Z","dependencies_parsed_at":"2025-07-14T23:19:08.573Z","dependency_job_id":"190f7c4e-e770-4fae-b342-9e902b943212","html_url":"https://github.com/lowlydba/tsc-check","commit_stats":null,"previous_names":["lowlydba/tsc-check"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/lowlydba/tsc-check","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowlydba%2Ftsc-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowlydba%2Ftsc-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowlydba%2Ftsc-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowlydba%2Ftsc-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lowlydba","download_url":"https://codeload.github.com/lowlydba/tsc-check/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowlydba%2Ftsc-check/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32684987,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-06T08:33:17.875Z","status":"ssl_error","status_checked_at":"2026-05-06T08:33:17.221Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","reviewdog","transpile","tsc","typescript"],"created_at":"2025-06-09T01:06:09.289Z","updated_at":"2026-05-06T08:36:17.221Z","avatar_url":"https://github.com/lowlydba.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tsc Check GitHub Action \u003c!-- omit in toc --\u003e\n\n- [Introduction](#introduction)\n- [How-to Guides](#how-to-guides)\n  - [Basic Usage](#basic-usage)\n  - [Detecting New TypeScript Errors](#detecting-new-typescript-errors)\n- [Reference](#reference)\n  - [Inputs](#inputs)\n- [Explanation](#explanation)\n  - [How It Works](#how-it-works)\n  - [When to Use](#when-to-use)\n\n\n## Introduction\n\n**tsc Check** is a GitHub Action that runs a TypeScript compilation check (`tsc`) and integrates with [ReviewDog](https://github.com/reviewdog/reviewdog) to provide feedback on pull requests by reporting TypeScript errors.\nIt is designed to help teams incrementally improve type safety in projects with a high water mark for existing errors. The action fails if new errors are introduced in modified files, or if the total number of errors exceeds a configurable threshold.\n\nThe high water mark can be set manually or updated from an external process as your project improves, enabling teams to gradually reduce technical debt while maintaining momentum.\n\n---\n\n## How-to Guides\n\n### Basic Usage\n\nBelow is an example of how to use this action in your workflow:\n\n```yaml\nname: TypeScript Check\n\non:\n  pull_request:\n    paths:\n      - '**/*.ts'\n      - '**/*.tsx'\n\njobs:\n  tsc-check:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout code\n        uses: actions/checkout@v3\n\n      - name: Run tsc Check\n        uses: lowlydba/tsc-check@v1.0.0\n        with:\n          reviewdog-version: \"latest\"\n          workdir: \".\"\n          high-water-mark: \"10\"\n          level: \"error\"\n          reporter: \"github-pr-check\"\n          filter-mode: \"added\"\n          fail-on-error: \"true\"\n          tsc-flags: \"--noEmit --skipLibCheck\"\n```\n\n### Detecting New TypeScript Errors\n\nFor a step-by-step guide on detecting new TypeScript errors between branches, see [Detecting New TypeScript Transpile Errors](docs/find-tsc-regressions.md).\n\n## Reference\n\n### Inputs\n\n| Name                | Description                                                                 | Default                  | Required |\n|---------------------|-----------------------------------------------------------------------------|--------------------------|----------|\n| `reviewdog-version` | Version of ReviewDog to use.                                               | `latest`                 | No       |\n| `typescript-version`| Version of the TypeScript npm package to use.                              | `latest`                 | No       |\n| `workdir`           | Working directory relative to the root directory.                          | `.`                      | No       |\n| `high-water-mark`   | Maximum number of errors allowed before failing the action.                | `0`                      | No       |\n| `help-doc-url`      | URL to help documentation for this action.                                 | See action.yml           | No       |\n| `level`             | Report level for ReviewDog (`info`, `warning`, `error`).                   | `error`                  | No       |\n| `reporter`          | Reporter for ReviewDog (`github-check`, `github-pr-check`, `github-pr-review`). | `github-pr-check`        | No       |\n| `filter-mode`       | Filtering mode for ReviewDog (`added`, `diff_context`, `file`, `nofilter`).| `added`                  | No       |\n| `fail-on-error`     | Whether to fail the action if errors are found (`true`, `false`).          | `false`                  | No       |\n| `reviewdog-flags`   | Additional flags for ReviewDog.                                            | `\"\"`                    | No       |\n| `tool-name`         | Tool name to use for ReviewDog reporter.                                   | `tsc`                    | No       |\n| `tsc-flags`         | Flags and arguments to pass to `tsc`.                                      | `--noEmit --skipLibCheck`| No       |\n\n## Explanation\n\n### How It Works\n\n- **TypeScript Compilation**: The action runs `tsc` in the specified working directory with configurable flags.\n- **Error Threshold**: If the number of errors exceeds the `high-water-mark`, the action fails and provides a link to help documentation.\n- **ReviewDog Integration**: All `tsc` output is piped to ReviewDog, which annotates pull requests with errors and warnings according to your configuration.\n- **Incremental Adoption**: By setting a high water mark, teams can prevent new errors from being introduced while gradually reducing existing errors.\n\n### When to Use\n\nUse this action if you want to:\n\n- Prevent new TypeScript errors from entering your codebase.\n- Incrementally improve type safety in large or legacy projects.\n- Provide clear, actionable feedback to contributors via GitHub PR annotations.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flowlydba%2Ftsc-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flowlydba%2Ftsc-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flowlydba%2Ftsc-check/lists"}