Skip to content

update sshd config grammar so quotedString node is not hidden #1281

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.

Sign up for GitHub

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 2 commits into
base: main
Choose a base branch
from
+17 −11
Open

update sshd config grammar so quotedString node is not hidden #1281

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2a7ca6
update grammar so quotedString node is not hidden
tgauth Nov 20, 2025
d2c697d
fix test
tgauth Nov 21, 2025
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
4 changes: 2 additions & 2 deletions grammars/tree-sitter-ssh-server-config/grammar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module.exports = grammar({
repeat1(choice($.comment, $.keyword)),
),

arguments: $ => repeat1(choice($.boolean, $.number, $._quotedString, $._commaSeparatedString)),
arguments: $ => repeat1(choice($.boolean, $.number, $.quotedString, $._commaSeparatedString)),

alphanumeric: $ => /[a-zA-Z0-9]+/i,
boolean: $ => choice('yes', 'no'),
Expand All @@ -43,7 +43,7 @@ module.exports = grammar({
string: $ => /[^\r\n,"]+/,

_commaSeparatedString: $ => seq($.string, repeat(seq(',', $.string))),
_quotedString: $ => seq('\"', $.string, '\"'),
quotedString: $ => seq('\"', $.string, '\"'),
Copy link
Member

@SteveL-MSFT SteveL-MSFT Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the parser, you don't care if it's quoted or not, but simply the result is the contents between the quotes (if provided), right? Can't you define a string as a choice between quoted and not quoted where the quoted is just the contents between the quotes?

Copy link
Collaborator Author

@tgauth tgauth Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The full scenario the Rust parser is running into:

The existing parser has a test for:
allowgroups group1 "group with spaces"

However, the existing parser would parse this scenario:
allowgroups group1 group2

as a single string, "group1 group2" instead of "group1" and "group2"

To support both, I plan to update the Rust parser to be able to split "string" nodes by spaces but not "quoted string nodes"

It may be easier to consolidate the grammar and parser changes because this has broken the parser anyway

Copy link
Collaborator Author

@tgauth tgauth Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

another option would probably be to update the grammar to not declare space in extras but that may have broader impact

Copy link
Member

@SteveL-MSFT SteveL-MSFT Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think space in extras is fine to allow arbitrary whitespace, but the Rust parsing code should just handle the tokens returned by the grammar and not have to worry about the enclosing quotes and just the contents which can contain whitespace. I think this should be possible by defining as (pseudo-grammar):

[keyword] [parameter]+

where [parameter] is choice([string], [number], [yes/no], etc...) and [string] is either a bareString or quotedString, but the parser just gets it as a string.

}

});
18 changes: 12 additions & 6 deletions grammars/tree-sitter-ssh-server-config/test/corpus/valid_expressions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ authorizedKEYSfile "path to authorized keys file"
(keyword
(alphanumeric)
(arguments
(string))))
(quotedString
(string)))))
=====
comment
=====
Expand All @@ -36,7 +37,8 @@ authorizedkeysfile "path to authorized keys file"
(keyword
(alphanumeric)
(arguments
(string)))))
(quotedString
(string))))))
=====
boolean and match
=====
Expand All @@ -59,7 +61,8 @@ authorizedkeysfile "path to authorized keys file"
(keyword
(alphanumeric)
(arguments
(string)))))
(quotedString
(string))))))
=====
directive with = operator
=====
Expand Down Expand Up @@ -108,7 +111,8 @@ AllowGroups group1 "group two"
(alphanumeric)
(arguments
(string)
(string))))
(quotedString
(string)))))
=====
directive with comma-separated arguments
=====
Expand Down Expand Up @@ -316,7 +320,8 @@ passwordauthentication yes
(alphanumeric)
(arguments
(string)
(string))))
(quotedString
(string)))))
(match
(keyword
(alphanumeric)
Expand Down Expand Up @@ -367,4 +372,5 @@ allowgroups administrators "openssh users"
(alphanumeric)
(arguments
(string)
(string))))
(quotedString
(string)))))
Loading