Description

In order to run GritQL plugins in Biome, we need to implement a Grit runtime.

We will showcase the ability of our Grit runtime using a relatively straight-forward biome search command, which will be functionally similar to git grep: Where git grep uses regular expressions to search through all files in a Git repository, biome search will use Grit patterns to search through all files in a Biome project.

If this effort is successful, we can proceed with using the runtime for plugins. To see how this issue fits into our plugin efforts, please look at the overview here: #2463

Tasks

• feat(parser): GritQL parser #1998
• Refactor the GritQL engine to be free of TreeSitter dependencies. DONE: https://github.com/getgrit/gritql/pulls?q=is%3Apr+author%3Aarendjr
• Implement Biome bindings to the GritQL engine (SOME TASKS REMAIN)
• Finish up the biome search command
  • chore: search command infra #2194
  • Invoke the Grit engine inside the search command
  • ☂️ Implement biome search output formatting #2462
  • Improve diagnostics (invalid query, no results, …)

How to Contribute

Everyone is welcome to contribute pieces here! If you'd like to tackle something, please leave a comment below this issue for which item(s) of the checklist below you'd like to pick up. We will create a separate issue and assign it to you to simplify tracking.

If you need any help or have any questions about our plugin efforts in Biome, feel free to ask in the #plugins channel in Discord.

Funding

To support this effort, please consider sponsoring Biome within our Open Collective or GitHub sponsorship.

We decide not to fund this issue with Polar.sh because it is a long term effort. Polar.sh is designed for short and medium term efforts. It sets a deadline of 6 months to complete a task.