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

Incorrect rule name, or misleading docs #186

Closed
vlascik opened this issue Oct 28, 2020 · 4 comments
Closed

Incorrect rule name, or misleading docs #186

vlascik opened this issue Oct 28, 2020 · 4 comments

Comments

@vlascik
Copy link
Contributor

vlascik commented Oct 28, 2020

Docs at https://github.com/NullVoxPopuli/eslint-plugin-decorator-position#2-modify-your-eslintrcjs put the name of the rules configuration entry as decorator-position, but

'decorator-position/decorator-position': ['error', {}],
exports it as decorator-position/decorator-position.

One of those is incorrect, currently, if you try to follow the docs and configure the rules at decorator-position, eslint is going to show an error ESLint: Definition for rule ;decorator-position' was not found.

@NullVoxPopuli
Copy link
Owner

The examples have the full thing:

https://github.com/NullVoxPopuli/eslint-plugin-decorator-position/blob/master/smoke-tests/integration/position-prettier/.eslintrc.js#L5

So it's an issue with the docs.
I'd happily accept a PR to update the docs :)

@vlascik
Copy link
Contributor Author

vlascik commented Oct 28, 2020

You realize fixing it in a README file on your drive and commiting it whenever would take half the characters it took to ask for a PR though, right? :)

@NullVoxPopuli
Copy link
Owner

Yup. And it'd also be less than any of these comments. I'm on my phone :)

@vlascik vlascik closed this as completed Nov 5, 2020
@vlascik
Copy link
Contributor Author

vlascik commented Nov 5, 2020

Closed in #189

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