language-servers/roc
1
0
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2025-09-26 21:39:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

feature(formatter): allow single blank line around comments in lists, records, type annotations

Browse source
This commit is contained in:
Sean Hagstrom 2022-05-01 18:28:49 +01:00
parent 84b3ef5fd7
commit 4707528caa
4 changed files with 781 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

24
compiler/fmt/src/collection.rs
View file

@ -2,7 +2,7 @@ use roc_parse::ast::{Collection, ExtractSpaces};
use crate::{ use crate::{
annotation::{Formattable, Newlines}, annotation::{Formattable, Newlines},
spaces::{fmt_comments_only, NewlineAt, INDENT}, spaces::{count_leading_newlines, fmt_comments_only, NewlineAt, INDENT},
Buf, Buf,
}; };
@ -25,12 +25,27 @@ pub fn fmt_collection<'a, 'buf, T: ExtractSpaces<'a> + Formattable>(
buf.indent(braces_indent); buf.indent(braces_indent);
buf.push(start); buf.push(start);
for item in items.iter() { for (index, item) in items.iter().enumerate() {
let item = item.extract_spaces(); let item = item.extract_spaces();
let is_first_item = index == 0;
buf.newline(); buf.newline();
if !item.before.is_empty() { if !item.before.is_empty() {
let is_only_newlines = item.before.iter().all(|s| s.is_newline());
if !is_first_item
&& !is_only_newlines
&& count_leading_newlines(item.before.iter()) > 1
{
buf.newline();
}
fmt_comments_only(buf, item.before.iter(), NewlineAt::Bottom, item_indent); fmt_comments_only(buf, item.before.iter(), NewlineAt::Bottom, item_indent);
if !is_only_newlines && count_leading_newlines(item.before.iter().rev()) > 0 {
buf.newline();
}
} }
item.item.format(buf, item_indent); item.item.format(buf, item_indent);
@ -41,6 +56,11 @@ pub fn fmt_collection<'a, 'buf, T: ExtractSpaces<'a> + Formattable>(
fmt_comments_only(buf, item.after.iter(), NewlineAt::Top, item_indent); fmt_comments_only(buf, item.after.iter(), NewlineAt::Top, item_indent);
} }
} }
if count_leading_newlines(items.final_comments().iter()) > 1 {
buf.newline();
}
fmt_comments_only( fmt_comments_only(
buf, buf,
items.final_comments().iter(), items.final_comments().iter(),

29
compiler/fmt/src/expr.rs
View file

@ -2,7 +2,7 @@ use crate::annotation::{Formattable, Newlines, Parens};
use crate::collection::fmt_collection; use crate::collection::fmt_collection;
use crate::def::fmt_def; use crate::def::fmt_def;
use crate::pattern::fmt_pattern; use crate::pattern::fmt_pattern;
use crate::spaces::{fmt_comments_only, fmt_spaces, NewlineAt, INDENT}; use crate::spaces::{count_leading_newlines, fmt_comments_only, fmt_spaces, NewlineAt, INDENT};
use crate::Buf; use crate::Buf;
use roc_module::called_via::{self, BinOp}; use roc_module::called_via::{self, BinOp};
use roc_parse::ast::{ use roc_parse::ast::{
@ -1105,16 +1105,38 @@ fn fmt_record<'a, 'buf>(
if is_multiline { if is_multiline {
let field_indent = indent + INDENT; let field_indent = indent + INDENT;
for field in loc_fields.iter() { for (index, field) in loc_fields.iter().enumerate() {
// comma addition is handled by the `format_field_multiline` function // comma addition is handled by the `format_field_multiline` function
// since we can have stuff like: // since we can have stuff like:
// { x # comment // { x # comment
// , y // , y
// } // }
// In this case, we have to move the comma before the comment. // In this case, we have to move the comma before the comment.
let is_first_item = index == 0;
if let AssignedField::SpaceBefore(_sub_field, spaces) = &field.value {
let is_only_newlines = spaces.iter().all(|s| s.is_newline());
if !is_first_item
&& !is_only_newlines
&& count_leading_newlines(spaces.iter()) > 1
{
buf.newline();
}
fmt_comments_only(buf, spaces.iter(), NewlineAt::Top, field_indent);
if !is_only_newlines && count_leading_newlines(spaces.iter().rev()) > 0 {
buf.newline();
}
}
format_field_multiline(buf, &field.value, field_indent, ""); format_field_multiline(buf, &field.value, field_indent, "");
} }
if count_leading_newlines(final_comments.iter()) > 1 {
buf.newline();
}
fmt_comments_only(buf, final_comments.iter(), NewlineAt::Top, field_indent); fmt_comments_only(buf, final_comments.iter(), NewlineAt::Top, field_indent);
buf.newline(); buf.newline();
@ -1189,7 +1211,7 @@ fn format_field_multiline<'a, 'buf, T>(
buf.push_str(name.value); buf.push_str(name.value);
buf.push(','); buf.push(',');
} }
AssignedField::SpaceBefore(sub_field, spaces) => { AssignedField::SpaceBefore(sub_field, _spaces) => {
// We have something like that: // We have something like that:
// ``` // ```
// # comment // # comment
@ -1197,7 +1219,6 @@ fn format_field_multiline<'a, 'buf, T>(
// ``` // ```
// we'd like to preserve this // we'd like to preserve this
fmt_comments_only(buf, spaces.iter(), NewlineAt::Top, indent);
format_field_multiline(buf, sub_field, indent, separator_prefix); format_field_multiline(buf, sub_field, indent, separator_prefix);
} }
AssignedField::SpaceAfter(sub_field, spaces) => { AssignedField::SpaceAfter(sub_field, spaces) => {

25
compiler/fmt/src/spaces.rs
View file

@ -117,6 +117,31 @@ fn fmt_comment<'buf>(buf: &mut Buf<'buf>, comment: &str) {
buf.push_str(comment.trim_end()); buf.push_str(comment.trim_end());
} }
pub fn count_leading_newlines<'a, I>(data: I) -> u16
where
I: Iterator<Item = &'a CommentOrNewline<'a>>,
{
let mut count = 0;
let mut allow_counting = false;
for (index, val) in data.enumerate() {
let is_first = index == 0;
let is_newline = matches!(val, CommentOrNewline::Newline);
if is_first && is_newline {
allow_counting = true
}
if is_newline && allow_counting {
count += 1;
} else {
break;
}
}
count
}
fn fmt_docs<'buf>(buf: &mut Buf<'buf>, docs: &str) { fn fmt_docs<'buf>(buf: &mut Buf<'buf>, docs: &str) {
buf.push_str("##"); buf.push_str("##");
if !docs.starts_with(' ') { if !docs.starts_with(' ') {

709
compiler/fmt/tests/test_fmt.rs
View file

@ -192,6 +192,714 @@ mod test_fmt {
); );
} }
#[test]
fn type_annotation_allow_blank_line_before_and_after_comment() {
expr_formats_same(indoc!(
r#"
person :
{
firstName : Str,
# comment
lastName : Str,
}
person
"#
));
expr_formats_same(indoc!(
r#"
person :
{
firstName : Str,
# comment
lastName : Str,
}
person
"#
));
expr_formats_same(indoc!(
r#"
person :
{
firstName : Str,
# comment
lastName : Str,
}
person
"#
));
expr_formats_same(indoc!(
r#"
person :
{
firstName : Str,
# comment
lastName : Str,
}
person
"#
));
expr_formats_same(indoc!(
r#"
person :
{
firstName : Str,
# comment 1
lastName : Str,
# comment 2
# comment 3
}
person
"#
));
expr_formats_same(indoc!(
r#"
person :
{
firstName : Str,
# comment 1
lastName : Str,
# comment 2
# comment 3
}
person
"#
));
expr_formats_to(
indoc!(
r#"
person :
{
# comment
firstName : Str,
lastName : Str,
}
person
"#
),
indoc!(
r#"
person :
{
# comment
firstName : Str,
lastName : Str,
}
person
"#
),
);
expr_formats_to(
indoc!(
r#"
person :
{
firstName : Str,
lastName : Str,
# comment
}
person
"#
),
indoc!(
r#"
person :
{
firstName : Str,
lastName : Str,
# comment
}
person
"#
),
);
expr_formats_to(
indoc!(
r#"
person :
{
firstName : Str,
# comment
lastName : Str,
}
person
"#
),
indoc!(
r#"
person :
{
firstName : Str,
# comment
lastName : Str,
}
person
"#
),
);
expr_formats_to(
indoc!(
r#"
person :
{
firstName : Str,
# comment
lastName : Str,
}
person
"#
),
indoc!(
r#"
person :
{
firstName : Str,
# comment
lastName : Str,
}
person
"#
),
);
expr_formats_to(
indoc!(
r#"
person :
{
firstName : Str,
# comment
lastName : Str,
}
person
"#
),
indoc!(
r#"
person :
{
firstName : Str,
# comment
lastName : Str,
}
person
"#
),
);
}
#[test]
fn record_allow_blank_line_before_and_after_comment() {
expr_formats_same(indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
}
person
"#
));
expr_formats_same(indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
}
person
"#
));
expr_formats_same(indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
}
person
"#
));
expr_formats_same(indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
}
person
"#
));
expr_formats_same(indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
# comment 2
# comment 3
}
person
"#
));
expr_formats_same(indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
# comment 2
# comment 3
}
person
"#
));
expr_formats_to(
indoc!(
r#"
person = {
# comment
firstName: "first",
lastName: "last",
}
person
"#
),
indoc!(
r#"
person = {
# comment
firstName: "first",
lastName: "last",
}
person
"#
),
);
expr_formats_to(
indoc!(
r#"
person = {
firstName: "first",
lastName: "last",
# comment
}
person
"#
),
indoc!(
r#"
person = {
firstName: "first",
lastName: "last",
# comment
}
person
"#
),
);
expr_formats_to(
indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
}
person
"#
),
indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
}
person
"#
),
);
expr_formats_to(
indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
}
person
"#
),
indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
}
person
"#
),
);
expr_formats_to(
indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
}
person
"#
),
indoc!(
r#"
person = {
firstName: "first",
# comment 1
lastName: "last",
}
person
"#
),
);
}
#[test]
fn list_allow_blank_line_before_and_after_comment() {
expr_formats_same(indoc!(
r#"
list = [
0,
# comment
1,
]
list
"#
));
expr_formats_same(indoc!(
r#"
list = [
0,
# comment
1,
]
list
"#
));
expr_formats_same(indoc!(
r#"
list = [
0,
# comment
1,
]
list
"#
));
expr_formats_same(indoc!(
r#"
list = [
0,
# comment
1,
]
list
"#
));
expr_formats_same(indoc!(
r#"
list = [
0,
# comment 1
1,
# comment 2
# comment 3
]
list
"#
));
expr_formats_same(indoc!(
r#"
list = [
0,
# comment 1
1,
# comment 2
# comment 3
]
list
"#
));
expr_formats_to(
indoc!(
r#"
list = [
# comment
0,
1,
]
list
"#
),
indoc!(
r#"
list = [
# comment
0,
1,
]
list
"#
),
);
expr_formats_to(
indoc!(
r#"
list = [
0,
1,
# comment
]
list
"#
),
indoc!(
r#"
list = [
0,
1,
# comment
]
list
"#
),
);
expr_formats_to(
indoc!(
r#"
list = [
0,
# comment
1,
]
list
"#
),
indoc!(
r#"
list = [
0,
# comment
1,
]
list
"#
),
);
expr_formats_to(
indoc!(
r#"
list = [
0,
# comment
1,
]
list
"#
),
indoc!(
r#"
list = [
0,
# comment
1,
]
list
"#
),
);
expr_formats_to(
indoc!(
r#"
list = [
0,
# comment
1,
]
list
"#
),
indoc!(
r#"
list = [
0,
# comment
1,
]
list
"#
),
);
}
#[test] #[test]
fn force_space_at_beginning_of_comment() { fn force_space_at_beginning_of_comment() {
expr_formats_to( expr_formats_to(
@ -1648,6 +2356,7 @@ mod test_fmt {
r#" r#"
[ [
# Thirty Seven # Thirty Seven
37, 37,
# Thirty Eight # Thirty Eight
38, 38,