diff options
| author | Kevin Newton <[email protected]> | 2024-01-19 11:12:12 -0500 |
|---|---|---|
| committer | git <[email protected]> | 2024-01-19 16:12:25 +0000 |
| commit | da521fc92c19465547f5760870df65731d1a12ca (patch) | |
| tree | 1672750e66da70aaf0fe7a032b5a4d9cc230a53a | |
| parent | 3c9290173a1421b0624a6d62c0844c778dbc61ad (diff) | |
[ruby/prism] Parsing rules document
https://github.com/ruby/prism/commit/57a9575543
| -rw-r--r-- | lib/prism/prism.gemspec | 2 | ||||
| -rw-r--r-- | prism/config.yml | 54 |
2 files changed, 28 insertions, 28 deletions
diff --git a/lib/prism/prism.gemspec b/lib/prism/prism.gemspec index 7ea2f8d4e7..f04aa253b6 100644 --- a/lib/prism/prism.gemspec +++ b/lib/prism/prism.gemspec @@ -29,9 +29,9 @@ Gem::Specification.new do |spec| "docs/fuzzing.md", "docs/heredocs.md", "docs/javascript.md", - "docs/lexing.md", "docs/local_variable_depth.md", "docs/mapping.md", + "docs/parsing_rules.md", "docs/releasing.md", "docs/ripper.md", "docs/ruby_api.md", diff --git a/prism/config.yml b/prism/config.yml index 26f96326f7..96fac67735 100644 --- a/prism/config.yml +++ b/prism/config.yml @@ -1044,10 +1044,8 @@ nodes: - name: name type: constant comment: | - The name of the class variable, including the leading `@@`. - - For more information on permitted class variable names, see - [the Prism documentation](https://github.com/ruby/prism/blob/main/docs/lexing.md). + The name of the class variable, which is a `@@` followed by an + [identifier](https://github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers). @@abc # name `:@@abc` @@ -1223,10 +1221,7 @@ nodes: - name: name type: constant comment: | - The name of the constant. - - For more information on permitted constant names, see - [the Prism documentation](https://github.com/ruby/prism/blob/main/docs/lexing.md). + The name of the [constant](https://github.com/ruby/prism/blob/main/docs/parsing_rules.md#constants). X # name `:X` @@ -1520,10 +1515,10 @@ nodes: - name: name type: constant comment: | - The name of the global variable, including the leading `$`. - - For more information on permitted global variable names, see - [the Prism documentation](https://github.com/ruby/prism/blob/main/docs/lexing.md). + The name of the global variable, which is a `$` followed by an + [identifier](https://github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifier). + Alternatively, it can be one of the special global variables designated + by a symbol. $foo # name `:$foo` @@ -1849,10 +1844,8 @@ nodes: - name: name type: constant comment: | - The name of the instance variable, including the leading `@`. - - For more information on permitted instance variable names, see - [the Prism documentation](https://github.com/ruby/prism/blob/main/docs/lexing.md). + The name of the instance variable, which is a `@` followed by an + [identifier](https://github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers). @x # name `:@x` @@ -2082,19 +2075,29 @@ nodes: - name: name type: constant comment: | - The name of the local variable. - - For more information on permitted local variable names, see - [the Prism documentation](https://github.com/ruby/prism/blob/main/docs/lexing.md). + The name of the local variable, which is an + [identifier](https://github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers). x # name `:x` _Test # name `:_Test` + + Note that this can also be an underscore followed by a number for the + default block parameters. + + _1 # name `:_1` + + Finally, for the default `it` block parameter, the name is `0it`. This + is to distinguish it from an `it` local variable that is explicitly + declared. + + it # name `:0it` + - name: depth type: uint32 comment: | - The number of visible scopes searched up to find the declaration of - this local variable. + The number of visible scopes that should be searched to find the + origin of this local variable. foo = 1; foo # depth 0 @@ -2102,14 +2105,11 @@ nodes: The specific rules for calculating the depth may differ from individual Ruby implementations, as they are not specified by the - language. - - For more information, see [the Prism documentation](https://github.com/ruby/prism/blob/main/docs/local_variable_depth.md). + language. For more information, see [the Prism documentation](https://github.com/ruby/prism/blob/main/docs/local_variable_depth.md). comment: | Represents reading a local variable. Note that this requires that a local variable of the same name has already been written to in the same scope, - otherwise it is parsed as a method call. Note that `it` default parameter - has `0it` as the name of this node. + otherwise it is parsed as a method call. foo ^^^ |