microsoft / microsoft/TypeScript-Sublime-Plugin
Unmaintained and buggy (especially with ST4) + an alternative
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.7k
- Forks
- 236
- Avg merge
- 21d 13h
- Merged PRs (30d)
- 1
Description
This package hasn't been properly maintained for a long time and doesn't look like Microsoft wants to put any resources on it apart from occasionally bumping the typescript dependencies and tweaking the syntax.
The current issues known to me (at least when using ST4) are:
- comes with a Typescript syntax while ST4 has now a built-in syntax that is of much higher quality and should be used instead
- has issue with completions being triggered at wrong times (like after semicolon) (https://github.com/microsoft/TypeScript-Sublime-Plugin/issues/776) (https://github.com/microsoft/TypeScript-Sublime-Plugin/issues/773)
- has issues with synchronizing document state resulting in the diagnostics getting out of sync sometimes and other issues (https://github.com/microsoft/TypeScript-Sublime-Plugin/issues/761)
- does not use utf-16 encoding (API available since ST4) when communicating with the server resulting also in synchronization issues
- overrides built-in keybindings which is a very bad practice (https://github.com/microsoft/TypeScript-Sublime-Plugin/issues/736)
- known performance issues (https://github.com/microsoft/TypeScript-Sublime-Plugin/issues/716) (https://github.com/microsoft/TypeScript-Sublime-Plugin/issues/654) (https://github.com/microsoft/TypeScript-Sublime-Plugin/issues/317)
- Doesn't take advantage of new features introduced in ST4 (improvements to completions handling, ability to do partial document updates) resulting in poor experience and lower performance
Due to providing generally a poor experience for the users, the ST community has decided to restrict availability of this package to ST3 (https://github.com/wbond/package_control_channel/pull/8479) as the quality of this very popular package can heavily influence how people see ST as an editor and think that it is just worse editor than the "competition".
Note that there exists a much better alternative to this package which is the generic https://packagecontrol.io/packages/LSP package in combination with the https://packagecontrol.io/packages/LSP-typescript helper package. It's actively maintained, supports all new functionality of ST4 and is performant so that is the recommended way to go forward.
Assuming that there is not gonna be any effort put into fixing those issues, it would be appreciated if the package also mentioned that it's deprecated for ST4 and maybe suggest the alternative.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no file, test, or entry point. Review the package’s user-facing documentation first, then document that it is deprecated for ST4 and point users to LSP with LSP-typescript as the recommended alternative. Done means the notice and migration path are clearly visible without changing the underlying integration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100