[Indented syntax improvements] Dart implementation #2467

jamesnw · 2024-12-16T18:55:05Z

Blocked until proposal is accepted.

sass-spec [Indented syntax improvements] Specs sass-spec#2041

[skip sass-embedded]

…d-syntax-improvements

…vidually

…d-syntax-improvements

jamesnw · 2024-12-16T19:23:03Z

@nex3 This is ready for review. Here are some questions I wanted to flag as you review. Thanks!

allowNewlines is set to true in some cases, like in parser* functions or in scss.dart, where the value is non-impactful. Should this usage be differentiated somehow for clarity?
There are some places, like in _atRootQuery, where allowNewlines is true because it is inside parentheses. I opted to not use the _inParentheses variable except for one place where the consumption did rely on it, in _supportsCondition. Would it be more idiomatic to use _inParentheses, even if the consumption is in the same function?
In the + include syntax, I am not supporting whitespace after the + as it can be part of a selector. This differs from the = mixin syntax- should they be the same?
I added paren/bracket context to almostAnyValue, with the only change being that they must be matched. That means the error for a:has(d[)] will be changed from "Expected identifer" to "Expected ]". Since almostAnyValue is used for more than selectors, should I make this functionality opt-in, dependent on a parameter? Based on the places where this is used, I don't foresee issues with bracket matching, but want to verify.

…d-syntax-improvements

nex3

@nex3 This is ready for review. Here are some questions I wanted to flag as you review. Thanks!

allowNewlines is set to true in some cases, like in parser* functions or in scss.dart, where the value is non-impactful. Should this usage be differentiated somehow for clarity?

For classes where it's universally non-impactful, I'd define a local _whitespace() function that takes no arguments with a comment explaining that the value isn't relevant.

There are some places, like in _atRootQuery, where allowNewlines is true because it is inside parentheses. I opted to not use the _inParentheses variable except for one place where the consumption did rely on it, in _supportsCondition. Would it be more idiomatic to use _inParentheses, even if the consumption is in the same function?

I think how it is now is better.

In the + include syntax, I am not supporting whitespace after the + as it can be part of a selector. This differs from the = mixin syntax- should they be the same?

There's already an odd inconsistency here where whitespace is allowed after = but not after +, so I think it's fine to expand that to allowing newlines as well. It's possible that we should deprecate that, but it's not in-scope for this change.

I added paren/bracket context to almostAnyValue, with the only change being that they must be matched. That means the error for a:has(d[)] will be changed from "Expected identifer" to "Expected ]". Since almostAnyValue is used for more than selectors, should I make this functionality opt-in, dependent on a parameter? Based on the places where this is used, I don't foresee issues with bracket matching, but want to verify.

It's fine to change this error. Arguably the bracket error is clearer anyway.

lib/src/parse/keyframe_selector.dart

lib/src/parse/parser.dart

lib/src/parse/sass.dart

nex3 · 2024-12-23T23:31:08Z

lib/src/parse/stylesheet.dart

+          allowNewlines: allowNewlines ||
+              bracketList ||
+              _inParentheses ||
+              wasInExpression);


Why does this trigger on wasInExpression?

In reducing it to a minimal reproduction, this covers newlines after a value in a comma separated list that has a space separated list as a value. (This is a common syntax in grid and font declarations, for instance.)

For instance, this would be covered by wasInParentheses.

$a: (b, e )

However, this would not be covered by wasInParentheses, but is covered by wasInExpression.

$a: (b c, e )

Is there a cleaner way of doing this?

If you pass consumeNewlines: true into expressionUntilComma() in parentheses(), I think that's a much more explicit way of representing the logic that parenthesized lists should allow newlines everywhere. That should allow you to remove the _inParentheses check as well.

lib/src/parse/stylesheet.dart

jamesnw

@nex3 This is ready for another round of review, along with the spec draft 1.2. Thanks!

jamesnw · 2024-12-30T16:35:58Z

lib/src/parse/stylesheet.dart

+          allowNewlines: allowNewlines ||
+              bracketList ||
+              _inParentheses ||
+              wasInExpression);


In reducing it to a minimal reproduction, this covers newlines after a value in a comma separated list that has a space separated list as a value. (This is a common syntax in grid and font declarations, for instance.)

For instance, this would be covered by wasInParentheses.

$a: (b, e )

However, this would not be covered by wasInParentheses, but is covered by wasInExpression.

$a: (b c, e )

Is there a cleaner way of doing this?

jamesnw · 2024-12-30T16:38:32Z

lib/src/parse/stylesheet.dart

@@ -1064,7 +1074,7 @@ abstract class StylesheetParser extends Parser {
  ImportRule _importRule(LineScannerState start) {
    var imports = <Import>[];
    do {
-      whitespace();
+      whitespace(allowNewlines: false);


Can you explain more what needs to be changed? As far as I can tell, allowNewlines is false throughout the import rule.

lib/src/parse/stylesheet.dart

jamesnw · 2025-01-02T15:29:20Z

lib/src/parse/sass.dart

    switch (scanner.peekChar()) {
+      case $semicolon
+          when canEndInSemicolon && [$lf, $ff].contains(scanner.peekChar(1)):


Changed my approach in f093d6a. I'd appreciate feedback on this approach.

Now, in the indented format, a call to expectStatementSeparator() consumes ; // foo before checking if atEndOfStatement(). This deviates from SCSS, which consumes only the semicolon, but we need to move the scanner position to immediately before the newline in order to peekIndentation().

This required some minor tweaks to @debug, for example, so that the scanner range matches SCSS, and doesn't include ; // foo.

lib/src/parse/parser.dart

lib/src/parse/sass.dart

nex3 · 2025-01-02T23:42:20Z

CHANGELOG.md

+## 1.84.0-dev
+
+* Allow newlines in whitespace in the indented syntax.
+* **Potentially breaking bug fix**: Selectors with interpolations that render


I think the term "render" is confusing here, because the issue is that the brackets are unmatched at the source level.

nex3 · 2025-01-02T23:44:39Z

lib/src/parse/parser.dart

    return scanner.scanChar($colon);
  }

  // ## Tokens

  /// Consumes whitespace, including any comments.
+  ///
+  /// If [consumeNewlines] is true, the indented syntax will consume newlines as
+  /// whitespace in positions when a statement can't end.


This is ambiguous between "consumeNewlines: true should only be passed in positions where a statement can't end" and "this function will automatically ignore consumeNewlines: true in positions where a statement can end". Probably worth rephrasing it to be explicit.

nex3 · 2025-01-02T23:46:54Z

lib/src/parse/sass.dart

    // This overrides whitespace consumption so that it doesn't consume
-    // newlines.
+    // newlines where that would cause a statement to end.


Similarly to above, I think it makes more sense to phrase this in terms of the function's interface, so something like "when consumeNewlines is false."

nex3 · 2025-01-02T23:47:22Z

lib/src/parse/sass.dart

@@ -404,6 +394,7 @@ class SassParser extends StylesheetParser {
    }

    var start = scanner.state;
+


nex3 · 2025-01-02T23:48:18Z

lib/src/parse/sass.dart

+  /// Consumes a semicolon and trailing whitespace, including comments.
+  ///
+  /// Returns whether a semicolon was consumed.
+  bool _trailingSemicolon() {


Generally if a production may or may not consume something and returns whether it did, we use a name that starts with "try".

nex3 · 2025-01-03T00:05:00Z

lib/src/parse/stylesheet.dart

+          allowNewlines: allowNewlines ||
+              bracketList ||
+              _inParentheses ||
+              wasInExpression);


If you pass consumeNewlines: true into expressionUntilComma() in parentheses(), I think that's a much more explicit way of representing the logic that parenthesized lists should allow newlines everywhere. That should allow you to remove the _inParentheses check as well.

nex3 · 2025-01-03T00:05:55Z

lib/src/parse/stylesheet.dart

+        case $rparen || $rbracket:
+          if (brackets.isEmpty) {
+            scanner.error(
+                'Unexpected "${String.fromCharCode(scanner.peekChar()!)}".');


Yeah, you can write case ($paren || $rbracket) && var char and it'll bind it to char.

jamesnw added 30 commits November 1, 2024 14:59

Support optional semicolons at the end of indented lines

2c4a054

Merge branch 'main' of https://github.com/sass/dart-sass into indente…

94f8c11

…d-syntax-improvements

Add comment, update error message

4d0e43c

Handle each

dc12326

Allow whitespace in @for, handle initial whitespace for at-rules indi…

332ca09

…vidually

@content, @extend newlines

3715ee4

@input newlines

8594fe5

Whitespace for @mixin, @include

512304b

Whitespace in @media, @-moz-document, @supports

c09e506

Whitespace in @use and @forward

1fa6ccf

Whitespace in @function and @return

9e49c3b

Whitespace in @if

939d2fa

Whitespace in @while

d050c01

Whitespace in @at-root

e8cf0fb

Merge branch 'main' into indented-syntax-improvements

b6c801a

Whitespace in arguments and @charset

0aaa63a

+ and = syntax whitespace

cfa30ee

Whitespace in variable declarations

e6442d4

Move initial whitespace inside each at rule

0d81850

Whitespace in lists and maps

2a3c160

Handle whitespace in important and unaries

65ec459

Whitespace in interpolation, unblock expressionUntilComma issues

7de5da3

Consume whitespace in sub-stylesheet parsers

85d14a9

Merge branch 'main' of https://github.com/sass/dart-sass into indente…

dac97ed

…d-syntax-improvements

Consume whitespace in parse/css. Meaningless, as it extends scss

61304e6

Whitespace in @supports

d7ee188

Whitespace in @media

976e38a

Handle whitespace in arg invocations

a7f439c

Whitespace in parsers

14dbd8d

Allow newlines in comments

c552cdd

jamesnw added 4 commits December 16, 2024 11:20

Allow newlines in brackets and parens in selectors

61b4137

Documentation, review

0843edd

More docs

5e880e3

Rename consumeNewlines to allowNewlines

1ec13e5

jamesnw mentioned this pull request Dec 16, 2024

[Indented syntax improvements] Specs sass/sass-spec#2041

Open

1 task

jamesnw mentioned this pull request Dec 17, 2024

Indented syntax improvements oddbird/dart-sass#2

Closed

jamesnw added 2 commits December 17, 2024 12:11

Fix bug in semicolons in sass

5e3db80

Merge branch 'main' of https://github.com/sass/dart-sass into indente…

08747a9

…d-syntax-improvements

jamesnw mentioned this pull request Dec 17, 2024

Bump dart_style from 2.3.7 to 3.0.0 #2459

Merged

Merge branch 'main' of https://github.com/sass/dart-sass into indente…

38e05bf

…d-syntax-improvements

nex3 requested changes Dec 23, 2024

View reviewed changes

jamesnw added 10 commits December 30, 2024 09:13

Use local whitespace functions where value is irrelevant

ba62f15

Apply code suggestions to sass.dart

38ea36b

Allow whitespace after debug, error, warn

6d69938

Revise whitespace in if, function and supports conditions

b99d3ac

Don't break inside brackets in declarations

8ad5805

Whitespace in destructuring each

ce9522b

Disallow whitespace after @charset, document _expression arg

f0f8c7a

Add changelog

233d774

Errors on unmatched brackets

aad4b5c

Allow whitespace after comma in memberlist

cf711de

jamesnw mentioned this pull request Dec 31, 2024

Indented Syntax Improvements: Draft 1.2 sass/sass#4010

Open

jamesnw added 5 commits January 2, 2025 10:06

Support whitespace and comments after semicolon

f093d6a

Exclude semicolons and comments from spans

efb0d4d

Docs

66838ca

allowNewlines > consumeNewlines

1ff011a

Update pubspec to pass tests

99311ad

jamesnw commented Jan 2, 2025

View reviewed changes

nex3 requested changes Jan 3, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Indented syntax improvements] Dart implementation #2467

[Indented syntax improvements] Dart implementation #2467

jamesnw commented Dec 16, 2024 •

edited

Loading

jamesnw commented Dec 16, 2024

nex3 left a comment

nex3 Dec 23, 2024

jamesnw Dec 30, 2024

nex3 Jan 3, 2025

jamesnw left a comment

jamesnw Dec 30, 2024

jamesnw Dec 30, 2024

jamesnw Jan 2, 2025

nex3 Jan 2, 2025

nex3 Jan 2, 2025

nex3 Jan 2, 2025

nex3 Jan 2, 2025

nex3 Jan 2, 2025

nex3 Jan 3, 2025

nex3 Jan 3, 2025

		@@ -404,6 +394,7 @@ class SassParser extends StylesheetParser {
		}

		var start = scanner.state;

[Indented syntax improvements] Dart implementation #2467

Are you sure you want to change the base?

[Indented syntax improvements] Dart implementation #2467

Conversation

jamesnw commented Dec 16, 2024 • edited Loading

jamesnw commented Dec 16, 2024

nex3 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jamesnw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jamesnw commented Dec 16, 2024 •

edited

Loading