prism 0.30.0 → 1.0.0

data/config.yml

@@ -81,8 +81,10 @@ errors:
   - ESCAPE_INVALID_META_REPEAT
   - ESCAPE_INVALID_UNICODE
   - ESCAPE_INVALID_UNICODE_CM_FLAGS
+  - ESCAPE_INVALID_UNICODE_LIST
   - ESCAPE_INVALID_UNICODE_LITERAL
   - ESCAPE_INVALID_UNICODE_LONG
+  - ESCAPE_INVALID_UNICODE_SHORT
   - ESCAPE_INVALID_UNICODE_TERM
   - EXPECT_ARGUMENT
   - EXPECT_EOL_AFTER_STATEMENT
@@ -208,6 +210,7 @@ errors:
   - PARAMETER_UNEXPECTED_FWD
   - PARAMETER_UNEXPECTED_NO_KW
   - PARAMETER_WILD_LOOSE_COMMA
+  - PATTERN_ARRAY_MULTIPLE_RESTS
   - PATTERN_CAPTURE_DUPLICATE
   - PATTERN_EXPRESSION_AFTER_BRACKET
   - PATTERN_EXPRESSION_AFTER_COMMA
@@ -219,6 +222,7 @@ errors:
   - PATTERN_EXPRESSION_AFTER_PIPE
   - PATTERN_EXPRESSION_AFTER_RANGE
   - PATTERN_EXPRESSION_AFTER_REST
+  - PATTERN_FIND_MISSING_INNER
   - PATTERN_HASH_IMPLICIT
   - PATTERN_HASH_KEY
   - PATTERN_HASH_KEY_DUPLICATE
@@ -261,11 +265,14 @@ errors:
   - TERNARY_COLON
   - TERNARY_EXPRESSION_FALSE
   - TERNARY_EXPRESSION_TRUE
+  - UNARY_DISALLOWED
   - UNARY_RECEIVER
   - UNDEF_ARGUMENT
   - UNEXPECTED_BLOCK_ARGUMENT
   - UNEXPECTED_INDEX_BLOCK
   - UNEXPECTED_INDEX_KEYWORDS
+  - UNEXPECTED_MULTI_WRITE
+  - UNEXPECTED_RANGE_OPERATOR
   - UNEXPECTED_SAFE_NAVIGATION
   - UNEXPECTED_TOKEN_CLOSE_CONTEXT
   - UNEXPECTED_TOKEN_IGNORE
@@ -293,10 +300,11 @@ warnings:
   - DUPLICATED_WHEN_CLAUSE
   - FLOAT_OUT_OF_RANGE
   - IGNORED_FROZEN_STRING_LITERAL
+  - INDENTATION_MISMATCH
   - INTEGER_IN_FLIP_FLOP
   - INVALID_CHARACTER
+  - INVALID_MAGIC_COMMENT_VALUE
   - INVALID_NUMBERED_REFERENCE
-  - INVALID_SHAREABLE_CONSTANT_VALUE
   - KEYWORD_EOL
   - LITERAL_IN_CONDITION_DEFAULT
   - LITERAL_IN_CONDITION_VERBOSE
@@ -643,6 +651,8 @@ flags:
         comment: "if arguments contain keywords"
       - name: CONTAINS_KEYWORD_SPLAT
         comment: "if arguments contain keyword splat"
+      - name: CONTAINS_SPLAT
+        comment: "if arguments contain splat"
     comment: Flags for arguments nodes.
   - name: ArrayNodeFlags
     values:
@@ -730,11 +740,6 @@ flags:
       - name: FORCED_US_ASCII_ENCODING
         comment: "internal bytes forced the encoding to US-ASCII"
     comment: Flags for regular expression and match last line nodes.
-  - name: ReturnNodeFlags
-    values:
-      - name: REDUNDANT
-        comment: "a return statement that is redundant because it is the last statement in a method"
-    comment: Flags for return nodes.
   - name: ShareableConstantNodeFlags
     values:
       - name: LITERAL
@@ -769,15 +774,25 @@ nodes:
     fields:
       - name: new_name
         type: node
+        kind:
+          - GlobalVariableReadNode
+          - BackReferenceReadNode
+          - NumberedReferenceReadNode
         comment: |
-          Represents the new name of the global variable that can be used after aliasing. This can be either a global variable, a back reference, or a numbered reference.
+          Represents the new name of the global variable that can be used after aliasing.
 
               alias $foo $bar
                     ^^^^
       - name: old_name
         type: node
+        kind:
+          - GlobalVariableReadNode
+          - BackReferenceReadNode
+          - NumberedReferenceReadNode
+          - SymbolNode # On parsing error of `alias $a b`
+          - MissingNode # On parsing error of `alias $a 42`
         comment: |
-          Represents the old name of the global variable that could be used before aliasing. This can be either a global variable, a back reference, or a numbered reference.
+          Represents the old name of the global variable that can be used before aliasing.
 
               alias $foo $bar
                          ^^^^
@@ -797,8 +812,16 @@ nodes:
     fields:
       - name: new_name
         type: node
+        kind:
+          - SymbolNode
+          - InterpolatedSymbolNode
       - name: old_name
         type: node
+        kind:
+          - SymbolNode
+          - InterpolatedSymbolNode
+          - GlobalVariableReadNode # On parsing error of `alias a $b`
+          - MissingNode # On parsing error of `alias a 42`
       - name: keyword_loc
         type: location
     comment: |
@@ -854,10 +877,8 @@ nodes:
           left and right
           ^^^^^^^^^^^^^^
   - name: ArgumentsNode
+    flags: ArgumentsNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: ArgumentsNodeFlags
       - name: arguments
         type: node[]
     comment: |
@@ -866,10 +887,8 @@ nodes:
           return foo, bar, baz
                  ^^^^^^^^^^^^^
   - name: ArrayNode
+    flags: ArrayNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: ArrayNodeFlags
       - name: elements
         type: node[]
         comment: Represent the list of zero or more [non-void expressions](https://github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression) within the array.
@@ -1033,15 +1052,13 @@ nodes:
       - name: operator_loc
         type: location
     comment: |
-      Represents block method arguments.
+      Represents a block argument using `&`.
 
           bar(&args)
           ^^^^^^^^^^
   - name: BlockLocalVariableNode
+    flags: ParameterFlags
     fields:
-      - name: flags
-        type: flags
-        kind: ParameterFlags
       - name: name
         type: constant
     comment: |
@@ -1055,8 +1072,15 @@ nodes:
         type: constant[]
       - name: parameters
         type: node?
+        kind:
+          - BlockParametersNode
+          - NumberedParametersNode
+          - ItParametersNode
       - name: body
         type: node?
+        kind:
+          - StatementsNode
+          - BeginNode
       - name: opening_loc
         type: location
       - name: closing_loc
@@ -1067,10 +1091,8 @@ nodes:
           [1, 2, 3].each { |i| puts x }
                          ^^^^^^^^^^^^^^
   - name: BlockParameterNode
+    flags: ParameterFlags
     fields:
-      - name: flags
-        type: flags
-        kind: ParameterFlags
       - name: name
         type: constant?
       - name: name_loc
@@ -1078,7 +1100,7 @@ nodes:
       - name: operator_loc
         type: location
     comment: |
-      Represents a block parameter to a method, block, or lambda definition.
+      Represents a block parameter of a method, block, or lambda definition.
 
           def a(&b)
                 ^^
@@ -1127,10 +1149,8 @@ nodes:
           break foo
           ^^^^^^^^^
   - name: CallAndWriteNode
+    flags: CallNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: CallNodeFlags
       - name: receiver
         type: node?
       - name: call_operator_loc
@@ -1151,10 +1171,8 @@ nodes:
           foo.bar &&= value
           ^^^^^^^^^^^^^^^^^
   - name: CallNode
+    flags: CallNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: CallNodeFlags
       - name: receiver
         type: node?
         comment: |
@@ -1204,10 +1222,8 @@ nodes:
           foo&.bar
           ^^^^^^^^
   - name: CallOperatorWriteNode
+    flags: CallNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: CallNodeFlags
       - name: receiver
         type: node?
       - name: call_operator_loc
@@ -1230,10 +1246,8 @@ nodes:
           foo.bar += baz
           ^^^^^^^^^^^^^^
   - name: CallOrWriteNode
+    flags: CallNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: CallNodeFlags
       - name: receiver
         type: node?
       - name: call_operator_loc
@@ -1254,10 +1268,8 @@ nodes:
           foo.bar ||= value
           ^^^^^^^^^^^^^^^^^
   - name: CallTargetNode
+    flags: CallNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: CallNodeFlags
       - name: receiver
         type: node
       - name: call_operator_loc
@@ -1298,7 +1310,7 @@ nodes:
         type: node?
       - name: conditions
         type: node[]
-      - name: consequent
+      - name: else_clause
         type: node?
         kind: ElseNode
       - name: case_keyword_loc
@@ -1318,7 +1330,7 @@ nodes:
         type: node?
       - name: conditions
         type: node[]
-      - name: consequent
+      - name: else_clause
         type: node?
         kind: ElseNode
       - name: case_keyword_loc
@@ -1852,10 +1864,8 @@ nodes:
           foo in Foo(*bar, baz, *qux)
                  ^^^^^^^^^^^^^^^^^^^^
   - name: FlipFlopNode
+    flags: RangeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: RangeFlags
       - name: left
         type: node?
       - name: right
@@ -2177,8 +2187,11 @@ nodes:
                 baz
                 ^^^
               end
-      - name: consequent
+      - name: subsequent
         type: node?
+        kind:
+          - ElseNode
+          - IfNode
         comment: |
           Represents an `ElseNode` or an `IfNode` when there is an `else` or an `elsif` in the `if` statement.
 
@@ -2274,10 +2287,8 @@ nodes:
           case a; in b then c end
                   ^^^^^^^^^^^
   - name: IndexAndWriteNode
+    flags: CallNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: CallNodeFlags
       - name: receiver
         type: node?
       - name: call_operator_loc
@@ -2301,10 +2312,8 @@ nodes:
           foo.bar[baz] &&= value
           ^^^^^^^^^^^^^^^^^^^^^^
   - name: IndexOperatorWriteNode
+    flags: CallNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: CallNodeFlags
       - name: receiver
         type: node?
       - name: call_operator_loc
@@ -2330,10 +2339,8 @@ nodes:
           foo.bar[baz] += value
           ^^^^^^^^^^^^^^^^^^^^^
   - name: IndexOrWriteNode
+    flags: CallNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: CallNodeFlags
       - name: receiver
         type: node?
       - name: call_operator_loc
@@ -2357,10 +2364,8 @@ nodes:
           foo.bar[baz] ||= value
           ^^^^^^^^^^^^^^^^^^^^^^
   - name: IndexTargetNode
+    flags: CallNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: CallNodeFlags
       - name: receiver
         type: node
       - name: opening_loc
@@ -2496,10 +2501,8 @@ nodes:
           @foo = 1
           ^^^^^^^^
   - name: IntegerNode
+    flags: IntegerBaseFlags
     fields:
-      - name: flags
-        type: flags
-        kind: IntegerBaseFlags
       - name: value
         type: integer
         comment: The value of the integer literal as a number.
@@ -2509,10 +2512,8 @@ nodes:
           1
           ^
   - name: InterpolatedMatchLastLineNode
+    flags: RegularExpressionFlags
     fields:
-      - name: flags
-        type: flags
-        kind: RegularExpressionFlags
       - name: opening_loc
         type: location
       - name: parts
@@ -2530,10 +2531,8 @@ nodes:
           if /foo #{bar} baz/ then end
              ^^^^^^^^^^^^^^^^
   - name: InterpolatedRegularExpressionNode
+    flags: RegularExpressionFlags
     fields:
-      - name: flags
-        type: flags
-        kind: RegularExpressionFlags
       - name: opening_loc
         type: location
       - name: parts
@@ -2551,10 +2550,8 @@ nodes:
           /foo #{bar} baz/
           ^^^^^^^^^^^^^^^^
   - name: InterpolatedStringNode
+    flags: InterpolatedStringNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: InterpolatedStringNodeFlags
       - name: opening_loc
         type: location?
       - name: parts
@@ -2621,10 +2618,8 @@ nodes:
           -> { it + it }
           ^^^^^^^^^^^^^^
   - name: KeywordHashNode
+    flags: KeywordHashNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: KeywordHashNodeFlags
       - name: elements
         type: node[]
         kind:
@@ -2636,10 +2631,8 @@ nodes:
           foo(a: b)
               ^^^^
   - name: KeywordRestParameterNode
+    flags: ParameterFlags
     fields:
-      - name: flags
-        type: flags
-        kind: ParameterFlags
       - name: name
         type: constant?
       - name: name_loc
@@ -2819,10 +2812,8 @@ nodes:
           foo = 1
           ^^^^^^^
   - name: MatchLastLineNode
+    flags: RegularExpressionFlags
     fields:
-      - name: flags
-        type: flags
-        kind: RegularExpressionFlags
       - name: opening_loc
         type: location
       - name: content_loc
@@ -2914,8 +2905,36 @@ nodes:
           - RequiredParameterNode
           - BackReferenceReadNode # On parsing error of `$',`
           - NumberedReferenceReadNode # On parsing error of `$1,`
+        comment: |
+          Represents the targets expressions before a splat node.
+
+              a, (b, c, *) = 1, 2, 3, 4, 5
+                  ^^^^
+
+          The splat node can be absent, in that case all target expressions are in the left field.
+
+              a, (b, c) = 1, 2, 3, 4, 5
+                  ^^^^
       - name: rest
         type: node?
+        kind:
+          - ImplicitRestNode
+          - SplatNode
+        comment: |
+          Represents a splat node in the target expression.
+
+              a, (b, *c) = 1, 2, 3, 4
+                     ^^
+
+          The variable can be empty, this results in a `SplatNode` with a `nil` expression field.
+
+              a, (b, *) = 1, 2, 3, 4
+                     ^
+
+          If the `*` is omitted, the field will containt an `ImplicitRestNode`
+
+              a, (b,) = 1, 2, 3, 4
+                   ^
       - name: rights
         type: node[]
         kind:
@@ -2930,15 +2949,35 @@ nodes:
           - MultiTargetNode
           - RequiredParameterNode
           - BackReferenceReadNode # On parsing error of `*,$'`
+        comment: |
+          Represents the targets expressions after a splat node.
+
+              a, (*, b, c) = 1, 2, 3, 4, 5
+                     ^^^^
       - name: lparen_loc
         type: location?
+        comment: |
+          The location of the opening parenthesis.
+
+              a, (b, c) = 1, 2, 3
+                 ^
       - name: rparen_loc
         type: location?
+        comment: |
+          The location of the closing parenthesis.
+
+              a, (b, c) = 1, 2, 3
+                      ^
     comment: |
       Represents a multi-target expression.
 
           a, (b, c) = 1, 2, 3
              ^^^^^^
+
+      This can be a part of `MultiWriteNode` as above, or the target of a `for` loop
+
+          for a, b in [[1, 2], [3, 4]]
+              ^^^^
   - name: MultiWriteNode
     fields:
       - name: lefts
@@ -2953,8 +2992,36 @@ nodes:
           - CallTargetNode
           - IndexTargetNode
           - MultiTargetNode
+        comment: |
+          Represents the targets expressions before a splat node.
+
+              a, b, * = 1, 2, 3, 4, 5
+              ^^^^
+
+          The splat node can be absent, in that case all target expressions are in the left field.
+
+              a, b, c = 1, 2, 3, 4, 5
+              ^^^^^^^
       - name: rest
         type: node?
+        kind:
+          - ImplicitRestNode
+          - SplatNode
+        comment: |
+          Represents a splat node in the target expression.
+
+              a, b, *c = 1, 2, 3, 4
+                    ^^
+
+          The variable can be empty, this results in a `SplatNode` with a `nil` expression field.
+
+              a, b, * = 1, 2, 3, 4
+                    ^
+
+          If the `*` is omitted, the field will containt an `ImplicitRestNode`
+
+              a, b, = 1, 2, 3, 4
+                  ^
       - name: rights
         type: node[]
         kind:
@@ -2967,14 +3034,39 @@ nodes:
           - CallTargetNode
           - IndexTargetNode
           - MultiTargetNode
+        comment: |
+          Represents the targets expressions after a splat node.
+
+              a, *, b, c = 1, 2, 3, 4, 5
+                    ^^^^
       - name: lparen_loc
         type: location?
+        comment: |
+          The location of the opening parenthesis.
+
+              (a, b, c) = 1, 2, 3
+              ^
       - name: rparen_loc
         type: location?
+        comment: |
+          The location of the closing parenthesis.
+
+              (a, b, c) = 1, 2, 3
+                      ^
       - name: operator_loc
         type: location
+        comment: |
+          The location of the operator.
+
+              a, b, c = 1, 2, 3
+                      ^
       - name: value
         type: node
+        comment: |
+          The value to write to the targets. It can be any [non-void expression](https://github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).
+
+              a, b, c = 1, 2, 3
+                        ^^^^^^^
     comment: |
       Represents a write to a multi-target expression.
 
@@ -3037,10 +3129,8 @@ nodes:
           $1
           ^^
   - name: OptionalKeywordParameterNode
+    flags: ParameterFlags
     fields:
-      - name: flags
-        type: flags
-        kind: ParameterFlags
       - name: name
         type: constant
       - name: name_loc
@@ -3054,10 +3144,8 @@ nodes:
                 ^^^^
           end
   - name: OptionalParameterNode
+    flags: ParameterFlags
     fields:
-      - name: flags
-        type: flags
-        kind: ParameterFlags
       - name: name
         type: constant
       - name: name_loc
@@ -3232,10 +3320,8 @@ nodes:
         kind: StatementsNode
     comment: The top level node of any parse tree.
   - name: RangeNode
+    flags: RangeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: RangeFlags
       - name: left
         type: node?
         comment: |
@@ -3270,10 +3356,8 @@ nodes:
           c if a =~ /left/ ... b =~ /right/
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   - name: RationalNode
+    flags: IntegerBaseFlags
     fields:
-      - name: flags
-        type: flags
-        kind: IntegerBaseFlags
       - name: numerator
         type: integer
         comment: |
@@ -3298,10 +3382,8 @@ nodes:
           redo
           ^^^^
   - name: RegularExpressionNode
+    flags: RegularExpressionFlags
     fields:
-      - name: flags
-        type: flags
-        kind: RegularExpressionFlags
       - name: opening_loc
         type: location
       - name: content_loc
@@ -3316,10 +3398,8 @@ nodes:
           /foo/i
           ^^^^^^
   - name: RequiredKeywordParameterNode
+    flags: ParameterFlags
     fields:
-      - name: flags
-        type: flags
-        kind: ParameterFlags
       - name: name
         type: constant
       - name: name_loc
@@ -3331,10 +3411,8 @@ nodes:
                 ^^
           end
   - name: RequiredParameterNode
+    flags: ParameterFlags
     fields:
-      - name: flags
-        type: flags
-        kind: ParameterFlags
       - name: name
         type: constant
     comment: |
@@ -3370,7 +3448,7 @@ nodes:
       - name: statements
         type: node?
         kind: StatementsNode
-      - name: consequent
+      - name: subsequent
         type: node?
         kind: RescueNode
     comment: |
@@ -3384,10 +3462,8 @@ nodes:
 
       `Foo, *splat, Bar` are in the `exceptions` field. `ex` is in the `exception` field.
   - name: RestParameterNode
+    flags: ParameterFlags
     fields:
-      - name: flags
-        type: flags
-        kind: ParameterFlags
       - name: name
         type: constant?
       - name: name_loc
@@ -3408,9 +3484,6 @@ nodes:
           ^^^^^
   - name: ReturnNode
     fields:
-      - name: flags
-        type: flags
-        kind: ReturnNodeFlags
       - name: keyword_loc
         type: location
       - name: arguments
@@ -3428,10 +3501,8 @@ nodes:
           self
           ^^^^
   - name: ShareableConstantNode
+    flags: ShareableConstantNodeFlags
     fields:
-      - name: flags
-        type: flags
-        kind: ShareableConstantNodeFlags
       - name: write
         type: node
         kind:
@@ -3476,10 +3547,8 @@ nodes:
           __ENCODING__
           ^^^^^^^^^^^^
   - name: SourceFileNode
+    flags: StringFlags
     fields:
-      - name: flags
-        type: flags
-        kind: StringFlags
       - name: filepath
         type: string
         comment: Represents the file path being parsed. This corresponds directly to the `filepath` option given to the various `Prism::parse*` APIs.
@@ -3515,10 +3584,8 @@ nodes:
           foo; bar; baz
           ^^^^^^^^^^^^^
   - name: StringNode
+    flags: StringFlags
     fields:
-      - name: flags
-        type: flags
-        kind: StringFlags
       - name: opening_loc
         type: location?
       - name: content_loc
@@ -3560,10 +3627,8 @@ nodes:
           super foo, bar
           ^^^^^^^^^^^^^^
   - name: SymbolNode
+    flags: SymbolFlags
     fields:
-      - name: flags
-        type: flags
-        kind: SymbolFlags
       - name: opening_loc
         type: location?
       - name: value_loc
@@ -3638,7 +3703,7 @@ nodes:
 
               unless cond then bar end
                                ^^^
-      - name: consequent
+      - name: else_clause
         type: node?
         kind: ElseNode
         comment: |
@@ -3663,10 +3728,8 @@ nodes:
           unless foo then bar end
           ^^^^^^^^^^^^^^^^^^^^^^^
   - name: UntilNode
+    flags: LoopFlags
     fields:
-      - name: flags
-        type: flags
-        kind: LoopFlags
       - name: keyword_loc
         type: location
       - name: closing_loc
@@ -3704,10 +3767,8 @@ nodes:
           ^^^^^^^^^
           end
   - name: WhileNode
+    flags: LoopFlags
     fields:
-      - name: flags
-        type: flags
-        kind: LoopFlags
       - name: keyword_loc
         type: location
       - name: closing_loc
@@ -3727,10 +3788,8 @@ nodes:
           while foo do bar end
           ^^^^^^^^^^^^^^^^^^^^
   - name: XStringNode
+    flags: EncodingFlags
     fields:
-      - name: flags
-        type: flags
-        kind: EncodingFlags
       - name: opening_loc
         type: location
       - name: content_loc