Rename CommentDirectives to CommentsExt (#426)

Author: DavisVaughan

crates/air_r_formatter/src/directives.rs …ates/air_r_formatter/src/comments_ext.rscrates/air_r_formatter/src/directives.rs renamed to crates/air_r_formatter/src/comments_ext.rs crates/air_r_formatter/src/directives.rs renamed to crates/air_r_formatter/src/comments_ext.rs

@@ -12,16 +12,21 @@ use settings::Table;
 use crate::RFormatter;
 use crate::comments::RComments;
 
-/// Extension trait for comment [comments::Directive]s
-pub trait CommentDirectives {
+/// Extension trait for [biome_formatter::Comments]
+///
+/// Currently this is for extending [biome_formatter::Comments] with knowledge about our
+/// comment directives
+pub trait CommentsExt {
     type Language: Language;
 
+    /// Does this node contain a `# fmt: skip` directive?
     fn has_skip_directive(&self, node: &SyntaxNode<Self::Language>) -> bool;
 
+    /// Does this node contain a `# fmt: table` directive?
     fn has_table_directive(&self, node: &SyntaxNode<Self::Language>) -> bool;
 }
 
-impl CommentDirectives for RComments {
+impl CommentsExt for RComments {
     type Language = RLanguage;
 
     fn has_skip_directive(&self, node: &SyntaxNode<Self::Language>) -> bool {
@@ -67,6 +72,7 @@ fn can_have_directive(node: &RSyntaxNode) -> bool {
     )
 }
 
+/// Is the name of this function call contained within the `skip` `air.toml` setting?
 pub(crate) fn in_skip_setting(node: &RCall, f: &RFormatter) -> SyntaxResult<bool> {
     fn pred(node: RIdentifier, skip: &Skip) -> SyntaxResult<bool> {
         let node = node.name_token()?;
@@ -76,6 +82,7 @@ pub(crate) fn in_skip_setting(node: &RCall, f: &RFormatter) -> SyntaxResult<bool
     in_setting(node, f.options().skip(), pred)
 }
 
+/// Is the name of this function call contained within the `table` `air.toml` setting?
 pub(crate) fn in_table_setting(node: &RCall, f: &RFormatter) -> SyntaxResult<bool> {
     fn pred(node: RIdentifier, table: &Table) -> SyntaxResult<bool> {
         let node = node.name_token()?;

crates/air_r_formatter/src/lib.rs

@@ -13,15 +13,15 @@ use biome_formatter::write;
 use biome_rowan::AstNode;
 
 use crate::comments::RCommentStyle;
+use crate::comments_ext::CommentsExt;
 use crate::context::RFormatContext;
 use crate::context::RFormatOptions;
 use crate::cst::FormatRSyntaxNode;
-use crate::directives::CommentDirectives;
 
 pub mod comments;
+pub mod comments_ext;
 pub mod context;
 mod cst;
-pub mod directives;
 pub mod either;
 pub mod formatter_ext;
 pub mod joiner_ext;

crates/air_r_formatter/src/r/auxiliary/binary_expression.rs

@@ -1,5 +1,5 @@
+use crate::comments_ext::CommentsExt;
 use crate::context::RFormatOptions;
-use crate::directives::CommentDirectives;
 use crate::either::Either;
 use crate::prelude::*;
 use crate::r::auxiliary::call_arguments::FormatRCallArgumentsOptions;
@@ -85,7 +85,9 @@ impl FormatNodeRule<RBinaryExpression> for FormatRBinaryExpression {
             | RSyntaxKind::ASSIGN
             | RSyntaxKind::ASSIGN_RIGHT
             | RSyntaxKind::SUPER_ASSIGN
-            | RSyntaxKind::SUPER_ASSIGN_RIGHT => fmt_binary_assignment(node, left, operator, right, f),
+            | RSyntaxKind::SUPER_ASSIGN_RIGHT => {
+                fmt_binary_assignment(node, left, operator, right, f)
+            }
 
             // Chainable (pipes, logical, arithmetic)
             kind if is_chainable_binary_operator(kind) => {

crates/air_r_formatter/src/r/auxiliary/call.rs

@@ -1,6 +1,6 @@
-use crate::directives::CommentDirectives;
-use crate::directives::in_skip_setting;
-use crate::directives::in_table_setting;
+use crate::comments_ext::CommentsExt;
+use crate::comments_ext::in_skip_setting;
+use crate::comments_ext::in_table_setting;
 use crate::prelude::*;
 use crate::r::auxiliary::call_arguments::FormatRCallArgumentsOptions;
 

crates/air_r_formatter/src/r/auxiliary/unary_expression.rs

@@ -1,4 +1,4 @@
-use crate::directives::CommentDirectives;
+use crate::comments_ext::CommentsExt;
 use crate::prelude::*;
 use air_r_syntax::AnyRExpression;
 use air_r_syntax::RSyntaxKind;