Handle comments inlined in assignment expression better

CHANGELOG.md

@@ -13,6 +13,7 @@ Specify whether to apply parentheses on function calls with single string or tab
 
 ### Fixed
 - Fixed generic variadics not being handled under the `luau` feature flag. ([#333](https://github.com/JohnnyMorganz/StyLua/issues/333))
+- Fixed issue with comments within an assignment not being correctly handled, leading to a syntax error. ([#340](https://github.com/JohnnyMorganz/StyLua/issues/340))
 
 ### Deprecated
 - Option `no_call_parentheses` has been deprecated. Use `call_parentheses = "None"` instead.

src/formatters/assignment.rs

@@ -171,7 +171,15 @@ fn attempt_assignment_tactics(
             let shape = shape.reset().increment_additional_indent();
 
             // As we know that there is only a single element in the list, we can extract it to work with it
-            let expression = format_expression(ctx, expression, shape);
+            // Format the expression given - if it contains comments, make sure to hang the expression
+            // Ignore the leading comments though (as they are solved by hanging at the equals), and the
+            // trailing comments, as they don't affect anything
+            let expression =
+                if trivia_util::expression_contains_inline_comments(&strip_trivia(expression)) {
+                    hang_expression(ctx, expression, shape, None)
+                } else {
+                    format_expression(ctx, expression, shape)
+                };
 
             // We need to take all the leading trivia from the expr_list
             let (expression, leading_comments) =

tests/inputs/assignment-comments.lua

@@ -11,4 +11,17 @@ local isValid = -- test comment
 	-- Allow nil for conditional declaration
 	contextType == nil or
 	(contextType["$$typeof"] == REACT_CONTEXT_TYPE and
-		contextType._context == nil) -- Not a <Context.Consumer>
+		contextType._context == nil) -- Not a <Context.Consumer>
+
+-- https://github.com/JohnnyMorganz/StyLua/issues/340
+local useDisposableConcast =
+	-- * Refetching uses a disposable Concast to allow refetches using different
+	-- options/variables, without permanently altering the options of the
+	-- original ObservableQuery.
+	newNetworkStatus == NetworkStatus.refetch or
+	-- * The fetchMore method does not actually call the reobserve method, but,
+	-- if it did, it would definitely use a disposable Concast.
+	newNetworkStatus == NetworkStatus.fetchMore or
+	-- * Polling uses a disposable Concast so the polling options (which force
+	-- fetchPolicy to be "network-only") won't override the original options.
+	newNetworkStatus == NetworkSt

tests/snapshots/tests__standard@assignment-comments.lua.snap

@@ -14,3 +14,16 @@ local isValid = -- test comment
 	-- Allow nil for conditional declaration
 	contextType == nil or (contextType["$$typeof"] == REACT_CONTEXT_TYPE and contextType._context == nil) -- Not a <Context.Consumer>
 
+-- https://github.com/JohnnyMorganz/StyLua/issues/340
+local useDisposableConcast =
+	-- * Refetching uses a disposable Concast to allow refetches using different
+	-- options/variables, without permanently altering the options of the
+	-- original ObservableQuery.
+	newNetworkStatus == NetworkStatus.refetch
+	-- * The fetchMore method does not actually call the reobserve method, but,
+	-- if it did, it would definitely use a disposable Concast.
+	or newNetworkStatus == NetworkStatus.fetchMore
+	-- * Polling uses a disposable Concast so the polling options (which force
+	-- fetchPolicy to be "network-only") won't override the original options.
+	or newNetworkStatus == NetworkSt
+