Clean up the docs and revert -beta naming

Author: guncha

CONTRIBUTING.md

@@ -57,14 +57,6 @@ Some shortcuts:
 * `ctrl+alt+i` will open the dev tools. These are the same Chrome dev tools you are familiar with. Feel free to inspect elements. This will come handy when doing UI or even seeing why a particular code element is highlighted in some way.
 * `ctrl+alt+r` will reload the entire atom instance.
 
-### Debugging
-There are *lots of ways* to do this. The ones we use right now:
-
-* You can do `console.error` from `projectService` and it will get logged to the atom's console (`ctrl+alt+i`). That's the quickest.
-* You can call `projectService` in `sync` from the UI thread if you want to debug using atom's built in tools (`ctrl+alt+i`). Set `debugSync` to true in `./lib/worker/debug.ts`, and it takes care of the rest.
-
-Also [if there is an error in `projectService` it gets logged to the console as a rejected promise](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/debugPromises.gif).
-
 ### General Steps
 1. We open `atom-typescript` in one atom window
 1. We have [`atom-typescript-examples`](https://github.com/TypeStrong/atom-typescript-examples) open in another atom window
@@ -75,24 +67,10 @@ Also [if there is an error in `projectService` it gets logged to the console as
 #### When you break atom-typescript during development
 This shouldn't happen as long as you leave the `atom-typescript` window untouched and do testing in another atom instance. If you reload the `atom-typescript` window thinking its going to be stable but it turns out to be unstable do one of the following:  
 * Discard the *JavaScript* changes that you think broke it and reload the atom instance.
-* Run `grunt` and leave it running to compile your atomts changes (as atomts is going to be out of order)
-* Open up the visual studio project (at your own risk, we do not keep this up to date!)
-
-## Architecture
-We wrap the `languageService` + our custom `languageServiceHost` + [`projectFile`](https://github.com/TypeStrong/atom-typescript/blob/master/docs/tsconfig.md) into a `Project` (code in `Project.ts` in the `lang` folder). The functions that interact with this `project` are exposed from `projectService` ([the query / response section](https://github.com/TypeStrong/atom-typescript/blob/6fbf860eaf971baa3aca939626db553898cb40db/lib/main/lang/projectService.ts#L58-L244)). `projectService` is where you would add new features that interact with the language service. All this code is `sync` and can be tested / run on any node instance. Be careful not to *leave* `console.log` in this code (as we use `stdio` to make this code `async`) or use `atom` specific APIs (as it may not be in the UI thread).
-
-We make this code `async`(and promise based) by:
-* **Single line:** (e.g. `export var echo = childQuery(projectService.echo);`) for every new call to get good compile time safety ([see the code in `parent.ts`](https://github.com/TypeStrong/atom-typescript/blob/b0a862cf209d18982875d5c38e3a655594316e9a/lib/worker/parent.ts#L148-L158)).
-
-### Additional Notes:
-* `childQuery` takes the signature of the `sync` function from `projectService` of the form `Query->Response` and automatically creates an `async` function of the form `Query->Promise<Response>`. The function body from `projectService` is not used, just the function *name* and the *type information* is.
-* We automatically add all functions exported from `projectService` in the list of functions that the child uses to respond to by name. ([see code in `child.ts`](https://github.com/TypeStrong/atom-typescript/blob/b0a862cf209d18982875d5c38e3a655594316e9a/lib/worker/child.ts#L48-L51)). Here we are not concerned with the *type information*. Instead we will actively *call the function* added to responders by *name*.
-* We spawn a separate `atom` (or `node` on windows) instance and use `ipc` ([see code in `parent.ts`](https://github.com/TypeStrong/atom-typescript/blob/b0a862cf209d18982875d5c38e3a655594316e9a/lib/worker/parent.ts#L4-L141)). Also [reason for not using WebWorkers](https://github.com/atom/atom-shell/issues/797).
-
-Advantage: you only need to define the query/response interface once (in `projectService.ts`) and write it in a testable `sync` manner. The parent code is never out of sync from the function definition (thanks to `childQuery`). Adding new functions is done is a typesafe way as you would write any other sync function + additionally using only one additional line of code in `parent.ts` (`childQuery`).
 
 ## Language Service Documentation
 The TypeScript Language service docs: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API
+The `tsserver` protocol definitions https://github.com/Microsoft/TypeScript/blob/master/lib/protocol.d.ts
 
 ## Showing errors in atom
 Done using the `linter` plugin. If you think about it. TypeScript is really just a super powerful version of `jshint` and that is the reason to use `linter` for errors.
@@ -101,17 +79,3 @@ Just look at `linter.ts` in our code.
 ## Grammar
 
 Please see https://github.com/TypeStrong/atom-typescript/tree/master/docs/grammar.md
-
-
-## QuickFix
-The quickest way is to copy an existing one located in the [quick fix directory](https://github.com/TypeStrong/atom-typescript/tree/a91f7e0c935ed2bdc2c642350af50a7a5aed70ad/lib/main/lang/fixmyts/quickFixes). Copy one of these files into a new quick fix.
-
-Quick fixes need to implement the `QuickFix` interface ([code here](https://github.com/TypeStrong/atom-typescript/blob/a91f7e0c935ed2bdc2c642350af50a7a5aed70ad/lib/main/lang/fixmyts/quickFix.ts#L46-L53)).
-
-Once you have the quickfix created just put it into the [quickfix registry](https://github.com/TypeStrong/atom-typescript/blob/a91f7e0c935ed2bdc2c642350af50a7a5aed70ad/lib/main/lang/fixmyts/quickFixRegistry.ts#L14-L24) so that the infrastructure picks it up.
-
-**Additional Tips** : One indespensible tool when creating a quick fix is the [AST viewer](https://github.com/TypeStrong/atom-typescript#ast-visualizer) which allows you to investigate the TypeScript language service view of the file.
-
-# Video
-
-A video on some of the internals : https://www.youtube.com/watch?v=WOuNb2MGR4o

README.md

@@ -1,13 +1,11 @@
-# Beta
-
-This is a fork of the `atom-typescript` package with a very different implementation and, necessarily, different user experience. More info here: https://github.com/TypeStrong/atom-typescript/pull/1166
-
 # Atom TypeScript
 
 [![Join the chat at https://gitter.im/TypeStrong/atom-typescript](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/TypeStrong/atom-typescript?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 JavaScript developers can now just open a `.ts` file and start hacking away like they are used to. No `grunt` no `Visual Studio`. Just pure coding.
 
+**NOTE**: This branch contains a major rewrite (**v11**) of the `atom-typescript` plugin that is lighter and faster, but lacks a few major features that you might miss. The previous version is still available in the `legacy` branch and will containue to receive minor bugfixes, but I wouldn't count on any new developments.
+
 ## Installation
 
 1. Install [atom](https://atom.io).
@@ -34,25 +32,11 @@ JavaScript developers can now just open a `.ts` file and start hacking away like
 * Project Context Support (`tsconfig.json`)
 * Project Build Support
 * `package.json` Support
-* Format code (configurable to be on save)
 * Goto Declaration
 * Find References
 * Block comment and uncomment
-* Goto history (goto next/previous error in open files, goto next/previous build)
-* Auto indent for new lines
-* TypeScript context menu
-* Symbols in Project
-* Symbols in File
-* Semantic View
 * Rename refactoring
-* Quick Fix
-* Toggle Breakpoint
 * Common Snippets
-* `import` / `/// <reference` relative path resolution
-* Output Toggle
-* AST visualizer
-* Dependency View
-* Sync
 
 # FAQ
 Located online : https://github.com/TypeStrong/atom-typescript/blob/master/docs/faq.md
@@ -63,148 +47,34 @@ Located online : https://github.com/TypeStrong/atom-typescript/blob/master/docs/
 ## Auto Complete
 Internally using AutoComplete+. Just start typing and hints will show up. Or you can explicitly trigger it using `ctrl+space` or `cmd+space`. Press `tab` to make a selection.
 
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/fastErrorCheckingAndAutoComplete2.gif)
-
-
 ## Type information on hover
 Just hover
 
 ![you definitely get the point](https://raw.githubusercontent.com/TypeStrong/atom-typescript/master/docs/screens/hover.png)
 
 ## Compile on save
-TypeScript files will be compiled on save automatically. Different notifications are given if `emit` was successful or not. If you need to disable this feature, add `"compileOnSave": false` in your [`tsconfig.json`](https://github.com/TypeStrong/atom-typescript/blob/master/docs/tsconfig.md#compileonsave).
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript/master/docs/screens/compile%20success.png)
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript/master/docs/screens/compile%20error.png)
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript/master/docs/screens/emit%20error.png)
+When `"compileOnSave": true` is set in `tsconfig.json`, Typescript files will be compiled and saved automatically. The compiler does its best to emit something, even if there are semantic errors in the file.
 
 ## Project Support
-Supported via [`tsconfig.json`](https://github.com/TypeStrong/atom-typescript/blob/master/docs/tsconfig.md) which is going to be the defacto Project file format for the next versions of TypeScript.
-
-It also supports `filesGlob` which will expand `files` for you based on `minmatch|glob|regex` (similar to grunt).
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript/master/docs/screens/proj.png)
-
-### Project Build Support
-Shortcut: `F6`. If there are any errors they are shown as well.
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript/master/docs/screens/build%20success.png)
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript/master/docs/screens/build%20errors.png)
-
-## NPM Module Support
-We have a sample NPM module : https://github.com/basarat/ts-npm-module  (trick : in tsconfig have `"declaration" : true` an in package.json have a `typings` field pointing to the `main` file) and its usage is demoed in https://github.com/basarat/ts-npm-module-consume.
-
-### Configuration tips
-
-Covered here : http://basarat.gitbooks.io/typescript/content/docs/jsx/tsx.html
-
-### Html to TSX
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/htmltotsx.gif)
+`atom-typescript` supports all the same options the Typescript compiler does as it's using it behind the scenes to do all of the heavy lifting. In fact, `atom-typescript` will use the exact version of Typescript you have installed in your `node_modules` directory.
 
 ## Format Code
 Shortcut : `ctrl+alt+l` or `cmd+alt+l`. Will format just the selection if you have something selected otherwise it will format the entire file.
 
-Format on save is covered [here](https://github.com/TypeStrong/atom-typescript/blob/master/docs/tsconfig.md#formatOnSave)
-
 ## Go to Declaration
 Shortcut : `F12`. Will open the *first* declaration of the said item for now. (Note: some people call it Go to Definition)
 
 ## Find References
 Shortcut `shift+F12`. Also called *find usages*.
 
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/findReferences.png)
-
-## Block Comment and Uncomment
-`ctrl+/` or `cmd+/`. Does a block comment / uncomment of code.
-
-## Go to Next / Go to Previous
-`f8` and `shift+f8` respectively. This will go to next/previous *errors in open files* OR *build error* OR *references* based on which tab you have selected.
-
-## Context menu
-Quickly toggle the TypeScript panel OR select active TypeScript panel tab and other stuff using the context menu. `ctrl+;` or `cmd+;`.
-
-## Symbols View
-Integrates with atom's symbols view (`ctrl+r` or `cmd+r`) to provide you with a list of searchable symbols in the current file.
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/symbolsView.gif)
-
-## Semantic View
-A bird's eye view of the current file. Use command `toggle semantic view`. The view updates while you edit the code. You can also click to jump to any portion of the file.
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/semanticView.png)
-
-## Project Symbols View
-Also called Go To Type in other IDEs. Integrates with atom's project level symbols (`ctrl+shift+r` or `cmd+shift+r`) to provide you with a list of searchable symbols in the *entire typescript project*.
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/projectSymbolView.png)
-
 ## Refactoring
 
 ### Rename
 `f2` to initiate rename. `enter` to commit and `esc` to cancel.
 ![](https://raw.githubusercontent.com/TypeStrong/atom-typescript/master/docs/screens/renameRefactoring.png)
 
 ## Quick Fix
-Press the `TypeScript: Quick Fix` shortcut `alt+enter` at an error location to trigger quick fixes. Select the quick fix you want and press `enter` to commit e.g
-
-### Add class members
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/addClassMember.gif)
-
-### More Quick fixes
-We are actively adding quick fixes so [**go here for an up to date list**](https://github.com/TypeStrong/atom-typescript/blob/master/docs/quickfix.md).
-
-## Toggle Breakpoint
-Use command `TypeScript: Toggle Breakpoint` shortcut `f9`:
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/toggleBreakpoint.gif)
-
-## tsconfig validation
-We will validate it and help you to fix it :)
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/errorcases/invalidProjectOptions/invalidProjectOptions.gif)
-
-## Snippets
-### Relative Paths
-Relative paths have traditionally been a pain, not anymore. Use `import` or `ref` and press `tab` to trigger snippet.
-
-`ref`
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/ref%20snippet.gif)
-
-`import`
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/import%20snippet.gif)
-
-Note that within the path string you get autocomplete (`ctrl+space`/`cmd+space`) for all the files in the project by filename (works for both `ref` and `import`).
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/pathChange.gif)
-
-## Output Toggle
-`ctrl+shift+m` to toggle the output co**m**piled JS file for a give TypeScript file. The keyboard shortcut is consistent with atom's markdown preview.
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/outputToggle.gif)
-
-## AST Visualizer
-Command : `Typescript: Ast`. Useful when authoring new features.
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/astVisualizer.gif)
-
-Also command : `TypeScript: Ast Full` that includes the `trivia` (punctuation, comments etc. received from `ts.Node.getChildren()`) as well.
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/astFull.png)
-
-## Dependency View
-Command : `Typescript: Dependency View`. A dependency viewer for insight into the project if you use external modules. You can zoom, pan, drag points around and hover over nodes. ([more details](https://github.com/TypeStrong/atom-typescript/blob/master/docs/dependency-view.md))
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/dependencyView/teaser.png)
-
-## Sync
-We try to keep as much of the stuff in sync while you edit code. However *in dire circumstances*:
-
-* a soft sync is done when you save a file `ctrl+s` and we will completely reprocess the *active* file. This might not fix stuff if the error is because of *some other file on the file system*.
-* `ctrl+'` or `cmd+'` : If you deleted files in the background or renamed them or jumped git branches or *something weird just happened* then sync. No need to restart your IDE :).
-
-![](https://raw.githubusercontent.com/TypeStrong/atom-typescript-examples/master/screens/sync.gif)
+Current iteration of the plugin doesn't support any Quickfixes, but they're coming in the future.
 
 ## Contributing
 

dist/main/atomts.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const Atom = require("atom");
 const atomConfig = require("./atom/atomConfig");
-const hyperclickProvider = require("../hyperclickProvider");
 const tsconfig = require("tsconfig/dist/tsconfig");
 const renameView_1 = require("./atom/views/renameView");
 const autoCompleteProvider_1 = require("./atom/autoCompleteProvider");
@@ -26,7 +25,7 @@ const commands_1 = require("./atom/commands");
 let linter;
 let statusBar;
 function activate(state) {
-    require('atom-package-deps').install('atom-typescript-beta', true).then(() => {
+    require('atom-package-deps').install('atom-typescript', true).then(() => {
         let statusPriority = 100;
         for (const panel of statusBar.getRightTiles()) {
             if (panel.getItem().tagName === "GRAMMAR-SELECTOR-STATUS") {
@@ -141,10 +140,6 @@ function provide() {
     ];
 }
 exports.provide = provide;
-function getHyperclickProvider() {
-    return hyperclickProvider;
-}
-exports.getHyperclickProvider = getHyperclickProvider;
 function loadProjectConfig(sourcePath) {
     return exports.clientResolver.get(sourcePath).then(client => {
         return client.executeProjectInfo({ needFileNameList: false, file: sourcePath }).then(result => {

docs/CHANGELOG.md

@@ -5,6 +5,9 @@ We only plan to *strictly* document the breaking changes. The rest is optional.
 # Planned
 (No breaking changes staged)
 
+# v11.0.0
+* Major rewrite using `tsserver` API for the best compatibility with the current versions of Typescript.
+
 # v7.0.0
 * Removed the (already ignored in any significant way) `version` option from tsconfig. [More](https://github.com/TypeStrong/atom-typescript/issues/617)
 
@@ -32,4 +35,3 @@ We only plan to *strictly* document the breaking changes. The rest is optional.
 
 # 0.x
 * Initial releases
-