-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: implement the
ImportPlacement rule. (#89)
- Loading branch information
1 parent
b33cceb
commit 066d6bd
Showing
16 changed files
with
304 additions
and
33 deletions.
There are no files selected for viewing
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
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 |
|---|---|---|
| @@ -1,2 +1,4 @@ | ||
| RootNode@0..14 | ||
| Unparsed@0..14 "task foo {\n\n}\n" | ||
| RootNode@0..64 | ||
| Comment@0..48 "# This is a test of a ..." | ||
| Whitespace@48..50 "\n\n" | ||
| Unparsed@50..64 "task foo {\n\n}\n" |
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,121 @@ | ||
| //! A lint rule for import placements. | ||
| use wdl_ast::v1::ImportStatement; | ||
| use wdl_ast::v1::StructDefinition; | ||
| use wdl_ast::v1::TaskDefinition; | ||
| use wdl_ast::v1::Visitor; | ||
| use wdl_ast::v1::WorkflowDefinition; | ||
| use wdl_ast::AstNode; | ||
| use wdl_ast::Diagnostic; | ||
| use wdl_ast::Diagnostics; | ||
| use wdl_ast::Span; | ||
| use wdl_ast::ToSpan; | ||
| use wdl_ast::VisitReason; | ||
|
|
||
| use super::Rule; | ||
| use crate::Tag; | ||
| use crate::TagSet; | ||
|
|
||
| /// The identifier for the import placement rule. | ||
| const ID: &str = "ImportPlacement"; | ||
|
|
||
| /// Creates a "misplaced import" diagnostic. | ||
| fn misplaced_import(span: Span) -> Diagnostic { | ||
| Diagnostic::warning("misplaced import") | ||
| .with_rule(ID) | ||
| .with_highlight(span) | ||
| .with_fix( | ||
| "move this import so that it comes after the version statement but before any \ | ||
| document items", | ||
| ) | ||
| } | ||
|
|
||
| /// Detects incorrect import placements. | ||
| #[derive(Debug, Clone, Copy)] | ||
| pub struct ImportPlacementRule; | ||
|
|
||
| impl Rule for ImportPlacementRule { | ||
| fn id(&self) -> &'static str { | ||
| ID | ||
| } | ||
|
|
||
| fn description(&self) -> &'static str { | ||
| "Ensures that imports are placed between the version statement and any document items." | ||
| } | ||
|
|
||
| fn explanation(&self) -> &'static str { | ||
| "All import statements should follow the WDL version declaration with one empty line \ | ||
| between the version and the first import statement." | ||
| } | ||
|
|
||
| fn tags(&self) -> TagSet { | ||
| TagSet::new(&[Tag::Clarity]) | ||
| } | ||
|
|
||
| fn visitor(&self) -> Box<dyn Visitor<State = Diagnostics>> { | ||
| Box::new(ImportPlacementVisitor::default()) | ||
| } | ||
| } | ||
|
|
||
| /// Implements the visitor for the import placement rule. | ||
| #[derive(Default)] | ||
| struct ImportPlacementVisitor { | ||
| /// Whether or not an import statement is considered invalid. | ||
| invalid: bool, | ||
| } | ||
|
|
||
| impl Visitor for ImportPlacementVisitor { | ||
| type State = Diagnostics; | ||
|
|
||
| fn import_statement( | ||
| &mut self, | ||
| state: &mut Self::State, | ||
| reason: VisitReason, | ||
| stmt: &ImportStatement, | ||
| ) { | ||
| if reason == VisitReason::Exit { | ||
| return; | ||
| } | ||
|
|
||
| if self.invalid { | ||
| state.add(misplaced_import(stmt.syntax().text_range().to_span())); | ||
| } | ||
| } | ||
|
|
||
| fn struct_definition( | ||
| &mut self, | ||
| _: &mut Self::State, | ||
| reason: VisitReason, | ||
| _: &StructDefinition, | ||
| ) { | ||
| if reason == VisitReason::Exit { | ||
| return; | ||
| } | ||
|
|
||
| // Saw an item other than an import, imports are no longer valid | ||
| self.invalid = true; | ||
| } | ||
|
|
||
| fn task_definition(&mut self, _: &mut Self::State, reason: VisitReason, _: &TaskDefinition) { | ||
| if reason == VisitReason::Exit { | ||
| return; | ||
| } | ||
|
|
||
| // Saw an item other than an import, imports are no longer valid | ||
| self.invalid = true; | ||
| } | ||
|
|
||
| fn workflow_definition( | ||
| &mut self, | ||
| _: &mut Self::State, | ||
| reason: VisitReason, | ||
| _: &WorkflowDefinition, | ||
| ) { | ||
| if reason == VisitReason::Exit { | ||
| return; | ||
| } | ||
|
|
||
| // Saw an item other than an import, imports are no longer valid | ||
| self.invalid = true; | ||
| } | ||
| } |
Oops, something went wrong.