diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 726567a..1fb5cb2 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1 +1,10 @@ -{ "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"] } +{ + "recommendations": [ + "dbaeumer.vscode-eslint", + "firsttris.vscode-jest-runner", + "esbenp.prettier-vscode", + "rvest.vs-code-prettier-eslint", + "DavidAnson.vscode-markdownlint", + "streetsidesoftware.code-spell-checker-cspell-bundled-dictionaries" + ] +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f0a3fd..86b819b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,6 +22,8 @@ or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any addi - Install [Visual Studio Code](https://code.visualstudio.com/). +- Install the [recommended plugins](#recommended-vs-code-extensions) for [Visual Studio Code](https://code.visualstudio.com/). + - Install [Node.js](https://nodejs.org/en/), with [nvm](https://github.com/nvm-sh/nvm). Please use Node version 16 and npm v 8. - Install [jscodeshift](https://github.com/facebook/jscodeshift) globally. @@ -49,6 +51,16 @@ or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any addi - Make and submit changes following the [pull request submission workflow](#pull-requests) +## Recommended VS Code Extensions + +To ensure a consistent and productive development environment, install the following extensions in Visual Studio Code: + +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) — Linting for JavaScript/TypeScript. +- [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner) — Run or debug Jest tests from context menu. +- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) — Code formatting using Prettier. +- [Prettier ESLint](https://marketplace.visualstudio.com/items?itemName=rvest.vs-code-prettier-eslint) — Format code with Prettier and ESLint integration. +- [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) — Linting and style checks for Markdown files. + ## To create a new ESLint rule If you want to create a new ESLint rule: diff --git a/KNOWN_ISSUES.md b/KNOWN_ISSUES.md new file mode 100644 index 0000000..c309738 --- /dev/null +++ b/KNOWN_ISSUES.md @@ -0,0 +1,21 @@ +# Known Issues + +## No object props deconstruction + +We currently do not support object props deconstruction. + +e.g. + +```tsx + const buttonProps = { + icon: , + aria-label: 'start date' + }; + +