New package header syntax

Implements the new package header syntax as discussed in Zulip [1].

package [Csv] {
    parser: "../parser/main.roc"
}

Old headers still parse and are automatically upgraded to the new
syntax by the formatter.

[1] 418444862

crates/cli/tests/fixtures/packages/csv/main.roc

@@ -1,3 +1 @@
-package "csv"
+package [Csv] {}
-    exposes [Csv]
-    packages {}

crates/cli/tests/fixtures/packages/json/main.roc

@@ -1,3 +1 @@
-package "json"
+package [JsonParser] {}
-    exposes [JsonParser]
-    packages {}

crates/compiler/builtins/roc/main.roc

@@ -1,3 +1,15 @@
-package "builtins"
+package [
-    exposes [Str, Num, Bool, Result, List, Dict, Set, Decode, Encode, Hash, Box, TotallyNotJson, Inspect]
+    Str,
-    packages {}
+    Num,
+    Bool,
+    Result,
+    List,
+    Dict,
+    Set,
+    Decode,
+    Encode,
+    Hash,
+    Box,
+    TotallyNotJson,
+    Inspect,
+] {}

crates/compiler/fmt/src/module.rs

@@ -5,7 +5,7 @@ use crate::spaces::RemoveSpaces;
 use crate::spaces::{fmt_comments_only, fmt_default_spaces, fmt_spaces, NewlineAt, INDENT};
 use crate::Buf;
 use bumpalo::Bump;
-use roc_parse::ast::{Collection, Header, Module, Spaced, Spaces};
+use roc_parse::ast::{Collection, CommentOrNewline, Header, Module, Spaced, Spaces};
 use roc_parse::header::{
     AppHeader, ExposedName, ExposesKeyword, GeneratesKeyword, HostedHeader, ImportsEntry,
     ImportsKeyword, Keyword, KeywordItem, ModuleHeader, ModuleName, PackageEntry, PackageHeader,
@@ -177,15 +177,8 @@ pub fn fmt_module_header<'a>(buf: &mut Buf, header: &'a ModuleHeader<'a>) {
     buf.indent(0);
     buf.push_str("module");
 
-    if header.before_exposes.iter().all(|c| c.is_newline()) {
+    let indent = fmt_spaces_with_outdent(buf, header.before_exposes, INDENT);
-        buf.spaces(1);
+    fmt_exposes(buf, header.exposes, indent);
-        fmt_exposes(buf, header.exposes, 0);
-    } else {
-        let indent = INDENT;
-
-        fmt_default_spaces(buf, header.before_exposes, indent);
-        fmt_exposes(buf, header.exposes, indent);
-    };
 }
 
 pub fn fmt_hosted_header<'a>(buf: &mut Buf, header: &'a HostedHeader<'a>) {
@@ -209,37 +202,32 @@ pub fn fmt_app_header<'a>(buf: &mut Buf, header: &'a AppHeader<'a>) {
     buf.indent(0);
     buf.push_str("app");
 
-    let indent = INDENT;
+    let indent = fmt_spaces_with_outdent(buf, header.before_provides, INDENT);
+    fmt_exposes(buf, header.provides, indent);
 
-    if header.before_provides.iter().all(|c| c.is_newline()) {
+    let indent = fmt_spaces_with_outdent(buf, header.before_packages, INDENT);
-        buf.spaces(1);
+    fmt_packages(buf, header.packages.value, indent);
-        fmt_exposes(buf, header.provides, 0);
+}
-    } else {
-        fmt_default_spaces(buf, header.before_provides, indent);
-        fmt_exposes(buf, header.provides, indent);
-    }
 
-    if header.before_packages.iter().all(|c| c.is_newline()) {
+pub fn fmt_spaces_with_outdent(buf: &mut Buf, spaces: &[CommentOrNewline], indent: u16) -> u16 {
+    if spaces.iter().all(|c| c.is_newline()) {
         buf.spaces(1);
-        fmt_packages(buf, header.packages.value, 0);
+        0
     } else {
-        fmt_default_spaces(buf, header.before_packages, indent);
+        fmt_default_spaces(buf, spaces, indent);
-        fmt_packages(buf, header.packages.value, indent);
+        indent
     }
 }
 
 pub fn fmt_package_header<'a>(buf: &mut Buf, header: &'a PackageHeader<'a>) {
     buf.indent(0);
     buf.push_str("package");
-    let indent = INDENT;
-    fmt_default_spaces(buf, header.before_name, indent);
 
-    fmt_package_name(buf, header.name.value, indent);
+    let indent = fmt_spaces_with_outdent(buf, header.before_exposes, INDENT);
+    fmt_exposes(buf, header.exposes, indent);
 
-    header.exposes.keyword.format(buf, indent);
+    let indent = fmt_spaces_with_outdent(buf, header.before_packages, INDENT);
-    fmt_exposes(buf, header.exposes.item, indent);
+    fmt_packages(buf, header.packages.value, indent);
-    header.packages.keyword.format(buf, indent);
-    fmt_packages(buf, header.packages.item, indent);
 }
 
 pub fn fmt_platform_header<'a>(buf: &mut Buf, header: &'a PlatformHeader<'a>) {

crates/compiler/fmt/src/spaces.rs

@@ -299,9 +299,9 @@ impl<'a> RemoveSpaces<'a> for Module<'a> {
                     .remove_spaces(arena),
             }),
             Header::Package(header) => Header::Package(PackageHeader {
-                before_name: &[],
+                before_exposes: &[],
-                name: header.name.remove_spaces(arena),
                 exposes: header.exposes.remove_spaces(arena),
+                before_packages: &[],
                 packages: header.packages.remove_spaces(arena),
             }),
             Header::Platform(header) => Header::Platform(PlatformHeader {

crates/compiler/load_internal/src/file.rs

@@ -4851,12 +4851,12 @@ fn build_package_header<'a>(
     module_timing: ModuleTiming,
 ) -> Result<(ModuleId, PQModuleName<'a>, ModuleHeader<'a>), LoadingProblem<'a>> {
     let exposes = bumpalo::collections::Vec::from_iter_in(
-        unspace(arena, header.exposes.item.items).iter().copied(),
+        unspace(arena, header.exposes.items).iter().copied(),
         arena,
     );
-    let packages = unspace(arena, header.packages.item.items);
+    let packages = unspace(arena, header.packages.value.items);
     let exposes_ids = get_exposes_ids(
-        header.exposes.item.items,
+        header.exposes.items,
         arena,
         &module_ids,
         &ident_ids_by_module,

crates/compiler/parse/src/header.rs

@@ -294,12 +294,10 @@ pub struct ProvidesTo<'a> {
 
 #[derive(Clone, Debug, PartialEq)]
 pub struct PackageHeader<'a> {
-    pub before_name: &'a [CommentOrNewline<'a>],
+    pub before_exposes: &'a [CommentOrNewline<'a>],
-    pub name: Loc<PackageName<'a>>,
+    pub exposes: Collection<'a, Loc<Spaced<'a, ModuleName<'a>>>>,
-
+    pub before_packages: &'a [CommentOrNewline<'a>],
-    pub exposes: KeywordItem<'a, ExposesKeyword, Collection<'a, Loc<Spaced<'a, ModuleName<'a>>>>>,
+    pub packages: Loc<Collection<'a, Loc<Spaced<'a, PackageEntry<'a>>>>>,
-    pub packages:
-        KeywordItem<'a, PackagesKeyword, Collection<'a, Loc<Spaced<'a, PackageEntry<'a>>>>>,
 }
 
 #[derive(Clone, Debug, PartialEq)]

crates/compiler/parse/src/module.rs

@@ -86,7 +86,7 @@ pub fn header<'a>() -> impl Parser<'a, Module<'a>, EHeader<'a>> {
             map!(
                 skip_first!(
                     keyword("package", EHeader::Start),
-                    increment_min_indent(package_header())
+                    increment_min_indent(one_of![package_header(), old_package_header()])
                 ),
                 Header::Package
             ),
@@ -377,14 +377,57 @@ fn old_app_header<'a>() -> impl Parser<'a, AppHeader<'a>, EHeader<'a>> {
 #[inline(always)]
 fn package_header<'a>() -> impl Parser<'a, PackageHeader<'a>, EHeader<'a>> {
     record!(PackageHeader {
-        before_name: space0_e(EHeader::IndentStart),
+        before_exposes: space0_e(EHeader::IndentStart),
-        name: loc!(specialize_err(EHeader::PackageName, package_name())),
+        exposes: specialize_err(EHeader::Exposes, exposes_module_collection()),
-        exposes: specialize_err(EHeader::Exposes, exposes_modules()),
+        before_packages: space0_e(EHeader::IndentStart),
-        packages: specialize_err(EHeader::Packages, packages()),
+        packages: specialize_err(EHeader::Packages, loc!(packages_collection())),
     })
     .trace("package_header")
 }
 
+#[derive(Debug, Clone, PartialEq)]
+struct OldPackageHeader<'a> {
+    before_name: &'a [CommentOrNewline<'a>],
+    exposes: KeywordItem<'a, ExposesKeyword, Collection<'a, Loc<Spaced<'a, ModuleName<'a>>>>>,
+    packages:
+        Loc<KeywordItem<'a, PackagesKeyword, Collection<'a, Loc<Spaced<'a, PackageEntry<'a>>>>>>,
+}
+
+#[inline(always)]
+fn old_package_header<'a>() -> impl Parser<'a, PackageHeader<'a>, EHeader<'a>> {
+    map_with_arena!(
+        record!(OldPackageHeader {
+            before_name: skip_second!(
+                space0_e(EHeader::IndentStart),
+                specialize_err(EHeader::PackageName, package_name())
+            ),
+            exposes: specialize_err(EHeader::Exposes, exposes_modules()),
+            packages: specialize_err(EHeader::Packages, loc!(packages())),
+        }),
+        |arena: &'a bumpalo::Bump, old: OldPackageHeader<'a>| {
+            let before_exposes = merge_n_spaces!(
+                arena,
+                old.before_name,
+                old.exposes.keyword.before,
+                old.exposes.keyword.after
+            );
+            let before_packages = merge_spaces(
+                arena,
+                old.packages.value.keyword.before,
+                old.packages.value.keyword.after,
+            );
+
+            PackageHeader {
+                before_exposes,
+                exposes: old.exposes.item,
+                before_packages,
+                packages: old.packages.map(|kw| kw.item),
+            }
+        }
+    )
+    .trace("old_package_header")
+}
+
 #[inline(always)]
 fn platform_header<'a>() -> impl Parser<'a, PlatformHeader<'a>, EHeader<'a>> {
     record!(PlatformHeader {
@@ -638,16 +681,21 @@ fn exposes_modules<'a>() -> impl Parser<
             EExposes::IndentExposes,
             EExposes::IndentListStart
         ),
-        item: collection_trailing_sep_e!(
+        item: exposes_module_collection(),
-            byte(b'[', EExposes::ListStart),
-            exposes_module(EExposes::Identifier),
-            byte(b',', EExposes::ListEnd),
-            byte(b']', EExposes::ListEnd),
-            Spaced::SpaceBefore
-        ),
     })
 }
 
+fn exposes_module_collection<'a>(
+) -> impl Parser<'a, Collection<'a, Loc<Spaced<'a, ModuleName<'a>>>>, EExposes> {
+    collection_trailing_sep_e!(
+        byte(b'[', EExposes::ListStart),
+        exposes_module(EExposes::Identifier),
+        byte(b',', EExposes::ListEnd),
+        byte(b']', EExposes::ListEnd),
+        Spaced::SpaceBefore
+    )
+}
+
 fn exposes_module<'a, F, E>(
     to_expectation: F,
 ) -> impl Parser<'a, Loc<Spaced<'a, ModuleName<'a>>>, E>

crates/compiler/test_syntax/tests/snapshots/pass/empty_package_header.header.formatted.roc

@@ -1 +1 @@
-package "rtfeldman/blah" exposes [] packages {}
+package [] {}

crates/compiler/test_syntax/tests/snapshots/pass/empty_package_header.header.result-ast

@@ -2,26 +2,10 @@ Module {
     comments: [],
     header: Package(
         PackageHeader {
-            before_name: [],
+            before_exposes: [],
-            name: @8-24 PackageName(
+            exposes: [],
-                "rtfeldman/blah",
+            before_packages: [],
-            ),
+            packages: @11-13 [],
-            exposes: KeywordItem {
-                keyword: Spaces {
-                    before: [],
-                    item: ExposesKeyword,
-                    after: [],
-                },
-                item: [],
-            },
-            packages: KeywordItem {
-                keyword: Spaces {
-                    before: [],
-                    item: PackagesKeyword,
-                    after: [],
-                },
-                item: [],
-            },
         },
     ),
 }

crates/compiler/test_syntax/tests/snapshots/pass/empty_package_header.header.roc

@@ -1 +1 @@
-package "rtfeldman/blah" exposes [] packages {}
+package [] {}

crates/compiler/test_syntax/tests/snapshots/pass/nonempty_package_header.header.formatted.roc

@@ -1,3 +1,3 @@
-package "foo/barbaz"
+package [Foo, Bar] {
-    exposes [Foo, Bar]
+    foo: "./foo",
-    packages { foo: "./foo" }
+}

crates/compiler/test_syntax/tests/snapshots/pass/nonempty_package_header.header.result-ast

@@ -2,46 +2,36 @@ Module {
     comments: [],
     header: Package(
         PackageHeader {
-            before_name: [],
+            before_exposes: [],
-            name: @8-20 PackageName(
+            exposes: [
-                "foo/barbaz",
+                @9-12 ModuleName(
-            ),
+                    "Foo",
-            exposes: KeywordItem {
+                ),
-                keyword: Spaces {
+                @14-17 ModuleName(
-                    before: [
+                    "Bar",
+                ),
+            ],
+            before_packages: [],
+            packages: @19-39 [
+                @25-37 SpaceBefore(
+                    SpaceAfter(
+                        PackageEntry {
+                            shorthand: "foo",
+                            spaces_after_shorthand: [],
+                            platform_marker: None,
+                            package_name: @30-37 PackageName(
+                                "./foo",
+                            ),
+                        },
+                        [
+                            Newline,
+                        ],
+                    ),
+                    [
                         Newline,
                     ],
-                    item: ExposesKeyword,
+                ),
-                    after: [],
+            ],
-                },
-                item: [
-                    @34-37 ModuleName(
-                        "Foo",
-                    ),
-                    @39-42 ModuleName(
-                        "Bar",
-                    ),
-                ],
-            },
-            packages: KeywordItem {
-                keyword: Spaces {
-                    before: [
-                        Newline,
-                    ],
-                    item: PackagesKeyword,
-                    after: [],
-                },
-                item: [
-                    @59-71 PackageEntry {
-                        shorthand: "foo",
-                        spaces_after_shorthand: [],
-                        platform_marker: None,
-                        package_name: @64-71 PackageName(
-                            "./foo",
-                        ),
-                    },
-                ],
-            },
         },
     ),
 }

crates/compiler/test_syntax/tests/snapshots/pass/nonempty_package_header.header.roc

@@ -1,3 +1,3 @@
-package "foo/barbaz"
+package [Foo, Bar] {
-    exposes [Foo, Bar]
+    foo: "./foo"
-    packages { foo: "./foo" }
+}

crates/compiler/test_syntax/tests/test_fmt.rs

@@ -4840,6 +4840,28 @@ mod test_fmt {
         );
     }
 
+    #[test]
+    fn old_style_package_header_is_upgraded() {
+        module_formats_to(
+            indoc!(
+                "
+                package \"csv\"
+                    exposes [Csv]
+                    packages {
+                        parser: \"parser/main.roc\"
+                    }
+                "
+            ),
+            indoc!(
+                "
+                package [Csv] {
+                    parser: \"parser/main.roc\",
+                }
+                "
+            ),
+        );
+    }
+
     #[test]
     fn single_line_app() {
         module_formats_same(indoc!(

crates/language_server/src/analysis/tokens.rs

@@ -244,15 +244,14 @@ impl IterTokens for AppHeader<'_> {
 impl IterTokens for PackageHeader<'_> {
     fn iter_tokens<'a>(&self, arena: &'a Bump) -> BumpVec<'a, Loc<Token>> {
         let Self {
-            before_name: _,
+            before_exposes: _,
-            name,
             exposes,
+            before_packages: _,
             packages,
         } = self;
 
-        (name.iter_tokens(arena).into_iter())
+        (exposes.iter_tokens(arena).into_iter())
-            .chain(exposes.item.iter_tokens(arena))
+            .chain(packages.value.iter_tokens(arena))
-            .chain(packages.item.iter_tokens(arena))
             .collect_in(arena)
     }
 }