-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
714 additions
and
23 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| //! Ensures that lines do not exceed a certain width. | ||
| use wdl_ast::AstToken; | ||
| use wdl_ast::Diagnostic; | ||
| use wdl_ast::Diagnostics; | ||
| use wdl_ast::Span; | ||
| use wdl_ast::Visitor; | ||
|
|
||
| use crate::Rule; | ||
| use crate::Tag; | ||
| use crate::TagSet; | ||
|
|
||
| /// The identifier for the line width rule. | ||
| const ID: &str = "LineWidth"; | ||
|
|
||
| /// Creates a diagnostic for when a line exceeds the maximum width. | ||
| fn line_too_long(span: Span, max_width: usize) -> Diagnostic { | ||
| Diagnostic::note(format!("line exceeds maximum width of {}", max_width)) | ||
| .with_rule(ID) | ||
| .with_highlight(span) | ||
| .with_fix("split the line into multiple lines") | ||
| } | ||
|
|
||
| /// Detects lines that exceed a certain width. | ||
| #[derive(Debug, Clone, Copy)] | ||
| pub struct LineWidthRule(usize); | ||
|
|
||
| /// Implements the default line width rule. | ||
| impl Default for LineWidthRule { | ||
| fn default() -> Self { | ||
| Self(90) | ||
| } | ||
| } | ||
|
|
||
| impl Rule for LineWidthRule { | ||
| fn id(&self) -> &'static str { | ||
| ID | ||
| } | ||
|
|
||
| fn description(&self) -> &'static str { | ||
| "Ensures that lines do not exceed a certain width. That width is currently set to 90 \ | ||
| characters." | ||
| } | ||
|
|
||
| fn explanation(&self) -> &'static str { | ||
| "Lines should not exceed a certain width to make it easier to read and understand the \ | ||
| code. Code within the either the meta or parameter meta sections is not checked. Comments \ | ||
| are included in the line width check. The current maximum width is 90 characters." | ||
| } | ||
|
|
||
| fn tags(&self) -> TagSet { | ||
| TagSet::new(&[Tag::Style, Tag::Clarity, Tag::Spacing]) | ||
| } | ||
|
|
||
| fn visitor(&self) -> Box<dyn Visitor<State = Diagnostics>> { | ||
| Box::new(LineWidthVisitor::new(self.0)) | ||
| } | ||
| } | ||
|
|
||
| /// A visitor that detects lines that exceed a certain width. | ||
| #[derive(Debug, Clone, Copy)] | ||
| struct LineWidthVisitor { | ||
| /// The maximum width of a line. | ||
| max_width: usize, | ||
| /// The offset of the previous newline. | ||
| prev_newline_offset: usize, | ||
| /// Whether we are in a section that should be ignored. | ||
| should_ignore: bool, | ||
| } | ||
|
|
||
| impl LineWidthVisitor { | ||
| /// Creates a new line width visitor. | ||
| fn new(max_width: usize) -> Self { | ||
| Self { | ||
| max_width, | ||
| prev_newline_offset: 0, | ||
| should_ignore: false, | ||
| } | ||
| } | ||
|
|
||
| /// Detects lines that exceed a certain width. | ||
| fn detect_line_too_long(&mut self, state: &mut Diagnostics, text: &str, start: usize) { | ||
| let mut cur_newline_offset = start; | ||
| text.char_indices().for_each(|(i, c)| { | ||
| if c == '\n' { | ||
| cur_newline_offset = start + i; | ||
| if self.should_ignore { | ||
| self.prev_newline_offset = cur_newline_offset + 1; | ||
| return; | ||
| } | ||
|
|
||
| if cur_newline_offset - self.prev_newline_offset > self.max_width { | ||
| state.add(line_too_long( | ||
| Span::new( | ||
| self.prev_newline_offset, | ||
| cur_newline_offset - self.prev_newline_offset, | ||
| ), | ||
| self.max_width, | ||
| )); | ||
| } | ||
| self.prev_newline_offset = cur_newline_offset + 1; | ||
| } | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| impl Visitor for LineWidthVisitor { | ||
| type State = Diagnostics; | ||
|
|
||
| fn whitespace(&mut self, state: &mut Self::State, whitespace: &wdl_ast::Whitespace) { | ||
| self.detect_line_too_long(state, whitespace.as_str(), whitespace.span().start()); | ||
| } | ||
|
|
||
| fn command_text(&mut self, state: &mut Self::State, text: &wdl_ast::v1::CommandText) { | ||
| self.detect_line_too_long(state, text.as_str(), text.span().start()) | ||
| } | ||
|
|
||
| fn metadata_section( | ||
| &mut self, | ||
| _: &mut Self::State, | ||
| reason: wdl_ast::VisitReason, | ||
| _: &wdl_ast::v1::MetadataSection, | ||
| ) { | ||
| match reason { | ||
| wdl_ast::VisitReason::Enter => { | ||
| self.should_ignore = true; | ||
| } | ||
| wdl_ast::VisitReason::Exit => { | ||
| self.should_ignore = false; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fn parameter_metadata_section( | ||
| &mut self, | ||
| _: &mut Self::State, | ||
| reason: wdl_ast::VisitReason, | ||
| _: &wdl_ast::v1::ParameterMetadataSection, | ||
| ) { | ||
| match reason { | ||
| wdl_ast::VisitReason::Enter => { | ||
| self.should_ignore = true; | ||
| } | ||
| wdl_ast::VisitReason::Exit => { | ||
| self.should_ignore = false; | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters