Skip to main content

@yarnpkg/plugin-typescript

Features

  • Automatically adds @types/ packages into your dependencies when you add a package that doesn't include its own types
  • Adds support for types to publishConfig (same behavior as publishConfig.bin)

Install

This plugin is included by default starting from Yarn 4.

Configuration

This plugin is enabled by default if you have a tsconfig.json file at the root of your project, or in your current workspace. See tsEnableAutoTypes for more information.

Example

❯ yarn/packages/plugin-typescript ❯ yarn add lodash

➤ YN0000: · Yarn X.Y.Z
➤ YN0000: ┌ Resolution step
➤ YN0000: └ Completed in 0.24s
➤ YN0000: ┌ Fetch step
➤ YN0013: │ @types/lodash@npm:4.14.121 can't be found in the cache and will be fetched from the remote registry
➤ YN0013: │ lodash@npm:4.14.0 can't be found in the cache and will be fetched from the remote registry
➤ YN0000: └ Completed in 3.63s
➤ YN0000: ┌ Link step
➤ YN0000: └ Completed in 2.75s
➤ YN0000: · Done with warnings in 6.81s

As you can see in the fetch step, even though we only added lodash into our dependencies, Yarn automatically figured out that we would need @types/lodash, and added it before we ask it to.

Index

Variables

Variables

constdefault

default: Plugin<EssentialsHooks & PackHooks> = ...