PyCharm 2017.1 Help

TypeScript Support

This feature is supported in the Professional edition only.

In this section:


PyCharm supports developing and running TypeScript source code. PyCharm recognizes *.ts files, and allows you to edit them providing full range of coding assistance without any additional steps from your side. TypeScript files are marked with the /help/img/idea/2017.1/ac_iconFileType_TypeScript.png icon.

To run, debug, and test your code you will need it translated into JavaScript which requires a compiler.

Preparing for TypeScript development

  1. Make sure the JavaScript Support plugin is enabled. The plugin is bundled with PyCharm and activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.
  2. Make sure the Node.js plugin is installed and enabled. The plugin is not bundled with PyCharm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

Coding assistance

TypeScript support includes:

  • Coding assistance:

    This assistance can be provided either by PyCharm itself, or based on the data from the TypeScript Language Service. Provision of coding assistance is configured on the TypeScript page of the Settings / Preferences Dialog:

    • Select the Use TypeScript Service check box to get native support from the TypeScript Language Service according to the up-to-date specifications. In this case, syntax and error highlighting is performed based on the annotations retrieved from the TypeScript Language Service while code completion lists contain both suggestions from the TypeScript Language Service and suggestions calculated by PyCharm itself. To get only suggestions from PyCharm, click Configure and clear the Code completion check box in the Service Options dialog box that opens.

      By default, the Use TypeScript Service check box is selected.

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

  • Refactoring:
    • Common refactoring procedures, such as extract method , inline, rename/move, etc.
    • TypeScript-specific refactoring procedures, such as change signature, extract parameter, extract variable.

    See JavaScript-Specific Refactorings for details.

  • Code generation
    • Generating code stubs based on file templates during file creation.
    • Ability to create line and block comments (Ctrl+Slash/Ctrl+Shift+Slash).
    • Generating import statements for modules, classes, and any other symbol that can be exported and called as a type, see Creating Imports, section Importing TypeScript Symbols.
    • Configuring automatic insertion or skipping the public access modifier in generated code.
  • Navigation and search through the source code:
  • Compiling to JavaScript for further running, debugging, and testing, see Running TypeScript and Debugging TypeScript.

See Also

Last modified: 26 July 2017