Skip to content

docs: remove incorrect configs from vscode readme #11043

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eng-abdelrahman-sharaf wants to merge 1 commit into
base: develop
Choose a base branch
from
+5 −11
Open

docs: remove incorrect configs from vscode readme #11043

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions docs/editors/vscode/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ limitations under the License.

-->

<!-- lint disable first-heading-level expected-html-sections -->

# Visual Studio Code

> A guide for using [Visual Studio Code][vscode] for project development.
Expand All @@ -28,7 +30,7 @@ limitations under the License.

Pre-built binaries are available for download on the Visual Studio Code [homepage][vscode].

To use [Visual Studio Code][vscode] as a command-line utility, users on MacOS have to run a command to add the [Visual Studio Code][vscode] executable to the `PATH` environment variable (see the official [documentation][vscode-macos-setup]).
To use [Visual Studio Code][vscode] as a command-line utility, users on MacOS have to run a command to add the [Visual Studio Code][vscode] executable to the `PATH` environment variable (see the official [documentation][vscode-macos-setup]).

To test the command-line utility,

Expand Down Expand Up @@ -69,15 +71,7 @@ $ code .

- [**Code Spell Checker**][vscode-spell-checker]: A simple source code spell checker. See the [official documentation][vscode-spell-checker-readme] for configuration options.

- [**ESLint**][vscode-eslint]: extension to integrate [eslint][eslint] into [Visual Studio Code][vscode]. Once installed, you need to configure the extension to use the project [ESLint][eslint] configuration files in your workspace settings.

```text
...
"eslint.options": {
"configFile": "etc/eslint/.eslintrc.js"
}
...
```
- [**ESLint**][vscode-eslint]: extension to integrate [eslint][eslint] into [Visual Studio Code][vscode].

- [**Path Intellisense**][vscode-path-intellisense]: extension that autocompletes filenames.

Expand Down Expand Up @@ -113,7 +107,7 @@ $ code .
{
"text": "TODO:",
"color": "darkred",
"backgroundColor": "rgba(0,0,0,.2)",
"backgroundColor": "rgba(0,0,0,.2)",
"isWholeLine": true
},
{
Expand Down
Loading