8000 Docs: Add FAQs and flesh out associated docs for project service · Issue #9753 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

Docs: Add FAQs and flesh out associated docs for project service #9753

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.

Sign up for GitHub

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

Jump to bottom
Closed
2 tasks done
JoshuaKGoldberg opened this issue Aug 8, 2024 · 3 comments · Fixed by #9871
Closed
2 tasks done

Docs: Add FAQs and flesh out associated docs for project service #9753

JoshuaKGoldberg opened this issue Aug 8, 2024 · 3 comments · Fixed by #9871
Labels
documentation Documentation ("docs") that needs adding/updating locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. team assigned A member of the typescript-eslint team should work on this.

Comments

@JoshuaKGoldberg
Copy link
Member
JoshuaKGoldberg commented Aug 8, 2024 •
edited
Loading

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Project service has been in the wild for a couple of weeks now and we're starting to see the common ways it's tripping folks up.

The most common question I've seen come up is around the new "Parsing error: was not found by the project service. Consider either including it in the tsconfig.json or including it in allowDefaultProject". We should explain how to fix this, such as:

Affected URL(s)

https://typescript-eslint.io/troubleshooting/typed-linting

💖
@JoshuaKGoldberg JoshuaKGoldberg added documentation Documentation ("docs") that needs adding/updating team assigned A member of the typescript-eslint team should work on this. labels Aug 8, 2024
This was referenced Aug 8, 2024
Closed
Closed
@Zamiell
Copy link
Contributor
Zamiell commented Aug 11, 2024

We should explain how to fix this

What about improving the error message? For example, if the error is on a .js file specifically, I would like to see a message saying something along the lines of:

Tip: Try turning on the "checkJs" compiler flag in your TypeScript config file.

@JoshuaKGoldberg
Copy link
Member Author

What about improving the error message?

I like that idea too 😄. That'd be a good separate issue. It's often very difficult or outright not possible to know what folks wanted. For example, if it's on a .js file, the solution could be any of needing checkJs, or using the wrong TS config file, or the file accidentally being linted or, ...

@JoshuaKGoldberg
Copy link
Member Author
JoshuaKGoldberg commented Aug 19, 2024 •
edited
Loading

Sourcing a couple cases from #9739:

This was referenced Aug 19, 2024
Closed
Closed
Merged
@github-actions github-actions bot added the locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. label Sep 4, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Documentation ("docs") that needs adding/updating locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. team assigned A member of the typescript-eslint team should work on this.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: add more project service docs and FAQs JoshuaKGoldberg/typescript-eslint
2 participants
@JoshuaKGoldberg @Zamiell
0