refactor(ast_codegen): use doc comments instead of endl!

[overlookmotel]

Similar to #4777.

Use ///@@ instead of endl!(); in AST codegen to create line breaks.

NB: ///@@ needs to be before an item, not after it.

[graphite-app]

Your org has enabled the Graphite merge queue for merging into main

Add the label “merge” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “hotfix” to add to the merge queue as a hot fix.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

[overlookmotel]

• refactor(ast_codegen): replace ///@@ with ///@@line_break #4786
• refactor(ast_codegen): trim r# from start of field names #4785
• refactor(ast_codegen): alter JSON schema format #4784
• refactor(ast_codegen): remove excess space from start of doc comments #4782
• refactor(ast_codegen): line breaks between types in layout assertions #4781
• refactor(ast_codegen): re-order code in fmt module #4779
• refactor(ast_codegen): use doc comments instead of endl! #4778 👈
• refactor(ast_codegen): use doc comments instead of insert! #4777
• refactor(ast_codegen): move formatting regex definitions #4775
• refactor(ast_codegen): remove unnecessary imports from generated files #4774
• refactor(ast): oxc_ast crate re-export AST types from other crates #4773
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @overlookmotel and the rest of your teammates on Graphite

[codspeed-hq]

CodSpeed Performance Report

Merging #4778 will not alter performance

_{Comparing 08-09-refactor_ast_codegen_use_doc_comments_instead_of_endl_ (2c1c705) with main (f418f62)}

Summary

✅ 29 untouched benchmarks

[overlookmotel]

@rzvxa I'm less sure about this one than #4777.

Reasons I prefer ///@@ to endl!():

• Because it's a comment, it's clearer that it's incidental and not part of the output code.
• VS Code colours the comments in green, so the code is more broken up visually, which makes it easier to read.

What I don't like:

• What the fuck does ///@@ mean?!

On balance I do prefer ///@@, but what do you think? Would it be clearer if it was ///@@<line break>? Or are you completely opposed?

[rzvxa]

@rzvxa I'm less sure about this one than #4777.

Reasons I prefer ///@@ to endl!():

* Because it's a comment, it's clearer that it's incidental and not part of the output code.

* VS Code colours the comments in green, so the code is more broken up visually, which makes it easier to read.

What I don't like:

* What the fuck does `///@@` mean?!

On balance I do prefer ///@@, but what do you think? Would it be clearer if it was ///@@<line break>? Or are you completely opposed?

I'll let you decide on this one, As long as we can generate the same output it doesn't matter.

[overlookmotel]

We could make our own proc macro which wraps quote! and figures out where line breaks are from the spans of tokens, and inserts endl!(); for us in those places. So then we could just write the code normally and avoid all this nonsense. But it seems like overkill to me to have a proc macro purely for use in the codegen.

[graphite-app]

Merge activity

• Aug 9, 4:56 AM EDT: The merge label 'merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
• Aug 9, 4:56 AM EDT: overlookmotel added this pull request to the Graphite merge queue.
• Aug 9, 5:01 AM EDT: overlookmotel merged this pull request with the Graphite merge queue.

[overlookmotel]

OK, thanks. I'm going to merge it. Might go back and change it ///@@<line break> later on.