@@ -15,12 +15,15 @@ look something like:
1515
1616```
1717cd ~/"Library/Application Support/Sublime Text 3/Packages"
18- git clone https://github.com/Microsoft/TypeScript-Sublime-Plugin.git
18+ git clone https://github.com/Microsoft/TypeScript-Sublime-Plugin.git TypeScript
1919```
2020
2121Platform support
2222----------------
23- The plugin has identical behavior across Windows, Mac, and Linux platforms.
23+ The plugin has identical behavior across Windows, Mac, and Linux
24+ platforms. On Windows with ST2, you may see a "plugin delay" message
25+ upon startup. This happens because ST2 does not call "plugin_loaded()",
26+ so the TypeScript server process is started from within an event handler.
2427Where possible, the use of a [ Sublime Text 3] ( http://www.sublimetext.com/3 )
2528build >= 3070 is recommended, as this provides a popup API used for tool tips.
2629
@@ -39,7 +42,6 @@ Command Pallete:
3942| Format selection | ^T ^F |
4043| Format line | ^ ; |
4144| Format braces | ^ Shift + ] |
42- | Save tmp | ^T ^S |
4345| Go to definition | ^T ^D (or F12)|
4446| Paste and format | (^ or Super) V|
4547| Quick info | ^T ^Q |
@@ -51,7 +53,7 @@ file of this name is detected in a parent directory, then its settings will be
5153used by the plugin.
5254
5355Issues
54- ------
56+ -------
5557The plugin is currently an Alpha, and as such there are many enhancements to
5658implement, and many bugs to be fixed. These are being tracked via the
5759[ GitHub Issues] ( https://github.com/Microsoft/TypeScript-Sublime-Plugin/issues )
@@ -61,3 +63,39 @@ Please do log issues for any bugs you find or enhancements you would like to see
6163(after searching to see if such as issue already exists). We are excited to
6264get your feedback and work with the community to make this plugin as awesome as
6365possible.
66+
67+ Tips
68+ ----
69+ 1 . Sublime Text 3 does not inform plug-ins of all buffer changes. We
70+ are still learning how to detect changes in all cases. If the view
71+ contents is out-of-sync with the server, you can re-sync by running
72+ the Undo command once. The usual way to notice out-of-sync content
73+ is to see a surprising error message.
74+ 2 . Snippets may contain text fields, which are placeholders within the
75+ snippet. The presence of text fields changes the key binding
76+ context and may temporarily turn off some of the TypeScript key
77+ bindings. You can exit all snippet text fields by hitting the
78+ escape key. You can tab from one text field to the next until you
79+ have exhausted the text fields (possibly filling them in along the way).
80+ 3 . The server does not yet have file watch support for tsconfig.json
81+ projects. This means that if your tsconfig.json file does not have
82+ a "files" property, and you add a new file to a directory
83+ configured by that tsconfig.json file, you will need to restart
84+ Sublime to get that file noticed. The same applies to changes in
85+ the options properties of the tsconfig.json file.
86+ 4 . Sublime Text 2 will be slow for files of about 2K lines or more.
87+ This happens because Sublime Text 2 does not reliably inform
88+ plug-ins of buffer changes and therefore the plug-in has to
89+ frequently send the entire view contents to the server.
90+ 5 . By default, the plug-in retains the Sublime native behavior for
91+ auto indent (such as when typing the Enter key). To have the
92+ TypeScript server supply auto indent, set the
93+ 'typescript\_ auto\_ format' setting to true in your
94+ Preferences.sublime-settings file.
95+ 6 . On Mac, the plug-in looks for the installed node executable on the
96+ default system path + in the directory '/usr/local/bin'. If your
97+ node installation placed the node executable elsewhere, then add
98+ the 'node_path' setting to your Preferences.sublime-settings file.
99+ The value of the 'node_path' setting should be the pathname of the
100+ node executable as in '/usr/myinstalldir/node'.
101+
0 commit comments