@snowpack/plugin-typescript

This plugin adds TypeScript type checking to any Snowpack project.

When developing or building your site with Snowpack, this plugin will run TypeScript's tsc CLI in your project and pipe the output through Snowpack. Works with all version of TypeScript, as long as TypeScript is installed separately in your project.

Usage

bash

npm i @snowpack/plugin-typescript typescript

Then add the plugin to your Snowpack config:

// snowpack.config.mjs
export default {
  plugins: ['@snowpack/plugin-typescript'],
};

Plugin Options

Name	Type	Description
`tsc`	`string`	Optional custom tsc command. For example, you can use TypeScript compiler by specifying: `tsc: "tsc"`.
`args`	`string`	Optional arguments to pass to the `tsc` CLI. For example, you can configure a custom project directory (with a custom `tsconfig.json` file) using `args: "--project ./your/custom/path"`.

A Note on Yarn v2 (PnP)

TypeScript does not yet support PnP natively. The workaround is to replace the loading of the TypeScript plugin in snowpack.config.mjs with a call to pnpify.

// See https://github.com/microsoft/TypeScript/issues/28289
// More info: https://medium.com/swlh/getting-started-with-yarn-2-and-typescript-43321a3acdee
plugins: [['@snowpack/plugin-typescript', {tsc: 'yarn pnpify tsc'}]];