NullVoxPopuli / eslint-plugin-decorator-position

ESLint plugin for enforcing decorator position

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Incorrect rule name, or misleading docs

vlascik opened this issue · comments

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.

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 :)

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? :)

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

Closed in #189