Make IDL commas whitespace and newlines optional #772
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mtdowling
requested review from
JordonPhillips,
kstich and
srchase
as code owners
mtdowling
force-pushed
the
optional-commas-and-brs
branch
from
ef9c1f1 to
29f700f
Compare
JordonPhillips
requested changes
Apr 12, 2021
mtdowling
force-pushed
the
optional-commas-and-brs
branch
from
29f700f to
7d06e74
Compare
JordonPhillips
approved these changes
Apr 13, 2021
kstich
reviewed
Apr 13, 2021
mtdowling
force-pushed
the
optional-commas-and-brs
branch
from
7d06e74 to
ee5c3c4
Compare
Commas are now treated as whitespace to reduce visual noise in models, reduce diff noise when changes are made to models, and prevent modelers from worrying about tricks like trailing commas. Commas are still allowed because they do make traits and JSON-like node values defined on a single line easier to read; however, they should be omitted everywhere else. The IDL previously required a newline after various statements. This wasn't grammatically necessary, but was done to force good practice in models. However, it added complexity to the grammar and parser. While models should still define all statements on different lines, to simplify parsers and the grammar, a new line after statements is no longer required.
mtdowling
force-pushed
the
optional-commas-and-brs
branch
from
ee5c3c4 to
0eed31b
Compare
kstich
approved these changes
Apr 16, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commas are now treated as whitespace to reduce visual noise in models,
reduce diff noise when changes are made to models, and prevent modelers
from worrying about tricks like trailing commas. Commas are still
allowed because they do make traits and JSON-like node values defined on
a single line easier to read; however, they should be omitted everywhere
else.
The IDL previously required a newline after various statements. This
wasn't grammatically necessary, but was done to force good practice in
models. However, it added complexity to the grammar and parser. While
models should still define all statements on different lines, to simplify
parsers and the grammar, a new line after statements is no longer
required.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.