Prevent text before the first heading #117
Conversation
There was a problem hiding this comment.
Hm, how would you feel about heading_first.rs instead? I think headings_only.rs implies that headings are the only node type allowed.
There was a problem hiding this comment.
This has been updated to reflect the desired naming convention.
| let annotation_type = Level::Error; | ||
| ctx.report(annotation_type.title("Only Heading is allowed after FrontMatter")) |
There was a problem hiding this comment.
To be consistent with the other lints, the minimal report should look something like:
| let annotation_type = Level::Error; | |
| ctx.report(annotation_type.title("Only Heading is allowed after FrontMatter")) | |
| self.ctx | |
| .annotation_level() | |
| .title("Only Heading is allowed after FrontMatter") | |
| .id(self.slug) |
There was a problem hiding this comment.
This has been done to maintain consistency as well
| let annotation_type = Level::Error; | ||
| ctx.report(annotation_type.title("Only Heading is allowed after FrontMatter")) |
There was a problem hiding this comment.
How about this for the error message:
| let annotation_type = Level::Error; | |
| ctx.report(annotation_type.title("Only Heading is allowed after FrontMatter")) | |
| ctx.report(annotation_type.title("Nothing is permitted between the preamble and the first heading")) |
|
All requested changes has been implemented @SamWilsn |
consistency and improve error message ergonomics.
|
Hi @SamWilsn Gone through your commits on this Pull Request and I must say you had a more elegant solution than I did 🫡 I'm inspired to do more, and get better 💪 |
|
Not at all! I just plumbed the new lint up, wrote docs, and added line number info. It's still your algorithm! |
closes #115
This PR introduces a new linting rule to enforce a clean document structure by preventing any text from appearing before the first heading in EIPS. This ensures consistency across all EIPS.