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 linter to require RFC-2119 keywords are capitalized #77

Open
kdenhartog opened this issue Jun 7, 2023 · 6 comments
Open

Add a linter to require RFC-2119 keywords are capitalized #77

kdenhartog opened this issue Jun 7, 2023 · 6 comments
Labels
in discussion Feature is still in discussion and should not be implemented

Comments

@kdenhartog
Copy link
Contributor

This isn't a necessity, but it would be nice if the linter called out when keywords are used and forced capitalization of them. This can be useful for readers to understand when the reader intentionally wants a piece of text to be a normative statement (required for conformance to the spec) versus when the author is accidentally reusing a normative word and should update the text so that it's more clear this isn't required.

@SamWilsn SamWilsn added the in discussion Feature is still in discussion and should not be implemented label Jun 28, 2023
@SamWilsn
Copy link
Contributor

So the two rules could be:

  • Error if capitalized keywords appear outside of the specification section.
  • Warn if a non-capitalized keyword appears inside the specification section.

Sound reasonable?

@kdenhartog
Copy link
Contributor Author

That would be ideal. I'd be alright with warn for both as well based on the amount of complaints about linter being overly strict.

@0xshikhar
Copy link

Hey @kdenhartog , would like to work on this task - can you assign me that. Could you clarify the remaining tasks for this issue? Any additional context would be appreciated. Thanks!

@SamWilsn
Copy link
Contributor

There hasn't been formal agreement on this lint, so it's certainly lower priority. We could maybe turn it on warning only?

@0xshikhar
Copy link

0xshikhar commented Nov 26, 2024

Ok, I got it. Yes, we can work on just warning only from now on.

@kdenhartog
Copy link
Contributor Author

I think turning it on warning only to start makes sense. From there we can figure out how people respond to it and go from there. What will be interesting to see is if this is a subtle nudge for EIP authors to start using normative language more or if it's going to just become an annoyance to revert.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in discussion Feature is still in discussion and should not be implemented
Projects
None yet
Development

No branches or pull requests

3 participants