Allow indentation width to be set explicitly #8
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
This allows the user to circumvent the default indentation behavior. In particular, it can be used to avoid getting the default four-space indentation when expanding source that doesn’t contain any indentation to infer the indentation width from. Changes: * The `assertMacro` function, along with related functions, now accepts `indentationWidth` as a parameter (`Trivia`). * Introduces `IndentationWidthTests` to validate both the existing indentation behavior and the new explicit indentation width functionality.
gohanlon
commented
Oct 7, 2023
| @@ -90,8 +91,11 @@ import XCTest | |||
| /// | |||
| /// - Parameters: | |||
| /// - macros: The macros to expand in the original source string. Required, either implicitly via | |||
| /// ``withMacroTesting(isRecording:macros:operation:)-2vypn``, or explicitly via this parameter. | |||
| /// no fix-its to apply, or if any diagnostics are unfixable, the assertion will fail. | |||
There was a problem hiding this comment.
I removed this stray line:
/// no fix-its to apply, or if any diagnostics are unfixable, the assertion will fail.which was left behind when applyFixIts was removed:
///
/// - applyFixIts: Applies fix-its to the original source and snapshots the result. If there are
/// no fix-its to apply, or if any diagnostics are unfixable, the assertion will fail.
///
stephencelis
reviewed
Oct 7, 2023
|
Hi @stephencelis, any updates on this? A way to clean up the awkward indentation in a dozen or so of my tests would be a nice-to-have! 😄 |
stephencelis
approved these changes
Nov 15, 2023
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.
This allows the user to circumvent the default indentation behavior. In particular, it can be used to avoid getting the default four-space indentation when expanding source that doesn’t contain any indentation to infer the indentation width from, e.g.:
Unindented original source seems uncommon, but it occurs pretty frequently in my macro tests. For example, I have a collection of tests that exercise each possible combination of access modifier for structs, classes, and actors.
Changes:
assertMacroandwithMacroTestingfunctions now acceptindentationWidthas a parameter (Trivia).IndentationWidthTeststo validate both the existing indentation behavior and the new explicit indentation width functionality.Some alternatives to consider:
defaultIndentationWidthto let the user only control the fallback indentation value. This would work in my use case.assertMacroand not inwithMacroTesting.