test(format/grit): add tests for grit formatter

[branberry]

Summary

Add basic testing setup for the Grit formatter. Also added some additional configuration to handle Grit files.

Test Plan

Verify that tests for Grit execute successfully

[codspeed-hq]

CodSpeed Performance Report

Merging #3937 will not alter performance

_{Comparing branberry:feat/grit-formatter-tests (1f185f2) with main (c921aeb)}

Summary

✅ 107 untouched benchmarks

[arendjr]

I think the formatting changes might have been due to the newline here.

[arendjr]

I like that we're adding a file handler for Grit 👍

[branberry]

Glad to hear! Haha. I've been following some of the other examples, and I've seen that we typically create a file handler struct as a part of the testing process.

Not sure if I'm doing too much work here, but it sounds like I'm working in the right direction!

As a side note, I'm a Rust newbie so any pointers on how I can improve my Rust code is welcome and appreciated :D

[arendjr]

Nice!

[arendjr]

Note there does seem to be a test failure still.

[branberry]

Hey @arendjr ! I see that test failure, and I'm currently working to resolve it. Thank you for the speedy review!

[dyc3]

In order for the tests to work, biome_service needs to know how to handle the file. You'll need to add the language to the DocumentFileSource enum. IIRC, can_parse is the actual function that's used.

You should go ahead and add a experimental-grit feature flag too, just like how html is set up. You can use #3967 for reference.

[dyc3]

It looks like the codegen is failing and the tests are failing.

To fix the codegen: just gen-all should do it.

[branberry]

Gotcha, thanks for the codegen stuff! I'm digging through the code a bit more now, and I think the test failures are due to me missing some additional configuration.

I confirmed here that can_format.supports_format() returns false and that is why the test is failing. Digging into that function a bit more to see if there's something else that I've missed

[dyc3]

There was one more feature thing I forgot that will fix the tests:

In biome_grit_formatter in the Cargo.toml, import biome_service like this to make sure the feature flag is enabled.

biome_service = { workspace = true, features = ["experimental-grit"] }

[branberry]

@dyc3 Thanks! That resolved the file handler issue. Still have some more errors, but these are related to differences in implementation. It looks like in the biome_grit_parser/tests/spec_test.rs, we don't use the snapshot builder, but manually build out the snapshot tests. I'm assuming that's because of features that we still need to implement for grit. With that said, I'll refactor the test to look like the biome_grit_parser snapshot tests, and I'll push what I have so far.

[arendjr]

It looks like in the biome_grit_parser/tests/spec_test.rs, we don't use the snapshot builder, but manually build out the snapshot tests. I'm assuming that's because of features that we still need to implement for grit

What’s the snapshot builder? In any case, I’m not entirely sure why I did it like that anymore… it might just have been an oversight 😅

[branberry]

@arendjr I was following the biome_html_formatter/tests/spec_test.rs as a reference for my changes. If that's something that you don't think using this helper is necessary, then I'll go ahead with the other example I referenced 👍

[arendjr]

Ah, I see what you mean. I haven’t created formatter tests before, but it looks like that will be useful for formatter tests indeed. I hadn’t done that for the parser indeed, but those look a bit different anyway (I think I had based the parser tests on those for the CSS parser).

[branberry]

@arendjr Yeah, I'm conflicted now. Because the parser tests I would imagine are different for a reason, so I'm debugging the issue I'm having with the snapshot builder

Here's the exact line that is panicking

Here's the error as well

byte index 142 is out of bounds of ``function $name ($args) { $body }` as $func where {
  $func => `const $name = ($args) => { $body }`,
  $args <: contains `apple` => `mango`
}`
stack backtrace:

[arendjr]

I’m not sure what caused the issue with that other test, but I might have a chance to look at it this week. If you like you can leave it in this PR in a disabled state, then I’ll follow up with a separate PR to enable it.

[dyc3]

I went ahead and fixed the merge conflict for you.

[branberry]

@arendjr I figured out the issue with the test failure. I needed to run cargo insta accept to generate the new snapshot test. Rookie mistake on my part... haha!