[clangd-vscode] NFC; Improve wording in documentation and update VSCode tasks

[kbobyrev]

Summary

VSCode tasks are updated to the latest supported versions: deprecated
values are removed and replaced by their new counterparts.

[hokein]

thanks. regarding files in .vscode, I think they are just local configs in VSCode, we can probably remove the whole directory from git since we already ignore them in the llvm/.gitignore.

[kbobyrev]

In D76595#1936408, @hokein wrote:

thanks. regarding files in .vscode, I think they are just local configs in VSCode, we can probably remove the whole directory from git since we already ignore them in the llvm/.gitignore.

I think those are hand-written VSCode tasks and removing those would result in the absence of compiling and debugging actions in VSCode. llvm/.gitignore is intended to ignore the configs, but I'm not sure it is a "config file" in traditional sensee. Am I missing something?

[hokein]

In D76595#1938727, @kbobyrev wrote:

In D76595#1936408, @hokein wrote:

thanks. regarding files in .vscode, I think they are just local configs in VSCode, we can probably remove the whole directory from git since we already ignore them in the llvm/.gitignore.

I think those are hand-written VSCode tasks and removing those would result in the absence of compiling and debugging actions in VSCode. llvm/.gitignore is intended to ignore the configs, but I'm not sure it is a "config file" in traditional sensee. Am I missing something?

ah, I see. If removing these would cause troubles, then let's keep it (I thought these files are generated by VSCode as well).

clang-tools-extra/clangd/clients/clangd-vscode/.vscode/launch.json

-// A launch configuration that compiles the extension and then opens it inside a new window
+// A launch configuration that compiles extension and opens it inside a new window.
 {
     "version": "0.1.0",
     "configurations": [
         {
             "name": "Launch Extension",
             "type": "extensionHost",
             "request": "launch",
             "runtimeExecutable": "${execPath}",

clang-tools-extra/clangd/clients/clangd-vscode/.vscode/tasks.json

 // Available variables which can be used inside of strings.
 // ${workspaceRoot}: the root folder of the team
 // ${file}: the current opened file
 // ${fileBasename}: the current opened file's basename
 // ${fileDirname}: the current opened file's dirname
 // ${fileExtname}: the current opened file's extension
 // ${cwd}: the current working directory of the spawned process
 
-// A task runner that calls a custom npm script that compiles the extension.
+// Task runner calls custom npm script to compile the extension.
 {
-    "version": "0.1.0",
+    "version": "2.0.0",
 
-    // we want to run npm
+    // Run NPM.
     "command": "npm",
 
-    // the command is a shell script
-    "isShellCommand": true,
+    // This command is a shell script.
+    "type": "shell",
 
     // show the output window only if unrecognized errors occur.
-    "showOutput": "silent",
+    "presentation": {
+        "reveal": "silent",
+    },
 
-    // we run the custom script "compile" as defined in package.json
+    // Run custom "compile" script as defined in package.json
     "args": ["run", "compile", "--loglevel", "silent"],
 
-    // The tsc compiler is started in watching mode
-    "isWatching": true,
+    // tsc compiler is kept alive and runs in the background.
+    "isBackground": true,
 
-    // use the standard tsc in watch mode problem matcher to find compile problems in the output.
+    // Find compilation problems in the output through tsc in watch mode.
     "problemMatcher": "$tsc-watch"
-}
+}
 

clang-tools-extra/clangd/clients/clangd-vscode/DEVELOPING.md

 # Development
 
 A guide of developing `vscode-clangd` extension.
 
 ## Requirements
 
 * 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
+2. Make sure you have clangd in `/usr/bin/clangd` or edit `src/extension.ts` to
 point to the binary.
-3. In order to start a development instance of VS code extended with this, run:
+3. To start a development instance of VS code extended with this, run:
 
 ```bash
    $ cd /path/to/clang-tools-extra/clangd/clients/clangd-vscode/
    $ npm install
    $ code .
-   # When VS Code starts, press <F5>.
+   # When VSCode starts, press <F5>.
 ```
 
 # Contributing
 
-Please follow the exsiting code style when contributing to the extension, we
+Please follow the existing code style when contributing to the extension, we
 recommend to run `npm run format` before sending a patch.
 
 # Publish to VS Code Marketplace
 
 New changes to `clangd-vscode` are not released until a new version is published
 to the marketplace.
 
 ## Requirements
 
 * 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 to upstream
 
 The extension is published under `llvm-vs-code-extensions` account, which is
-currently maintained by clangd developers. If you want to make a new release,
-please contact [e-mail].
+maintained by clangd developers. If you want to make a new release, please
+contact [e-mail].
 
 ## Steps
 
 ```bash
   $ cd /path/to/clang-tools-extra/clangd/clients/clangd-vscode/
-  # For the first time, you need to login in the account. vsce will ask you for
-    the Personal Access Token, and remember it for future commands.
+  # 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
 ```

clang-tools-extra/clangd/clients/clangd-vscode/src/extension.ts

 import * as vscode from 'vscode';
 import * as vscodelc from 'vscode-languageclient';
 import * as semanticHighlighting from './semantic-highlighting';
 
 /**
- * Method to get workspace configuration option
+ * Get an option from workspace configuration.
  * @param option name of the option (e.g. for clangd.path should be path)
  * @param defaultValue default value to return if option is not set
  */
 function getConfig<T>(option: string, defaultValue?: any): T {
   const config = vscode.workspace.getConfiguration('clangd');
   return config.get<T>(option, defaultValue);
 }
 
class EnableEditsNearCursorFeature implements vscodelc.StaticFeature {
   fillClientCapabilities(capabilities: vscodelc.ClientCapabilities): void {
     const extendedCompletionCapabilities: any =
         capabilities.textDocument.completion;
     extendedCompletionCapabilities.editsNearCursor = true;
   }
 }
 
 /**
- *  this method is called when your extension is activate
- *  your extension is activated the very first time the command is executed
+ *  This method is called when the extension is activated. The extension is
+ *  activated the very first time a command is executed.
  */
 export function activate(context: vscode.ExtensionContext) {
   const syncFileEvents = getConfig<boolean>('syncFileEvents', true);
 
   const clangd: vscodelc.Executable = {
     command : getConfig<string>('path'),
     args : getConfig<string[]>('arguments')
   };
   const traceFile = getConfig<string>('trace');
   if (!!traceFile) {
     const trace = {CLANGD_TRACE : traceFile};
     clangd.options = {env : {...process.env, ...trace}};
   }
   const serverOptions: vscodelc.ServerOptions = clangd;
 
   const clientOptions: vscodelc.LanguageClientOptions = {
         // Register the server for c-family and cuda files.
         documentSelector: [
             { scheme: 'file', language: 'c' },
             { scheme: 'file', language: 'cpp' },
-            // cuda is not supported by vscode, but our extension does.
+            // CUDA is not supported by vscode, but our extension does supports it.
             { scheme: 'file', language: 'cuda' },
             { scheme: 'file', language: 'objective-c'},
             { scheme: 'file', language: 'objective-cpp'}
         ],
         synchronize: !syncFileEvents ? undefined : {
         // FIXME: send sync file events when clangd provides implementations.
         },
         initializationOptions: { clangdFileStatus: true },
-        // Do not switch to output window when clangd returns output
+        // Do not switch to output window when clangd returns output.
         revealOutputChannelOn: vscodelc.RevealOutputChannelOn.Never,
 
         // We hack up the completion items a bit to prevent VSCode from re-ranking them
         // and throwing away all our delicious signals like type information.
         //
         // VSCode sorts by (fuzzymatch(prefix, item.filterText), item.sortText)
         // By adding the prefix to the beginning of the filterText, we get a perfect
         // fuzzymatch score for every item.
         // The sortText (which reflects clangd ranking) breaks the tie.
         // This also prevents VSCode from filtering out any results due to the
         // differences in how fuzzy filtering is applies, e.g. enable dot-to-arrow
         // fixes in completion.
         //
         // We also have to mark the list as incomplete to force retrieving new rankings.
         // See https://github.com/microsoft/language-server-protocol/issues/898
         middleware: {
           provideCompletionItem: async (document, position, context, token, next) => {
             let list = await next(document, position, context, token);
             let items = (Array.isArray(list) ? list : list.items).map(item => {
-              // Gets the prefix used by vscode when doing fuzzymatch.
+              // Gets the prefix used by VSCode when doing fuzzymatch.
               let prefix = document.getText(new vscode.Range(item.range.start, position))
               if (prefix)
                 item.filterText = prefix + "_" + item.filterText;
               return item;
             })
             return new vscode.CompletionList(items, /*isIncomplete=*/true);
           }
         },

clang-tools-extra/clangd/clients/clangd-vscode/tsconfig.json

"compilerOptions": {
         "noImplicitAny": true,
         "noImplicitReturns": true,
         "noImplicitThis": true
     },
     "exclude": [
         "node_modules",
         ".vscode-test"
     ]
-}
+}