Skip to content

Commit

Permalink
Add to .vscode/settings.json: format-on-save; jsonc and markdown form…
Browse files Browse the repository at this point in the history
…atter
  • Loading branch information
imnasnainaec committed Nov 13, 2020
1 parent fd6c81a commit 60f584c
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
8 changes: 8 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"editor.formatOnSave": true,
"editor.formatOnSaveMode": "file",
"[csharp]": {
"editor.defaultFormatter": "ms-dotnettools.csharp"
},
Expand All @@ -11,6 +13,12 @@
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[jsonc]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[markdown]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
Expand Down
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,9 @@ A rapid word collection tool.
- [MongoDB](https://docs.mongodb.com/manual/administration/install-community/) and add
/bin to PATH Environment Variable
- On Windows, if using [Chocolatey][chocolatey]: `choco install mongodb`
- [VS Code](https://code.visualstudio.com/download) and Prettier code
formatting extension
- [VS Code](https://code.visualstudio.com/download) and the following extensions:
- C# (`ms-dotnettools.csharp`)
- Prettier - Code formatter (`esbenp.prettier-vscode`)
- [dotnet-format](https://github.com/dotnet/format):
`dotnet tool update --global dotnet-format --version 4.1.131201`
- [dotnet-reportgenerator](https://github.com/danielpalme/ReportGenerator)
Expand All @@ -85,13 +86,10 @@ A rapid word collection tool.
- `COMBINE_SMTP_ADDRESS`
- `COMBINE_SMTP_FROM`

6. (VS Code Users Only) Enable automatic formatting on save.
- **File** | **Preferences** | **Settings** | Search for **formatOnSave** and
check the box.
7. Run `npm start` from the project directory to install dependencies and start
6. Run `npm start` from the project directory to install dependencies and start
the project.

8. Consult our [C#](docs/c_sharp_style_guide.md)
7. Consult our [C#](docs/c_sharp_style_guide.md)
and [JavaScript/TypeScript](docs/ts_style_guide.md)
style guides for best coding practices in this project.

Expand Down

0 comments on commit 60f584c

Please sign in to comment.