Skip to content

Commit

Permalink
add vscode settings and extension recommendations (microsoft#4574)
Browse files Browse the repository at this point in the history
* add vscode settings and extension recommendations

* wrap markdown files at 90 columns

* add details for using VS Code workspace settings to contributing guide

Co-authored-by: Ibrahim Maga <imaga75@hotmail.com>
radium-v and Ibrahimmaga authored Aug 6, 2021
1 parent a399c21 commit c74e26b
Showing 4 changed files with 62 additions and 6 deletions.
19 changes: 13 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -37,9 +37,19 @@ storybook-static
# Ignore Mac .DS_Store
.DS_Store

# Ignore VSCode in Root
/.vscode/
/.vs/
#Ignore VSCode in Root
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace

# Local History for Visual Studio Code
.history/

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# Ignore Intellij IDEA
.idea
@@ -59,9 +69,6 @@ sites/website/yarn.lock
sites/website/node_modules
sites/website/i18n/

# Docusaurus package readme's
docs/en/packages/*/README.md

# GitHub Actions Local Testing
.github/workflows/testing/*.json

10 changes: 10 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"recommendations": [
"bierner.github-markdown-preview",
"bierner.jsdoc-markdown-highlighting",
"dbaeumer.vscode-eslint",
"ghmcadams.lintlens",
"rvest.vs-code-prettier-eslint",
"sidneys1.gitconfig"
]
}
33 changes: 33 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"[json]": {
"files.insertFinalNewline": false
},
"[markdown]": {
"editor.quickSuggestions": false,
"editor.wordWrap": "wordWrapColumn",
"editor.wordWrapColumn": 90,
"files.insertFinalNewline": false,
"files.trimTrailingWhitespace": false
},
"[typescript]": {
"editor.tabSize": 4
},
"editor.trimAutoWhitespace": true,
"eslint.codeActionsOnSave.mode": "problems",
"eslint.lintTask.enable": true,
"eslint.packageManager": "yarn",
"eslint.validate": [
"typescript"
],
"files.eol": "\n",
"files.insertFinalNewline": true,
"files.trimFinalNewlines": true,
"files.trimTrailingWhitespace": true,
"javascript.format.enable": false,
"javascript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions": false,
"js/ts.implicitProjectConfig.experimentalDecorators": true,
"npm.packageManager": "yarn",
"typescript.enablePromptUseWorkspaceTsdk": true,
"typescript.format.enable": false,
"typescript.preferences.quoteStyle": "double"
}
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -126,6 +126,12 @@ Example of how to format `MIGRATION.md`:
- `Bat` has been updated to use the new API [`BatConfig`](link/to/api).
```

### Recommended Settings for Visual Studio Code

You can use any code editor you like when working with the FAST monorepo. One of our favorites is [Visual Studio Code](https://code.visualstudio.com/). VS Code has great autocomplete support for TypeScript and JavaScript APIs, as well as a rich ecosystem of plugins.

Default VS Code settings for this project are configured as [Workspace settings](https://code.visualstudio.com/docs/getstarted/settings) in the `.vscode` directory. These settings override user settings for the workspace and are configured to ensure consistent code formatting across different environments. We also include a list of [Workspace recommended extensions](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions) for VS Code for syntax highlighting and code linting.

## Contribution policy

A “Contribution” is work voluntarily submitted to a project. This submitted work can include code, documentation, design, answering questions, or submitting and triaging issues.

0 comments on commit c74e26b

Please sign in to comment.