Merge pull request #546 from DanielXMoore/ts-readonly

Fix readonly support in interfaces
DanielXMoore · Jun 4, 2023 · 2cc4a0b · 2cc4a0b
2 parents 8a7e35d + 1bf9ea1
commit 2cc4a0b
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 5 deletions.
diff --git a/source/parser.hera b/source/parser.hera
@@ -680,7 +680,7 @@ ClassSignatureElement
   Static ClassSignatureBody
 
 AccessModifier
-  ( ( Public / Private / Protected ) __ )? ( Readonly __ )? ->
+  ( ( Public / Private / Protected ) NotDedented )? ( Readonly NotDedented )? ->
     if (!($1 || $2)) return $skip
 
     return {
@@ -5617,7 +5617,7 @@ InterfaceProperty
   MethodSignature InterfacePropertyDelimiter
 
 BasicInterfaceProperty
-  ( TypeIndexSignature / PropertyName ) TypeSuffix InterfacePropertyDelimiter
+  ( TypeIndexSignature / TypeProperty ) _? TypeSuffix InterfacePropertyDelimiter
 
 InterfacePropertyDelimiter
   _? ( Semicolon / Comma )
@@ -5750,8 +5750,12 @@ EnumProperty
       children: $0,
     }
 
+TypeProperty
+  ( Readonly NotDedented )? PropertyName
+
 TypeIndexSignature
-  ( [+-]? "readonly" __ )? OpenBracket TypeIndex CloseBracket ( __ [+-] QuestionMark )?
+  # NOTE: QuestionMark will be parsed by following TypeSuffix
+  ( [+-]? Readonly NotDedented )? OpenBracket TypeIndex CloseBracket ( __ [+-] &( _? QuestionMark ) )?
 
 TypeIndex
   __ Identifier TypeSuffix
@@ -5926,7 +5930,9 @@ InlineInterfaceLiteral
   InsertInlineOpenBrace InlineBasicInterfaceProperty ( ( IndentedFurther / _? ) InlineBasicInterfaceProperty )* InsertCloseBrace
 
 InlineBasicInterfaceProperty
-  ( TypeIndexSignature / PropertyName ) QuestionMark? Colon Type InlineInterfacePropertyDelimiter
+  # NOTE: Not using TypeSuffix here to require a Colon, and to forbid spaces
+  # before the colon (to enable conditional types like prop ? T1 : T2).
+  ( TypeIndexSignature / TypeProperty ) QuestionMark? Colon Type InlineInterfacePropertyDelimiter
 
 InlineInterfacePropertyDelimiter
   ( _? Semicolon ) / CommaDelimiter

diff --git a/test/types/interface.civet b/test/types/interface.civet
@@ -128,6 +128,34 @@ describe "[TS] interface", ->
     }
   """
 
+  testCase """
+    spaces
+    ---
+    interface ParseResult<T>
+      loc   : Loc
+      pos ? : number
+      value:T
+    ---
+    interface ParseResult<T> {
+      loc   : Loc
+      pos ? : number
+      value:T
+    }
+  """
+
+  testCase """
+    readonly
+    ---
+    interface Point
+      readonly x: number
+      readonly y?: number
+    ---
+    interface Point {
+      readonly x: number
+      readonly y?: number
+    }
+  """
+
   testCase """
     callable
     ---

diff --git a/test/types/type-declaration.civet b/test/types/type-declaration.civet
@@ -1,4 +1,4 @@
-{testCase} from ../helper.civet
+{testCase, throws} from ../helper.civet
 
 describe "[TS] type declaration", ->
   testCase """
@@ -239,6 +239,22 @@ describe "[TS] type declaration", ->
     }
   """
 
+  throws """
+    mapped type modifiers need to modify something
+    ---
+    type OptionsFlags<Type> = {
+      -readonly [Property in keyof Type]-: boolean
+    }
+  """
+
+  throws """
+    mapped type modifiers need to modify something
+    ---
+    type OptionsFlags<Type> = {
+      -[Property in keyof Type]-?: boolean
+    }
+  """
+
   testCase """
     remapped type
     ---