From c74e26b57f105687df4fd2c47729d111d494b9b8 Mon Sep 17 00:00:00 2001 From: John Kreitlow <863023+radium-v@users.noreply.github.com> Date: Fri, 6 Aug 2021 15:01:03 -0700 Subject: [PATCH] add vscode settings and extension recommendations (#4574) * 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 --- .gitignore | 19 +++++++++++++------ .vscode/extensions.json | 10 ++++++++++ .vscode/settings.json | 33 +++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 6 ++++++ 4 files changed, 62 insertions(+), 6 deletions(-) create mode 100644 .vscode/extensions.json create mode 100644 .vscode/settings.json diff --git a/.gitignore b/.gitignore index c2221880ed1..7e1c908a17d 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000000..b096ed4f3bb --- /dev/null +++ b/.vscode/extensions.json @@ -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" + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000000..b13004b79df --- /dev/null +++ b/.vscode/settings.json @@ -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" +} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e0c655034d..737a6792b77 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.