TypeScript Hero is a vscode extension that makes your live easier.
When you are coding a lot of TypeScript you may want vscode to automatically
include your imports.
If you search for this feature: here's the solution (and many more). Typescript hero will be extended in the future and there are many features in the pipeline that will enhance the way you work with typescript.
Here is a brief list, of what TypeScript Hero is capable of (more at the end):
- Add imports of your project or libraries to your current file
- Add an import for the current name under the cursor
- Add all missing imports of a file with one command
- Intellisense that suggests symbols and automatically adds the needed imports
- "Light bulb feature" that fixes code you wrote
- Sort and organize your imports (sort and remove unused)
- Restart your debug session when your code changes
All commands are preceeded by typescriptHero.
| Command | Extension part | Description |
|---|---|---|
| showCmdGui | general | Shows a small gui with all available internal commands |
| resolve.addImport | import resolver | Shows a pick list with all recognized, importable symbols |
| resolve.addImportUnderCursor | import resolver | Imports the symbol under the cursor |
| resolve.addMissingImports | import resolver | Imports all missing symbols for the actual document |
| resolve.organizeImports | import resolver | Removes unused imports and orders all imports |
| resolve.rebuildCache | import resolver | Rebuilds the whole symbol cache (or index) |
| restartDebugger.toggle | debug restarter | Toggles the active state of the debug restarter |
The following commands are bound by default when the extension is installed.
| Command | Keybinding |
|---|---|
| showCmdGui | ctrl+alt+g |
| resolve.addImport | ctrl+alt+i |
| resolve.addImportUnderCursor | ctrl+alt+shift+i |
| resolve.organizeImports | ctrl+alt+o |
In the following tables, all possible settings are explained. If you find any settings that are not listed here, that means they are "beta" or "not implemented yet".
All settings are preceeded by typescriptHero.
These settings do not have a prefix.
| Setting | Description |
|---|---|
| verbosity | The log level that the extension writes its messages to the output channel |
The following settings do have the prefix resolver. So an example setting could be
typescriptHero.resolver.pathStringDelimiter.
| Setting | Description |
|---|---|
| pathStringDelimiter | The string delimiter to use for the imports |
| ignorePatterns | If any of these strings is part of a file path, the file is ignored |
| insertSpaceBeforeAndAfterImportBraces | If the extension should place spaces into import braces ({Symbol} vs { Symbol }) |
| insertSemicolons | If the extension should add a semicolon to the end of a statement |
| multiLineWrapThreshold | The threshold, when imports are converted into multiline imports |
| newImportLocation | The location of new imports (at the top of the file, or at the cursor location) |
The following settings do have the prefix restartDebugger. So an example setting could be
typescriptHero.restartDebugger.watchFolders.
| Setting | Description |
|---|---|
| watchFolders | Which output folders should be watched to trigger a restart |
| active | If true, the debug restart is activated on startup |
TypeScript Hero can manage your imports. It is capable of:
- Import something you select from a list of all possible indexed symbols
- Import something that is beneath your current cursor position (and ask you if it's not sure which one)
- Import all missing identifiers of the current file
- Remove unused imports and sort the remaining ones by alphabet
Intellisense is a common IDE feature. TypeScript Hero provides you with symbols as you type your code and does add the import to the top of the file, if you don't have already imported the symbol.
The "light-bulb" feature of VSCode can provide some code-fix actions to take when you make mistakes. TypeScript Hero offers the following fix actions:
- Detect a missing import and automatically add the import to the file
- Detect a missing import and offer to add all missing imports to the file
- Detect missing methods / properties of an interface that you implemented and implement them for you (implement interface refactoring)
- Detect missing abstract methods of an extended abstract class and implement them for you (implement abstract class refactoring)
TypeScript Hero does detect changes to configurable directories in your workspace and restarts the
debugger (if it's running) after a short delay (actually calls the restartDebugger command).
Please visit the issue list :-)