Skip to main content

Typescript check

Set up workflow to run Typescript check on your code to detect compilation errors for every Pull Request.

Learn more about Typescript: typescriptlang.org

Usage

npx setup-ci --preset --ts

Detailed behavior

Below you can find detailed information about what the script does with your project when generating Typescript check workflow.

Installed dependencies

  • typescript (dev)

Modified and created files

FileChanges
.github/workflows/typescript.ymlContains the CI workflow
package.json
  • Missing dependencies are added
  • New script: ts:check: tsc -p . --noEmit
tsconfig.jsonCreated if no tsconfig.json was detected.

Workflow details

The following diagram represents the flow of the Typescript check CI workflow:

Known issues and limitations

  • The tsconfig.json configuration file generated by SCI might not be well tailored to your project. You will have to adjust it manually if needed.