Hide lines prefixed by dollar sign ($) in Luau code blocks - #960
Open
itsmath wants to merge 9 commits into
Open
Conversation
This file contains hidden or 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
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 PR introduces a feature that hides comment lines inside
```luaucode blocks when they are prefixed by a dollar sign ($).Initially, I considered
#for this purpose since it has been used for this in other languages, like Rust. But I opted for$because:#is valid Luau syntax in certain cases:While this is rare, it could lead to unintended behavior.
$currently has no use in Luau and is unlikely to be used in the future, especially if RFC: Reserve the dollar sign token to be forever unused luau-lang/rfcs#44 is accepted.The lines will only be hidden if they are inside
```luaucode blocks. This means you can still have a PHP code block, for example, and it'll work fine.If you need to start a line with
$, you can use a regular```code block, which is still interpreted as a Luau code block by editors, but does not have this behavior.Use Case
If you're implementing a documentation testing tool, or really any tool that needs to inspect the Luau code inside comments, this feature is very useful.
I probably should've started with a GitHub issue first to see if this is even something we want to do, but I was already writing this implementation for my own use, so might as well send a PR.