Repository files navigation

Make your Vim a TypeScript IDE.

Tsuquyomi works as a client forTSServer (which is an editor service bundled into TypeScript).So, installing Tsuquyomi, your vim gets the following features provided by TSServer:

• Completion (omni-completion)
• Navigate to the location where a symbol is defined.
• Show location(s) where a symbol is referenced.
• Display a list of syntax and semantics errors to Vim quickfix window.
• and so on,,,

Tsuquyomi does not provide syntax-highlight nor indentation. You can use the following Vim plugins for writing .ts:

• leafgarland/typescript-vim provides syntax highlight.
• Quramy/vim-js-pretty-template provides syntax highlight for contents in Template Strings.
• jason0x43/vim-js-indent provides function of indent for both JavaScript and TypeScript.
• Quramy/vim-dtsm provides.d.ts management fordtsm users.
• mhartington/vim-typings provides.d.ts management fortypings users.

Tsuquyomi requires the following:

• Vim (vim7.4 or later)
• Node.js &TypeScript
• Shougo/vimproc.vim (Not required if you use vim8 or later)

npm -g install typescript

Download zip.file fromhere, or use your favorite Vim plugin manager.

Seehttps://github.com/tpope/vim-pathogen for instructions to install pathogen itself(very simple one-line install, one-line config)

# create bundle folder if it doesn't existmkdir -p ~/.vim/bundle# Install and compile procvim.vimgit clone https://github.com/Shougo/vimproc.vim.git ~/.vim/bundle/vimproc.vimpushd ~/.vim/bundle/vimproc.vimmakepopd# Install tsuquyomigit clone https://github.com/Quramy/tsuquyomi.git ~/.vim/bundle/tsuquyomi

If you useNeoBundle for Vim plugin management, append the following to your.vimrc:

NeoBundle'Shougo/vimproc.vim', {\'build' : {\'windows' :'tools\\update-dll-mingw',\'cygwin' :'make -f make_cygwin.mak',\'mac' :'make -f make_mac.mak',\'linux' :'make',\'unix' :'gmake',\   },\}NeoBundle'Quramy/tsuquyomi'

And exec:NeoBundleInstall.

(About vimproc installation, please seethe original install guide.)

Tsuquyomi supports Omni-Completion.

By the default, type<C-x> <C-o> in insert mode, Tsuquyomi shows completions.

You can configure completion with thecompleteopt option.

If you don't want the popup menu:

autocmdFileTypetypescriptsetlocalcompleteopt-=menu

If you want to show a method's signature in the popup menu, setg:tsuquyomi_completion_detail.Remarks: This option makes completion slow

letg:tsuquyomi_completion_detail=1

If you want to show a method's signature in the preview window when you complete this method's arguments (default):

(The preview window isn't shown when completion properties or variables)

autocmdFileTypetypescriptsetlocalcompleteopt+=menu,preview

Type<C-]> in normal mode or visual mode, Tsuquyomi navigates to the location where the symbol under the cursor is defined.

Alternatively, call the Ex command:TsuquyomiDefinition or:TsuDefinition.(All Tsuquyomi's commands have aliases with short prefix'Tsu'.)

And type<C-t> , Tsuquyomi moves the cursor to the location where the last<C-]> was typed.

:TsuTypeDefinition command is similar to:TsuDefinition.:TsuTypeDefinition navigates to the location where the type of the symbol under the cursor is defined.

Type<C-^> in normal mode or visual mode, Tsuquyomi shows a list of location where the symbol under the cursor is referenced.

Alternatively, call the Ex command:TsuReferences.

If you want where an interface is implemented, use:TsuImplementation.

Call the Ex command:TsuSearch {keyword} to get the list of locations which contain the keyword. This command searches the keyword from opened or referenced files in your project.

The search term minimum length can be configured withlet g:tsuquyomi_search_term_min_length = 3.

If you do not want to use the above key mappings please addlet g:tsuquyomi_disable_default_mappings = 1 to your.vimrc file.

When a buffer is saved, Tsuquyomi checks syntax and semantics. Alternatively call the Ex command:TsuGeterr.And if it contains errors, Tsuquyomi shows them to Vim quickfix window.

If your use TypeScript v1.6.0 or later, you can use:TsuGeterrProject command.This command shows all compilation errors contained in your project to quickfix window.

If the cursor is on an error and TypeScript's LanguageService has a code fix for this error, call:TsuQuickFix.The code fix will be applied.

Maketsconfig.json.

For example:

{"compilerOptions": {"noImplicitAny":true,"target":"es5","module":"commonjs"  }}

When you change tsconfig.json after opening*.ts files, you should exec:TsuquyomiReloadProject command.So, the changes of tsconfig.json are reflected in the TSServer.

If you usesyntastic, you can use syntastic for displaying syntax and semantics errors instead of vim's default quickfix window. To integrate syntastic, write the following setting to your .vimrc.

letg:tsuquyomi_disable_quickfix=1letg:syntastic_typescript_checkers= ['tsuquyomi']" You shouldn't use 'tsc' checker.

syntastic has default TypeScript checker whose name is 'tsc'. You shouldn't use it with running Tusuquyomi because they don't share compile options.Tusuquyomi's checker whose name is 'tsuquyomi' uses tsserver and your tsconfig.json.

Using the command:TsuRenameSymbol, you can rename the identifier under the cursor to a new name.

If you want to rename identifiers including in comments, you can use:TsuRenameSymbolC command.For example, this command is useful when you want renameopt in the following code:

/****@param opt***/varsomeFunc=(opt:any)=>{...};

This feature does not have the default key mapping.If you need, configure your.vimrc . For example:

autocmdFileTypetypescriptnmap<buffer><Leader>e<Plug>(TsuquyomiRenameSymbol)autocmdFileTypetypescriptnmap<buffer><Leader>E<Plug>(TsuquyomiRenameSymbolC)

Tsuquyomi can display tooltip window about symbol under the mouse cursor. If you want to use this feature, configure.vimrc as follows:

setballoonevalautocmdFileTypetypescriptsetlocalballoonexpr=tsuquyomi#balloonexpr()

Theballonexpr option is not available in terminal Vim. So, Tsuquyomi also provides a tooltip functiontsuquyomi#hint().

For example:

autocmdFileTypetypescriptnmap<buffer><Leader>t:<C-u>echo tsuquyomi#hint()<CR>

The above example works in terminal Vim.

Tsuquyomi provides someunite sources.

Execute the following command, your project information is displayed.

:Unite tsproject

The project information contains:

• tsconfig.json which the current buffer use.
• .ts(or .tsx) source files which TypeScript compiles. These files are determined by tsconfig.json

This feature requires TypeScript@1.6.0 or later.

This feature requires Vim plugins:

• unite-outline.

If you have installed these plugins, calling the following Ex command, the outline of the current buffer is displayed.

:Unite outline

By the default, Tsuquyomi searches locally installed TypeScript. If not hit, Tsuquyomi uses TypeScript installed globally.

And execute the following command, you can confirm the path of tsserver:

:echotsuquyomi#config#tsscmd()

It's highly experimental

For example, if your buffer is the following state:

readFile('hoge','utf-8',(err,content)=>{if(!err)console.log(content);});

Move cursor ontoreadFile and call:TsuImport, so Tsuquyomi appends the import declaration.

import{readFile}from'fs';readFile('hoge','utf-8',(err,content)=>{if(!err)console.log(content);});

To allow Tsuquyomi to import the shortest path instead of the complete one (where the initial module declaration is) one, put this in your .vimrc:

let g:tsuquyomi_shortest_import_path = 1

For example, if your project has the following 2 files, the plugin will use:import { foo } from './lib'; instead of:import { foo } from './lib/foo';.

/* lib/index.ts */export*from'./foo';

/* lib/foo.ts */exportconstfoo='FOO'

If you want more details, please seedoc.

Prepare test

cd test/yarn installcd ..

Run test cases

# Run all test cases with all supported TypeScript version./runtest-all-ts.sh# Run all test cases with the latest TypeScript version./runtest.sh# Run all test cases with the specified TypeScript versionVERSION=2.3 ./runtest.sh# Run a test file./run-one-test.sh test/path/to/test.spec.vim# Run a test file with the specified TypeScript versionVERSION=2.3 ./run-one-test.sh

MIT