PhpStorm 2017.3 Help

TypeScript Tool Window

View | Tool Windows | TypeScript


PhpStorm shows this tool window only when the TypeScript Language Service is activated on the TypeScript page as described in TypeScript. Use this tool window to view the errors detected by the TypeScript Language Service and the built-in TypeScript compiler.

Errors

The tab lists the discrepancies in the code detected by the TypeScript Language Service. The list is updated dynamically as you change your code.

  • By default, the list contains only the errors from the file in the active editor tab and the full path to this file is displayed at the top. To show the errors across the entire project, press the Show project errors toggle button icon ws ts tool window show project errors on the toolbar. The tab shows error messages grouped by files in which they were detected.
    ws_ts_toolwindow_syntax_errors.png
  • To navigate to the code in question, double-click the corresponding error message or select it and choose Jump to Source on the context menu.
    ws_ts_toolwindow_syntax_errors_jump_to_source.png

Compile Errors

The tab lists the errors that occurred during compilation.

  • PhpStorm updates the list as soon as your code is recompiled. If the Recompile on changes checkbox on the TypeScript page is selected, the list is updated as you edit your code. To change this setting, clear the Recompile on changes checkbox.
  • By default, the list contains only the errors from the file in the active editor tab. To view the compilation errors across the entire compilation scope, click icon_ts_compile_all.png on the toolbar and choose Compile All from the list.
    ws_ts_toolwindow_compilation_errors.png
    The error messages are shown grouped by files in which they were detected.
  • To navigate to the code in question, double-click the corresponding error message or select it and choose Jump to Source on the context menu.
    ws_ts_toolwindow_syntax_errors_jump_to_source.png

Toolbar

ItemTooltip and shortcutDescription
icon_ts_compile_all.png Compile Click this button and choose the range of files to compile.
  • To run the compiler in all the files from the default scope, choose Compile All. The default scope is specified in the Compile scope field on the TypeScript page.
  • To run the compiler in the file opened in the active editor tab, choose the path to the file.
  • To use the scope defined in a tsconfig.json file, choose the path to the required one.
settings.png Configure Click this button to open the Typescript page and edit the TypeScript settings.
update_icon.png Restart TypeScript Service Click this button to clear the tabs and run the TypeScript Language Service anew.
help.gif Help Click this button to open the TypeScript tool window page.
icon_ws_ts_tool_window_show_project_errors.png Show project errors By default, this toggle button is released and the tab shows the errors from the current TypeScript file. Press this toggle button to show the errors across the entire project.
close Close Ctrl+Shift+F4 Click this button to terminate the compiler and the TypeScript Language Service and close the tool window.
expandAll
collapseAll
Expand all
Ctrl+NumPad Plus
Collapse all
Ctrl+NumPad -
Use these buttons to have all nodes expanded or collapsed.
icon clear all Clear All Click this button to remove all the error messages from the currently active pane.

Context Menu

The context menu is common for the Errors and the Compile Errors tabs.

Item Description
Jump to source Choose this option to open the file where the selected error was detected and navigate to the fragment of code which caused the error.
Copy Choose this option to copy the selected error message with the information on the file, the line, and the column where the error was detected.

Console

The tab shows the log of the TypeScript Language Service since the tool window was opened.

Last modified: 29 March 2018

See Also

Reference: