Skip to content

Commit 7709dd3

Browse files
committed
Merge pull request #464 from Microsoft/Fix#463
Fix #463: Update readme.md to include documentation about typescript_tsdk
2 parents 613d34e + 6ecfd5f commit 7709dd3

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ And on Windows:
2424
cd "%APPDATA%\Sublime Text 3\Packages"
2525
git clone --depth 1 https://github.com/Microsoft/TypeScript-Sublime-Plugin.git TypeScript
2626
```
27-
(`--depth 1` downloads only the current version to reduce the clone size.)
27+
(`--depth 1` downloads only the current version to reduce the clone size.)
2828
Note if you are using the portable version of Sublime Text, the location will be different. (See http://docs.sublimetext.info/en/latest/basic_concepts.html#the-data-directory for more info).
2929

3030
**IMPORTANT** If you already have a package called `TypeScript` installed, either remove this first, or clone this repo to a different folder, else module name resolution can break the plugin.
@@ -38,7 +38,7 @@ The plugin has identical behavior across Windows, Mac, and Linux;
3838
The plugin supports both ST2 and ST3. However, some features are only available in ST3:
3939
+ Tool tips
4040
+ Error list
41-
41+
4242
On Windows with ST2, you may see a "plugin delay" message upon startup. This happens because ST2 does not call "plugin_loaded()", so the TypeScript server process is started from within an event handler.
4343

4444
Where possible, the use of a [Sublime Text 3](http://www.sublimetext.com/3) build >= 3070 is recommended, as this provides a popup API used for tool tips.
@@ -69,12 +69,12 @@ The below features are available via the keyboard shortcuts shown, or via the Co
6969
|Error list | (via Command Palette) |
7070

7171
The "format on key" feature is on by default, which formats the current line after typing `;`, `}` or `enter`.
72-
To disable it, go to `Preferences` -> `Package Settings` -> `TypeScript` -> `Plugin Settings - User`, and add
72+
To disable it, go to `Preferences` -> `Package Settings` -> `TypeScript` -> `Plugin Settings - User`, and add
7373
`"typescript_auto_format": false` to the json file.
7474

75-
For further information about the keyboard shortcuts, please refer to the [`Default.sublime-keymap`](https://github.com/Microsoft/TypeScript-Sublime-Plugin/blob/master/Default.sublime-keymap) file for common shortcuts and
76-
[`Default (OSX).sublime-keymap`](https://github.com/Microsoft/TypeScript-Sublime-Plugin/blob/master/Default%20(OSX).sublime-keymap),
77-
[`Default (Windows).sublime-keymap`](https://github.com/Microsoft/TypeScript-Sublime-Plugin/blob/master/Default%20(Windows).sublime-keymap),
75+
For further information about the keyboard shortcuts, please refer to the [`Default.sublime-keymap`](https://github.com/Microsoft/TypeScript-Sublime-Plugin/blob/master/Default.sublime-keymap) file for common shortcuts and
76+
[`Default (OSX).sublime-keymap`](https://github.com/Microsoft/TypeScript-Sublime-Plugin/blob/master/Default%20(OSX).sublime-keymap),
77+
[`Default (Windows).sublime-keymap`](https://github.com/Microsoft/TypeScript-Sublime-Plugin/blob/master/Default%20(Windows).sublime-keymap),
7878
[`Default (Linux).sublime-keymap`](https://github.com/Microsoft/TypeScript-Sublime-Plugin/blob/master/Default%20(Linux).sublime-keymap)
7979
for OS-specific shortcuts.
8080

@@ -97,7 +97,7 @@ Screenshots
9797
![](https://raw.githubusercontent.com/Microsoft/TypeScript-Sublime-Plugin/master/screenshots/errorlist.gif)
9898

9999
- Signature popup (Requires [Sublime Text 3](http://www.sublimetext.com/3) build >= 3070)
100-
100+
101101
![](https://raw.githubusercontent.com/Microsoft/TypeScript-Sublime-Plugin/master/screenshots/signature.gif)
102102

103103
- Navigate to symbol
@@ -134,9 +134,18 @@ Issues are being tracked via the [GitHub Issues](https://github.com/Microsoft/Ty
134134

135135
Note about `.tmLanguage` related issues
136136
--------------
137-
As the TypeScript and TypeScriptReact `.tmLanguage` definition files are shared across multiple editors including Sublime Text, Atom-TypeScript, and Visual Studio Code, we decided to create a dedicated repo for these files to combine the efforts for improvement.
137+
As the TypeScript and TypeScriptReact `.tmLanguage` definition files are shared across multiple editors including Sublime Text, Atom-TypeScript, and Visual Studio Code, we decided to create a dedicated repo for these files to combine the efforts for improvement.
138138
The new repo is at https://github.com/Microsoft/TypeScript-TmLanguage, and all future tmLanguage-related issues will be tracked there and ported back to this repo.
139139

140+
Using nightly TypeScript builds
141+
--------------
142+
The plugin can be configured to load a different TypeScript version other than the one bundled along.
143+
To do that, update the `Settings - User` file with the following:
144+
145+
```JSON
146+
"typescript_tsdk": "<path to your folder>/node_modules/typescript/lib"
147+
```
148+
140149
Tips and Known Issues
141150
----
142151
See tips and known issues in the [wiki page](https://github.com/Microsoft/TypeScript-Sublime-Plugin/wiki/Tips-and-Known-Issues).

0 commit comments

Comments
 (0)