Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement # runic: (off|on) toggle comments #44

Merged
merged 1 commit into from
Aug 15, 2024
Merged

Conversation

fredrikekre
Copy link
Owner

@fredrikekre fredrikekre commented Aug 15, 2024

This patch implements # runic: on and # runic: off toggle comments that can be included in the source to toggle formatting on/off.

The two comments i) must be placed on their own lines, ii) must be on the same level in the expression tree, and iii) must come in pairs. An exception to condition iii) is made for top level toggle comments so that formatting for a whole file can be disabled by a # runic: off comment at the top without having to add one also at the end of the file.

For compatibility with JuliaFormatter, #! format: (on|off) is also
supported but it is not possible to pair e.g. a # runic: off comment
with a #! format: on comment.

Closes #12, closes #41.

This patch implements `# runic: on` and `# runic: off` toggle comments
that can be included in the source to toggle formatting on/off.

The two comments i) must be placed on their own lines, ii) must be on
the same level in the expression tree, and iii) must come in pairs. An
exception to condition iii) is made for top level toggle comments so
that formatting for a whole file can be disabled by a `# runic: off`
comment at the top without having to add one also at the end of the
file.

For compatibility with JuliaFormatter, `#! format: (on|off)` is also
supported but it is not possible to pair e.g. a `# runic: off` comment
with a `#! format: on` comment.

Closes #12, closes #41.
@fredrikekre fredrikekre merged commit d68512f into master Aug 15, 2024
14 checks passed
@fredrikekre fredrikekre deleted the fe/toggle branch August 15, 2024 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

#! format: off/on Alignment
1 participant