From e5e545122c4086d3713fd097a260440e19df01a5 Mon Sep 17 00:00:00 2001 From: ITenthusiasm <47364027+ITenthusiasm@users.noreply.github.com> Date: Sat, 6 Mar 2021 15:37:12 -0500 Subject: [PATCH] Improve Contributing Docs (Flow) * Improve the contribution docs by explaining how to setup VS Code with Flow support. * Add .vscode folder to .gitignore. --- .gitignore | 1 + contributing.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+) diff --git a/.gitignore b/.gitignore index a9ded0986..3d0b2fa7e 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,4 @@ coverage lerna-debug.log yarn-error.log .idea +.vscode diff --git a/contributing.md b/contributing.md index f9b3b7b15..b5f63d24d 100644 --- a/contributing.md +++ b/contributing.md @@ -40,3 +40,17 @@ Using karma (real browsers will get launched). ```bash yarn test ``` + +## IDEs + +If you are using VS Code, you'll need to do 2 things to get Flow type support: + +1. Install the [Flow Language Support extension](https://marketplace.visualstudio.com/items?itemName=flowtype.flow-for-vscode). +2. If necessary, update your _local_ settings to disable JS file validation: + +```JSON +// /.vscode/settings.json +{ + "javascript.validate.enable": false +} +```