ast: add `CommentNodeId` to every ast node

[Boshen]

In order to attach comments correct for codegen and formatter, we need to attach comments to ast nodes instead of tokens.

[overlookmotel]

We discussed in meet yesterday. I suggested easiest way is to add this field to all structs in oxc_ast_tools / #[ast] macro.

After looking at this more closely, I now realize that was a bad idea. The problem is that we don't want to add this field to all structs, only AST nodes. e.g. We do want to add it to e.g. RegExpLiteral, but we don't want to add it to RegExp or RegExpPattern. The codegen doesn't have enough knowledge to make the decision of which types need the field, and which don't.

I suggest instead:

• feat(syntax): introduce CommentNodeId #11214 adds the CommentNodeId type, and sets up everything in codegen so it can be added to AST types, without breaking anything else.
• Add comment_node_id: CommentNodeId to all AST structs which are "nodes" (note: not Cell<Option<CommentNodeId>>, for the reasons discussed in feat(syntax): introduce CommentNodeId #11214).

I suggest adding comment_node_id fields straight after span. CommentNodeId will eventually be replaced with NodeId, and that position feels natural for NodeId.

We will then need to:

1. Remove #[derive(Clone, Copy)] from AstBuilder, so it can be stateful. This will involve a large refactor of a lot of code. refactor(ast): make AstBuilder not Copy #11239 makes all AstBuilder methods take &self instead of self, but this breaks a lot of consuming code. fix(parser, transformer): fix AstBuilder call sites WIP #11240 is a start on fixing the breakage, but it's only a fraction of the job.

2. Add a field next_comment_node_id: Cell<u32> to AstBuilder and make AstBuilder::get_comment_node_id increment it, so each node gets a unique ID.

3. Alter the field-reordering algorithm so CommentNodeId is in a consistent position in each struct, to speed up accessing it.

4. (if we need it) Codegen a GetCommentNodeId trait, similar to GetSpan.

---

Note: It would be better if AstBuilder methods took &mut self, so then no need to put the ID counter in a Cell. But this would require an enormous amount of refactoring, and make AST builder really hard to use, because borrow-checker would not allow nested calls e.g.: ctx.ast.unary_expression(SPAN, op, ctx.ast.expression_null_literal(SPAN)).

[overlookmotel]

@Boshen This is currently assigned to me. Should it be? #11214 set up everything in oxc_ast_tools to enable adding this field to all AST types, which I understood was what was blocking you.

I can continue the work and add the field to all the AST types, but that would push back my work on oxlint JS plugins. Do you want me to continue, or are you taking over again at this point?

[Boshen]

Do you want me to continue, or are you taking over again at this point?

I can continue.