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

The documentation for the @tanstack eslint plugin is inconsistent #7200

Closed
jakobarsement opened this issue Mar 29, 2024 · 4 comments
Closed

Comments

@jakobarsement
Copy link

Describe the bug

In these docs (https://tanstack.com/query/v4/docs/eslint/eslint-plugin-query) should @tanstack/query be @tanstack/eslint-plugin-query? This was a little confusing for me on first read.

image

Your minimal, reproducible example

https://tanstack.com/query/v4/docs/eslint/eslint-plugin-query#usage

Steps to reproduce

Go to: https://tanstack.com/query/v4/docs/eslint/eslint-plugin-query#usage

Expected behavior

I expect this plugin in the example code to be either 1) consistent with the wording of the description above it e.g. both are @tanstack/eslint-plugin-query or 2) be more accurately described in the description regarding the relationship between @tanstack/query and @tanstack/eslint-plugin-query

How often does this bug happen?

None

Screenshots or Videos

image

Platform

Google Chrome

Version 122.0.6261.128 (Official Build) (64-bit)

Tanstack Query adapter

None

TanStack Query version

v4 documentation

TypeScript version

No response

Additional context

No response

@TkDodo
Copy link
Collaborator

TkDodo commented Apr 2, 2024

afaik, this is eslint plugin convention. See:

To configure plugins inside of a configuration file, use the plugins key, which contains a list of plugin names. The eslint-plugin- prefix can be omitted from the plugin name.

@TkDodo TkDodo closed this as not planned Won't fix, can't repro, duplicate, stale Apr 2, 2024
@jakobarsement
Copy link
Author

Can we clarify this for users? It's hard to be aware of every subtle nuance like this when it isn't stated at the time of relevance. @TkDodo

@TkDodo
Copy link
Collaborator

TkDodo commented Apr 2, 2024

the code in the docs is copy-paste-able as it is, so what do we need to clarify?

@jakobarsement
Copy link
Author

thank you for your care on this small matter. i see your points, i just found this a bit frustrating when setting up the eslint plugin and assumed others might too

this might look like an error to someone that is not aware of that eslint doc you linked. my specific scenario: when debugging why eslint was not be behaving as expected, it caused me to doubt the docs' accuracy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants