Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add necessary VS Code ESLint config to documentation #5379

Closed
kabece opened this issue Jun 25, 2023 · 1 comment
Closed

Add necessary VS Code ESLint config to documentation #5379

kabece opened this issue Jun 25, 2023 · 1 comment
Assignees
Labels
needs: triage New issues get this label. Remove it after triage

Comments

@kabece
Copy link

kabece commented Jun 25, 2023

Which project is this feature idea for?

Turborepo

Describe the feature you'd like to request

At the moment, the ESLint will not work correctly in a turborepo project after following the documentation which can be confusing because for most projects it works out-of-the-box.

VS Code is popular enough that the below could be added at the end of the ESLint page to make it easier for everyone.

Describe the solution you'd like

VS Code may have problems understanding in which folders ESLint needs to run.

This can be fixed by going to your VS Code Settings (CMD + , on Mac), switching to Workspace and finding eslint.workingDirectories and setting it to: [{ "mode": "auto" }].

This approach has some caveats and there are alternatives, see more here: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint#settings-options

Describe alternatives you've considered

Another approach would be to send the users to the above mentioned ESLint plugin documentation page so it's always in sync.

@kabece kabece added needs: triage New issues get this label. Remove it after triage story labels Jun 25, 2023
@tknickman
Copy link
Member

Fixed in #5826

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs: triage New issues get this label. Remove it after triage
Projects
None yet
Development

No branches or pull requests

2 participants