https://github.com/keita-hino/vue-tsc-action

This Github action runs vue-tsc against .vue files and display the errors found in whole codebase.
https://github.com/keita-hino/vue-tsc-action

github-actions typescript vue vue-tsc

Last synced: 2 months ago
JSON representation

This Github action runs vue-tsc against .vue files and display the errors found in whole codebase.

• Host: GitHub
• URL: https://github.com/keita-hino/vue-tsc-action
• Owner: keita-hino
• License: mit
• Created: 2021-08-26T12:31:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-28T13:39:22.000Z (over 1 year ago)
• Last Synced: 2024-10-17T09:00:13.508Z (3 months ago)
• Topics: github-actions, typescript, vue, vue-tsc
• Language: TypeScript
• Homepage:
• Size: 1.05 MB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# vue-tsc-action

This Github action runs [vue-tsc](https://github.com/johnsoncodehk/volar/tree/master/packages/vue-tsc) against `.vue` files and display the errors found in whole codebase.

# preparation

1. Include [vue-tsc](https://github.com/johnsoncodehk/volar/tree/master/packages/vue-tsc) in package.json

2. Add tsconfig.json

# Usage

Add to your existing workflow file or create a new file named `.github/workflows/check_vue_tsc.yml` and copy over one of the examples below to your new workflow file.

This is the simplest example to get it running:

```yml

name: check-vue-tsc

on: push

jobs:

  vue-tsc:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - uses: actions/setup-node@v2

        with:

          node-version: 18

      - uses: keita-hino/vue-tsc-action@main

```

If there is an error, the error details will be displayed in the workflow execution log.



# License

All scripts in this project are released under the MIT License.