Update developer docs, don't --watch by default (#330)

A bunch of stuff in the docs is out of date.
Also we no longer have any recommended workflows that use --watch.

Author: sam-mccall

.vscode/tasks.json

@@ -21,6 +21,5 @@
         "reveal": "silent",
     },
 
-    // Build bundle with sourcemaps, suitable for debugging.
-    "args": ["run", "esbuild", "--", "--sourcemap"],
+    "args": ["run", "compile"],
 }

DEVELOPING.md

@@ -7,47 +7,49 @@ A guide of developing `vscode-clangd` extension.
 * VS Code
 * node.js and npm
 
-## Steps
-
-1. Make sure you disable the installed `vscode-clangd` extension in VS Code.
-2. Make sure you have clangd in `/usr/bin/clangd` or edit `src/extension.ts` to
-point to the binary.
-3. To start a development instance of VS code extended with this, run:
+## Building and running (command line)
 
 ```bash
-   $ cd vscode-clangd
-   $ npm install
-   $ npm run compile # it runs in watch mode, so you can hit ctrl^c.
-   $ code . --extensionDevelopmentPath=$PWD
+cd vscode-clangd
+npm install
+npm run compile  # it runs in watch mode, you can hit ctrl-c.
+code --extensionDevelopmentPath=$PWD
 ```
 
-# Contributing
+## Building, running, and debugging (VSCode)
 
-Please follow the existing code style when contributing to the extension, we
-recommend to run `npm run format` before sending a patch.
+- ```bash
+  cd vscode-clangd
+  npm install
+  code .
+  ```
+- with the `vscode-clangd` directory open in VSCode, select
+  `Run => Run Without Debugging` or `Run => Start Debugging`
 
-# Publish to VS Code Marketplace
+VSCode will recompile the sources for you before launching.
+If you change dependencies in `package.json`, you should run `npm install`.
 
-New changes to `vscode-clangd` are not released until a new version is published
-to the marketplace.
+## Editing and typechecking
 
-## Requirements
+`npm run compile` does not actually typecheck the TypeScript code!
+(It stripts type annotations and bundles it, using `esbuild`).
+You can see diagnostics with `npm run check-ts`.
 
-* Make sure install the `vsce` command (`npm install -g vsce`)
-* `llvm-vs-code-extensions` account
-* Bump the version in `package.json`, and commit the change.
+Using a Typescript-aware editor will show you diagnostics, provide
+go-to-definition etc. VSCode works well, or any LSP-capable editor can use
+[typescript-language-server](https://github.com/typescript-language-server/typescript-language-server).
 
-The extension is published under `llvm-vs-code-extensions` account, which is
-maintained by clangd developers. If you want to make a new release, please
-contact [email protected].
+# Contributing
 
-## Steps
+Please follow the existing code style when contributing to the extension, we
+recommend to run `npm run format` before sending a patch.
 
-```bash
-  $ cd vscode-clangd
-  # For the first time, you need to login into the account. vsce will ask you
-    for the Personal Access Token and will remember it for future commands.
-  $ vsce login llvm-vs-code-extensions
-  # Publish the extension to the VSCode marketplace.
-  $ npm run publish
-```
+# Publish to Marketplace
+
+To create a new release, create a commit that:
+
+- increases the version number in `package.json`
+- updates `CHANGELOG.md` to cover changes since the last release
+
+Our CI will recognize the commit and publish new versions to the VSCode
+Marketplace and the alternative OpenVSX registry.

package.json

@@ -35,9 +35,9 @@
     "main": "./out/bundle",
     "scripts": {
         "esbuild": "esbuild ./src/extension.ts --bundle --outfile=out/bundle.js --external:vscode --format=cjs --platform=node",
-        "vscode:prepublish": "npm run esbuild -- --minify --keep-names",
-        "compile": "npm run esbuild -- --sourcemap --watch",
-        "ts-compile": "tsc -watch -p ./",
+        "vscode:prepublish": "npm run check-ts && npm run esbuild -- --minify --keep-names",
+        "compile": "npm run esbuild -- --sourcemap",
+        "check-ts": "tsc -noEmit -p ./",
         "format": "clang-format -i --glob=\"{src,test}/*.ts\"",
         "test": "tsc -p ./ && node ./out/test/index.js",
         "package": "vsce package --baseImagesUrl https://raw.githubusercontent.com/clangd/vscode-clangd/master/",