Skip to content

My takeaways from working with this grammar #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 51 additions & 54 deletions grammar.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ module.exports = grammar({
$.expression,
$.primary_expression,
$.pattern,
$.parameter,
],

externals: $ => [
Expand Down Expand Up @@ -123,6 +122,7 @@ module.exports = grammar({
$.import_from_statement,
$.print_statement,
$.assert_statement,
$.assignment,
$.expression_statement,
$.return_statement,
$.delete_statement,
Expand Down Expand Up @@ -215,7 +215,6 @@ module.exports = grammar({
expression_statement: $ => choice(
$.expression,
seq(commaSep1($.expression), optional(',')),
$.assignment,
$.augmented_assignment,
$.yield,
),
Expand Down Expand Up @@ -409,8 +408,14 @@ module.exports = grammar({
optional('async'),
'def',
field('name', $.identifier),
$.function_definition_scope,
),

function_definition_scope: $ => seq(
field('type_parameters', optional($.type_parameter)),
field('parameters', $.parameters),
'(',
field('parameters', optional($.parameters)),
')',
optional(
seq(
'->',
Expand All @@ -422,12 +427,36 @@ module.exports = grammar({
),

parameters: $ => seq(
'(',
optional($._parameters),
')',
commaSep1(choice(
$.parameter,
alias($._lambda_parameter, $.parameter),
$.keyword_separator,
$.positional_separator,
)),
optional(','),
),

lambda_parameters: $ => $._parameters,
parameter: $ => prec(PREC.typed_parameter, seq(
optional(choice('*', '**')),
field('name', $.identifier),
optional(seq(
":",
field('type', $.expression),
)),
optional(seq(
"=",
field('value', $.expression),
)),
)),

_lambda_parameter: $ => seq(
optional(choice('*', '**')),
field('name', $.identifier),
optional(seq(
"=",
field('value', $.expression),
)),
),

list_splat: $ => seq(
'*',
Expand Down Expand Up @@ -470,6 +499,9 @@ module.exports = grammar({
class_definition: $ => seq(
'class',
field('name', $.identifier),
$.class_definition_scope,
),
class_definition_scope: $ => seq(
field('type_parameters', optional($.type_parameter)),
field('superclasses', optional($.argument_list)),
':',
Expand Down Expand Up @@ -545,7 +577,13 @@ module.exports = grammar({
),
)),

dotted_name: $ => prec(1, sep1($.identifier, '.')),
dotted_name: $ => prec(1, seq(
$.identifier,
repeat(seq(
'.',
alias($.identifier, $.member_identifier),
)),
)),

// Match cases

Expand Down Expand Up @@ -573,7 +611,7 @@ module.exports = grammar({
'_',
)),

_as_pattern: $ => seq($.case_pattern, 'as', $.identifier),
_as_pattern: $ => seq($.case_pattern, 'as', field('alias', $.identifier)),

union_pattern: $ => prec.right(seq($._simple_pattern, repeat1(prec.left(seq('|', $._simple_pattern))))),

Expand Down Expand Up @@ -633,28 +671,11 @@ module.exports = grammar({

// Patterns

_parameters: $ => seq(
commaSep1($.parameter),
optional(','),
),

_patterns: $ => seq(
commaSep1($.pattern),
optional(','),
),

parameter: $ => choice(
$.identifier,
$.typed_parameter,
$.default_parameter,
$.typed_default_parameter,
$.list_splat_pattern,
$.tuple_pattern,
$.keyword_separator,
$.positional_separator,
$.dictionary_splat_pattern,
),

pattern: $ => choice(
$.identifier,
$.keyword_identifier,
Expand All @@ -677,20 +698,6 @@ module.exports = grammar({
']',
),

default_parameter: $ => seq(
field('name', choice($.identifier, $.tuple_pattern)),
'=',
field('value', $.expression),
),

typed_default_parameter: $ => prec(PREC.typed_parameter, seq(
field('name', $.identifier),
':',
field('type', $.type),
'=',
field('value', $.expression),
)),

list_splat_pattern: $ => seq(
'*',
choice($.identifier, $.keyword_identifier, $.subscript, $.attribute),
Expand Down Expand Up @@ -832,14 +839,14 @@ module.exports = grammar({

lambda: $ => prec(PREC.lambda, seq(
'lambda',
field('parameters', optional($.lambda_parameters)),
field('parameters', optional($.parameters)),
':',
field('body', $.expression),
)),

lambda_within_for_in_clause: $ => seq(
'lambda',
field('parameters', optional($.lambda_parameters)),
field('parameters', optional($.parameters)),
':',
field('body', $._expression_within_for_in_clause),
),
Expand Down Expand Up @@ -904,7 +911,7 @@ module.exports = grammar({
attribute: $ => prec(PREC.call, seq(
field('object', $.primary_expression),
'.',
field('attribute', $.identifier),
field('attribute', alias($.identifier, $.member_identifier)),
)),

subscript: $ => prec(PREC.call, seq(
Expand Down Expand Up @@ -932,16 +939,6 @@ module.exports = grammar({
)),
)),

typed_parameter: $ => prec(PREC.typed_parameter, seq(
choice(
$.identifier,
$.list_splat_pattern,
$.dictionary_splat_pattern,
),
':',
field('type', $.type),
)),

type: $ => choice(
prec(1, $.expression),
$.splat_type,
Expand All @@ -960,7 +957,7 @@ module.exports = grammar({
)),
union_type: $ => prec.left(seq($.type, '|', $.type)),
constrained_type: $ => prec.right(seq($.type, ':', $.type)),
member_type: $ => seq($.type, '.', $.identifier),
member_type: $ => seq($.type, '.', alias($.identifier, $.member_identifier)),

keyword_argument: $ => seq(
field('name', choice($.identifier, $.keyword_identifier)),
Expand Down
25 changes: 25 additions & 0 deletions queries/locals.scm
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
;; Scopes

[(module)
(class_definition_scope)
(function_definition_scope)
(lambda)] @local.scope

;; Definitions

; TODO: Type parameters, patterns in assignment and match statements

(import_statement (dotted_name . _ @local.definition))
(import_from_statement name: (dotted_name . _ @local.definition))
(aliased_import alias: _ @local.definition)
(class_definition name: _ @local.definition)
(type_alias_statement left: (type . (identifier) @local.definition))
(function_definition name: _ @local.definition)
(parameter name: _ @local.definition)
(as_pattern alias: _ @local.definition)
(named_expression name: (identifier) @local.definition)
(assignment left: (identifier) @local.definition)

;; References

(identifier) @local.reference
Loading