Skip to content

Commit 5db5d9f

Browse files
committed
Format file for consistency
1 parent bbff773 commit 5db5d9f

File tree

1 file changed

+21
-28
lines changed

1 file changed

+21
-28
lines changed

VisualStudioCode/README.md

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -19,49 +19,42 @@ After that, you can launch VS Code from your terminal:
1919
* `code .` will open VS Code in the current directory
2020
* `code myfile.txt` will open `myfile.txt` in VS Code
2121

22-
### Python Extension
22+
## Useful Extensions
2323

24-
Install this extension for Python code highlighting
25-
https://marketplace.visualstudio.com/items?itemName=ms-python.python
24+
### Python
2625

27-
Configure the two things below, in order to enable auto-formatting on "Save", i.e. `⌘ + S`
26+
* [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - Python code highlighting
2827

29-
1. Change the default formatter to "`Black`" instead of "`Autopep8`". Very critical to avoid large diffs. Go to "Preferences" -> User Settings and update the setting "`python.formatter.provider`" to "Black" https://code.visualstudio.com/docs/python/editing
28+
To enable auto-formatting on "Save", i.e. `⌘ + S`, configure the following:
3029

31-
2. Enable `Format on Save` Setting: "Editor: Format On Save" setting on Code -> Preferences -> Settings
30+
1. Change the default formatter to `Black` instead of `Autopep8`. Critical to avoid large diffs. Go to _Preferences_ -> _User Settings_ and update the setting `python.formatter.provider` to `Black`
3231

33-
3. To test, Open a Python file and check if you write code that it automatically formats on saving the file.
32+
2. Enable `Format on Save` Setting: _Editor: Format On Save_ setting on _Code_ -> _Preferences_ -> _Settings_
3433

35-
### Markdown rendering extension
34+
### JavaScript
3635

37-
This extension allows you to see Markdown files easily in Visual Studio itself so that we can read documentation directly from VS Code
38-
https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced
36+
* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
37+
) - Useful to check JavaScript errors and helps in auto-formatting the code
38+
* [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
39+
) - JavaScript code formatter
3940

40-
### JavaScript extensions
41+
### SQL
4142

42-
ESLint - Useful to check JavaScript errors and helps in auto-formatting the code
43-
https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
43+
* [PostgreSQL formatter](https://marketplace.visualstudio.com/items?itemName=bradymholt.pgformatter)
4444

45-
Prettier - JavaScript code formatter
46-
https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
45+
### Markdown
4746

48-
### SQL Extensions
49-
50-
Format all SQL files with this formatter
51-
https://marketplace.visualstudio.com/items?itemName=bradymholt.pgformatter
52-
53-
## Optional extentions to consider
47+
* [Markdown Preview](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced) - Read Markdown files in VSCode
5448

5549
### GitLens
5650

57-
Used to visually represent the Git commit history and enables quick git actions in addition to those already provided by VS Code
58-
https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
51+
* [GitLens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
52+
) - Supercharge the Git capabilities built into VSCode
5953

60-
### Docker: to control Docker images right from VS Code
54+
### Docker
6155

62-
Instructions can be found here: https://code.visualstudio.com/docs/containers/overview, Extension: https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker
56+
* [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) - Create, manage, and debug images from within VSCode
6357

64-
### Paste JSON as Code
58+
### JSON
6559

66-
Infers types from sample JSON data, then outputs strongly typed models and serializers for working with that data in your desired programming language. To use this extension, just copy some JSON and use "Edit/Paste JSON as Code".
67-
https://marketplace.visualstudio.com/items?itemName=quicktype.quicktype
60+
* [Paste JSON as Code](https://marketplace.visualstudio.com/items?itemName=quicktype.quicktype) - Infers types from sample JSON data, then outputs strongly typed models and serializers for working with that data in your desired programming language

0 commit comments

Comments
 (0)