PyCharm
 
2024.3
Shortcuts: Windows
Get PyCharm
  1. Reference
  2. Settings
  3. Languages and Frameworks
  4. TypeScript
Professional

TypeScript

Last modified: 01 November 2024

File | Settings | Languages & Frameworks | TypeScript for Windows and Linux

PyCharm | Settings | Languages & Frameworks | TypeScript for macOS

CtrlAlt0S the Settings icon

Required plugin: JavaScript and TypeScript

The plugin is bundled with PyCharm and enabled by default.

Available only in PyCharm Professional: download to try or compare editions

warning

The page is available only when the JavaScript and Typescript plugin is enabled on the Settings | Plugins page as described in Managing plugins.

Node interpreter

In this field, specify the Node.js interpreter to use.

If you choose the Project alias, PyCharm will automatically use the project default interpreter from the Node interpreter field on the Node.js page . In most cases, PyCharm detects the project default interpreter and fills in the field itself.

You can also choose another configured local or remote interpreter or click the Browse button and configure a new one.

TypeScript

In this field, specify the version of the TypeScript to use (PyCharm displays the currently chosen version).

  • By default, the typescript package from the project's node_modules folder is used.

  • Bundled: choose this option to use the typescript package that is shipped with PyCharm without attempting to find another one.

  • Select: choose this option to use a custom typescript package instead of the one bundled with PyCharm. In the dialog that opens, choose the path to the relevant package.

  • If your project package manager is Yarn 2, you have to use the typescript package installed via Yarn 2. In this case, yarn:package.json:typescript is by default selected.

    Learn more about package managers from npm and Yarn.

TypeScript Language Service

Select this checkbox to get native support from the TypeScript Language Service according to the up-to-date specifications. As a result:

  • Syntax and error highlighting is based on the annotations from the TypeScript Language Service.

  • Completion lists contain both suggestions from the TypeScript Language Service and suggestions calculated by PyCharm.

  • TypeScript code is compiled into JavaScript.

tip

By default, the TypeScript Language Service checkbox is selected.

Item

Description

Show project errors

By default, this checkbox is selected and the TypeScript Language Service checks the code across the entire project. The detected errors are listed in the Project Errors tab of the Problems tool window grouped by files where they occurred.

To avoid performance issues, clear the Show project errors checkbox so the TypeScript Language Service checks files only when you open them. The Project Errors tab will then list the errors that are detected only in the files that you have already opened.

Show suggestions

By default, this checkbox is selected and PyCharm shows potential problems that the TypeScript Language Service detects in your code in addition to actual errors.

Show suggestions is enabled

Use types from server

Select this checkbox to evaluate types of symbols based on the data from the TypeScript Compiler.

By default, the checkbox is cleared, so type evaluation, resolution, code inspections and refactorings are based on the type information from the PyCharm internal TypeScript engine.

This default behavior may result in performance issues and in bugs in type resolution because the type evaluation algorithm that the PyCharm internal TypeScript engine uses differs from the algorithm of the TypeScript Compiler. Selecting the checkbox may help avoid these problems.

note

Some of the code highlighting and completion are always retrieved from the TypeScript Language Service if the TypeScript Language Service checkbox is selected, no matter whether the Use types from server checkbox is selected or cleared.

Recompile on changes

  • When this checkbox is selected, the compiler "wakes up" upon any change to a TypeScript file.

  • When this checkbox is cleared, the compiler ignores changes to TypeScript files.

Options

In this field, specify the command-line options to be passed to the TypeScript Language Service when the tsconfig.json file is not found. See the list of acceptable options at TSC arguments. Note that the -w or --watch (Watch input files) option is irrelevant.

tip

You can enhance completion in JavaScript files with suggestions from the TypeScript Language Service. To do that, add 'allowJS' : true to your jsconfig.json or tsconfig.json file. Learn more from Code completion and Configure JavaScript libraries.

See also

Procedures