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

[Kirill Bobyrev via Phabricator via cfe-commits]

This revision was automatically updated to reflect the committed changes.
Closed by commit rGdb3d64eebbe0: [clangd-vscode] NFC; Improve wording in 
documentation and update VSCode tasks (authored by kbobyrev).

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D76595/new/

https://reviews.llvm.org/D76595

Files:
  clang-tools-extra/clangd/clients/clangd-vscode/.vscode/launch.json
  clang-tools-extra/clangd/clients/clangd-vscode/.vscode/tasks.json
  clang-tools-extra/clangd/clients/clangd-vscode/DEVELOPING.md
  clang-tools-extra/clangd/clients/clangd-vscode/src/extension.ts
  clang-tools-extra/clangd/clients/clangd-vscode/tsconfig.json

Index: clang-tools-extra/clangd/clients/clangd-vscode/tsconfig.json
===
--- clang-tools-extra/clangd/clients/clangd-vscode/tsconfig.json
+++ clang-tools-extra/clangd/clients/clangd-vscode/tsconfig.json
@@ -26,4 +26,4 @@
 "node_modules",
 ".vscode-test"
 ]
-}
\ No newline at end of file
+}
Index: clang-tools-extra/clangd/clients/clangd-vscode/src/extension.ts
===
--- clang-tools-extra/clangd/clients/clangd-vscode/src/extension.ts
+++ clang-tools-extra/clangd/clients/clangd-vscode/src/extension.ts
@@ -3,7 +3,7 @@
 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
  */
@@ -75,8 +75,8 @@
 }
 
 /**
- *  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('syncFileEvents', true);
@@ -97,7 +97,7 @@
 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'}
@@ -106,7 +106,7 @@
 // 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
@@ -126,7 +126,7 @@
   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;
Index: clang-tools-extra/clangd/clients/clangd-vscode/DEVELOPING.md
===
--- clang-tools-extra/clangd/clients/clangd-vscode/DEVELOPING.md
+++ clang-tools-extra/clangd/clients/clangd-vscode/DEVELOPING.md
@@ -10,20 +10,20 @@
 ## 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 .
+   # When VSCode starts, press .
 ```
 
 # 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
@@ -38,15 +38,15 @@
 * 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 

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

[Haojian Wu via Phabricator via cfe-commits]

hokein accepted this revision.
hokein added a comment.
This revision is now accepted and ready to land.

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).


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D76595/new/

https://reviews.llvm.org/D76595



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

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

[Kirill Bobyrev via Phabricator via cfe-commits]

kbobyrev added a comment.

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?


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D76595/new/

https://reviews.llvm.org/D76595



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

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

[Haojian Wu via Phabricator via cfe-commits]

hokein added a comment.

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`.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D76595/new/

https://reviews.llvm.org/D76595



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

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

[Kirill Bobyrev via Phabricator via cfe-commits]

kbobyrev created this revision.
kbobyrev added a reviewer: hokein.
Herald added subscribers: cfe-commits, usaxena95, kadircet, arphaman, jkorous, 
MaskRay, ilya-biryukov.
Herald added a project: clang.

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


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D76595

Files:
  clang-tools-extra/clangd/clients/clangd-vscode/.vscode/launch.json
  clang-tools-extra/clangd/clients/clangd-vscode/.vscode/tasks.json
  clang-tools-extra/clangd/clients/clangd-vscode/DEVELOPING.md
  clang-tools-extra/clangd/clients/clangd-vscode/src/extension.ts
  clang-tools-extra/clangd/clients/clangd-vscode/tsconfig.json

Index: clang-tools-extra/clangd/clients/clangd-vscode/tsconfig.json
===
--- clang-tools-extra/clangd/clients/clangd-vscode/tsconfig.json
+++ clang-tools-extra/clangd/clients/clangd-vscode/tsconfig.json
@@ -26,4 +26,4 @@
 "node_modules",
 ".vscode-test"
 ]
-}
\ No newline at end of file
+}
Index: clang-tools-extra/clangd/clients/clangd-vscode/src/extension.ts
===
--- clang-tools-extra/clangd/clients/clangd-vscode/src/extension.ts
+++ clang-tools-extra/clangd/clients/clangd-vscode/src/extension.ts
@@ -3,7 +3,7 @@
 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
  */
@@ -75,8 +75,8 @@
 }
 
 /**
- *  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('syncFileEvents', true);
@@ -97,7 +97,7 @@
 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'}
@@ -106,7 +106,7 @@
 // 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
@@ -126,7 +126,7 @@
   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;
Index: clang-tools-extra/clangd/clients/clangd-vscode/DEVELOPING.md
===
--- clang-tools-extra/clangd/clients/clangd-vscode/DEVELOPING.md
+++ clang-tools-extra/clangd/clients/clangd-vscode/DEVELOPING.md
@@ -10,20 +10,20 @@
 ## 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 .
+   # When VSCode starts, press .
 ```
 
 # 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
@@ -38,15 +38,15 @@
 * Bump the version in `package.json`, and commit the change to upstream
 
 The extension is published under