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 a custom rule to enforce conventions in rule metadata #6954

Closed
btmills opened this issue Aug 21, 2016 · 6 comments
Closed

Add a custom rule to enforce conventions in rule metadata #6954

btmills opened this issue Aug 21, 2016 · 6 comments
Assignees
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion chore This change is not user-facing infrastructure Relates to the tools used in the ESLint development process

Comments

@btmills
Copy link
Member

btmills commented Aug 21, 2016

Forking this from discussion on #6915.

The problem you want to solve.

Most of our rule descriptions begin with lowercase letters. #6915 corrected two that didn't. Right now, we have no automatic verification of conventions there.

Your take on the correct solution to the problem.

@ilyavolodin We should think about adding a custom rule for this.

@vitorbal sounds good, maybe the custom rule could also enforce that the description starts with one of "enforce", "require", "disallow", etc.?
When we make it so the title of each rule page also comes from the meta.description we will benefit even more from this consistency.

@btmills btmills added infrastructure Relates to the tools used in the ESLint development process evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Aug 21, 2016
@ilyavolodin ilyavolodin added the chore This change is not user-facing label Aug 22, 2016
@vitorbal
Copy link
Member

I'm willing to work on this if it get's accepted. Except if you'd like to take a stab at it, @btmills!

@btmills
Copy link
Member Author

btmills commented Aug 24, 2016

@vitorbal all yours!

@platinumazure
Copy link
Member

Dang, we haven't had any movement here in a while.

I'm in favor, but I'm not sure if this requires TSC consensus. @btmills What are our next steps here?

@vitorbal vitorbal self-assigned this Sep 4, 2016
@btmills
Copy link
Member Author

btmills commented Sep 4, 2016

Since this isn't so much a core feature as it is an internal chore, I can't think of anything that would require TSC here. Next step be consensus and acceptance. I'll add my 👍. @vitorbal since you're willing to implement, are you also championing? It looks like @ilyavolodin 👍'd my original comment, so assuming that counts as another (ref #6424 (comment)), that would give us 3 including a champion.

@vitorbal
Copy link
Member

vitorbal commented Sep 4, 2016

Sure, I'll champion!
On Sun, Sep 4, 2016 at 10:53 PM Brandon Mills notifications@github.com
wrote:

Since this isn't so much a core feature as it is an internal chore, I
can't think of anything that would require TSC here. Next step be consensus
and acceptance. I'll add my 👍. @vitorbal https://github.com/vitorbal
since you're willing to implement, are you also championing? It looks like
@ilyavolodin https://github.com/ilyavolodin 👍'd my original comment,
so assuming that counts as another (ref #6424 (comment)
#6424 (comment)),
that would give us 3 including a champion.


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#6954 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAmNdm9e02ZJix5WAji5I6dP9O6lJuytks5qmy-wgaJpZM4JpZMz
.

@ilyavolodin ilyavolodin added accepted There is consensus among the team that this change meets the criteria for inclusion and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Sep 5, 2016
@vitorbal
Copy link
Member

PR is up here: #7155

@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion chore This change is not user-facing infrastructure Relates to the tools used in the ESLint development process
Projects
None yet
Development

No branches or pull requests

4 participants