support for first class modules

Author: aspeddro

grammar.js

@@ -166,7 +166,7 @@ module.exports = grammar({
       'module',
       optional('rec'),
       optional('type'),
-      field('name', $.module_identifier),
+      field('name', choice($.module_identifier, $._type_identifier)),
       optional(seq(
         ':',
         field('signature', choice($.block, $.module_expression, $.functor)),
@@ -182,8 +182,11 @@ module.exports = grammar({
       $.module_expression,
       $.functor,
       $.extension_expression,
+      $.module_unpack,
     ),
 
+    module_unpack: $ => seq('unpack', $.call_arguments),
+
     functor: $ => seq(
       field('parameters', $.functor_parameters),
       optional(field('return_module_type', $.module_type_annotation)),
@@ -276,6 +279,17 @@ module.exports = grammar({
       $.object_type,
       $.generic_type,
       $.unit_type,
+      $.module_type,
+    ),
+
+    module_type: $ => seq(
+      'module',
+      '(',
+      choice($.module_identifier, $._type_identifier),
+      optional(
+        seq('with', sep1('and', seq('type', $._type_identifier, '=', $._type_identifier)))
+      ),
+      ')'
     ),
 
     tuple_type: $ => prec.dynamic(-1, seq(
@@ -428,6 +442,7 @@ module.exports = grammar({
       $.record_pattern,
       $.array_pattern,
       $.list_pattern,
+      $.module_unpack_pattern,
       $.unit
     ),
 
@@ -474,7 +489,7 @@ module.exports = grammar({
       $.pipe_expression,
       $.subscript_expression,
       $.member_expression,
-      $.module_destructuring_expression,
+      $.module_pack_expression,
       $.extension_expression,
     ),
 
@@ -700,8 +715,17 @@ module.exports = grammar({
       ),
     )),
 
-    module_destructuring_expression: $ => seq(
-      'module', '(', choice($.module_identifier, $.module_identifier_path), ')'
+    module_pack_expression: $ => seq(
+      'module', '(',
+      choice(
+        seq(
+          field('name', choice($.module_identifier, $.module_identifier_path)),
+          optional(field('signature', seq(':', $.module_identifier))),
+          optional(field('definition', seq('(', $.module_unpack, ')')))
+        ),
+        seq(field('definition', $.block), ':', field('signature', $.module_identifier))
+      ),
+      ')'
     ),
 
     call_arguments: $ => seq(
@@ -770,7 +794,7 @@ module.exports = grammar({
 
     type_parameter: $ => seq(
       'type',
-      $.type_identifier,
+      repeat($.type_identifier),
     ),
 
     _labeled_parameter_default_value: $ => seq(
@@ -884,6 +908,10 @@ module.exports = grammar({
       choice($.value_identifier, $.list_pattern, $.array_pattern),
     ),
 
+    module_unpack_pattern: $ => seq(
+      'module', '(', $.module_identifier, ')',
+    ),
+
     _jsx_element: $ => choice($.jsx_element, $.jsx_self_closing_element),
 
     jsx_element: $ => seq(

queries/highlights.scm

@@ -75,6 +75,8 @@
 
 (function parameter: (value_identifier) @parameter)
 
+("unpack") @function.builtin
+
 ; Meta
 ;-----
 

test/corpus/let_bindings.txt

@@ -247,3 +247,55 @@ let test = (. ~attr) => ()
           (labeled_parameter
             (value_identifier))))
       (unit))))
+
+===========================================
+Destructuring module
+===========================================
+
+
+let {foo, bar} = module(User)
+let {baz, _} = module(User.Inner)
+
+---
+
+(source_file
+  (let_binding
+    (record_pattern
+      (value_identifier)
+      (value_identifier))
+    (module_pack_expression (module_identifier)))
+
+  (let_binding
+    (record_pattern
+      (value_identifier)
+      (value_identifier))
+    (module_pack_expression
+      (module_identifier_path
+        (module_identifier)
+        (module_identifier)))))
+
+===========================================
+Packing module
+===========================================
+
+let foo = module(Bar)
+
+---
+
+(source_file
+  (let_binding
+    (value_identifier)
+    (module_pack_expression (module_identifier))))
+
+===========================================
+Unpacking module
+===========================================
+
+let module(Bar) = foo
+
+---
+
+(source_file
+  (let_binding
+    (module_unpack_pattern (module_identifier))
+    (value_identifier)))

test/corpus/modules.txt

@@ -12,32 +12,6 @@ open! Foo.Bar
   (open_statement
     (module_identifier_path (module_identifier) (module_identifier))))
 
-===========================================
-Module destructuring
-===========================================
-
-
-let {foo, bar} = module(User)
-let {baz, _} = module(User.Inner)
-
----
-
-(source_file
-  (let_binding
-    (record_pattern
-      (value_identifier)
-      (value_identifier))
-    (module_destructuring_expression (module_identifier)))
-
-  (let_binding
-    (record_pattern
-      (value_identifier)
-      (value_identifier))
-    (module_destructuring_expression
-      (module_identifier_path
-        (module_identifier)
-        (module_identifier)))))
-
 ===========================================
 Include
 ===========================================
@@ -156,6 +130,7 @@ Module types
 
 module type S1 = { type t }
 module type S2 = module type of MyModule.Submod
+module type t
 
 ---
 
@@ -165,7 +140,38 @@ module type S2 = module type of MyModule.Submod
     (block (type_declaration (type_identifier))))
   (module_declaration
     (module_identifier)
-    (module_type_of (module_identifier_path (module_identifier) (module_identifier)))))
+    (module_type_of (module_identifier_path (module_identifier) (module_identifier))))
+  (module_declaration (type_identifier)))
+
+===========================================
+First Class module
+===========================================
+
+module(LightTheme)
+module(A: A)
+module(
+  {
+    type t
+    let foo = "Hello"
+  }: X
+)
+
+---
+
+(source_file
+  (expression_statement
+    (module_pack_expression (module_identifier)))
+  (expression_statement
+    (module_pack_expression (module_identifier) (module_identifier)))
+  (expression_statement
+    (module_pack_expression
+      (block
+        (type_declaration (type_identifier))
+        (let_binding
+          (value_identifier)
+          (string (string_fragment))))
+      (module_identifier))))
+
 
 ===========================================
 Functor definition

test/corpus/type_declarations.txt

@@ -136,6 +136,8 @@ type t =
   | @live("t.D") D
   | B(anotherType)
   | C({foo: int, bar: string})
+  | D(module(Foo))
+  | D(module(Bar.t))
 
 ---
 
@@ -156,8 +158,16 @@ type t =
             (record_type_field
               (property_identifier) (type_annotation (type_identifier)))
             (record_type_field
-              (property_identifier) (type_annotation (type_identifier)))
-            ))))))
+              (property_identifier) (type_annotation (type_identifier))))))
+      (variant_declaration
+        (variant_identifier)
+        (variant_parameters
+          (module_type (module_identifier))))
+      (variant_declaration
+        (variant_identifier)
+        (variant_parameters
+          (module_type
+            (type_identifier_path (module_identifier) (type_identifier))))))))
 
 ===========================================
 Annotated variant

test/highlight/modules.res

@@ -22,3 +22,29 @@ module Belt = {
   //                                  ^ keyword
   //                                                                                ^ operator
 }
+
+let a = module(
+//      ^ keyword
+  {
+    type t
+    let hello = "Hello"
+  }: X
+//   ^ namespace
+)
+
+module B = unpack(a)
+//         ^ function.builtin
+
+module type A = {
+  type t = int
+  let value: t
+}
+
+module A: A = {
+  type t = int
+  let value: t = 42
+}
+
+let packedA = module(A: A)
+//                   ^ namespace
+//                      ^ namespace

test/highlight/type_declarations.res

@@ -8,6 +8,8 @@ type rec t =
 //       ^ type
   | Terminal
 //  ^ constant
+  | Component(module(Foo.t))
+//             ^ keyword
 
 type obj = {
   "x": int,