GritQL

GritQL to język zapytań do wykonywania strukturalnych wyszukiwań w kodzie źródłowym. Oznacza to, że szczegóły takie jak białe znaki lub nawet typ cudzysłowów używanych w ciągach będą ignorowane w twoim zapytaniu wyszukiwania. Dodatkowo oferuje wiele funkcji, które pozwalają na zapytania o strukturę składni, takie jak fragmenty, dopasowanie, zagnieżdżanie i zmienne.

GritQL jest open-source i został stworzony przez Grit.io.

Biome używa GritQL do dwóch celów:

Wtyczki analizatora.
Polecenie biome search, które mamy nadzieję rozszerzyć również do naszych rozszerzeń IDE.

Wzorce

Zapytania GritQL działają poprzez wzorce. Najczęstszym wzorcem, który zobaczysz, jest fragment kodu, który wygląda jak zwykły kod źródłowy owinięty w backticki:

1
`console.log('Hello, world!')`

Ten wzorzec dopasuje każde wywołanie console.log(), któremu przekazano ciąg 'Hello, world!'. Ale ponieważ GritQL wykonuje strukturalne dopasowanie, nie zależy mu na szczegółach formatowania. To również pasuje:

1
console.log (
2
    'Hello, world!'
3
)

I to również (zauważ zmianę w cudzysłowach):

1
console.log("Hello, world!")

Większość powłok interpretuje backticki jako wywołania poleceń, co koliduje z fragmentami kodu GritQL. Więc podczas używania polecenia biome search, najlepiej jest umieścić pojedyncze cudzysłowy wokół twoich zapytań Grit:

1
biome search '`console.log($message)`' # znajdź wszystkie wywołania `console.log`

Zmienne

Zapytania GritQL mogą również mieć zmienne. Następujące dopasuje każde wywołanie console.log() niezależnie od przekazanego komunikatu:

1
`console.log($message)`

To również dopasuje dowolną z metod na obiekcie console:

1
`console.$method($message)`

Ta sama nazwa zmiennej może wystąpić wiele razy w jednym fragmencie:

1
`$fn && $fn()`

To dopasuje foo && foo(), a nawet foo.bar && foo.bar(), ale nie foo && bar().

Warunki

Możesz dodać warunki do wzorców używając operatora where. Jest to często używane razem z operatorem dopasowania, <::

1
`console.$method($message)` where {
2
    $method <: `log`
3
}

To zapytanie jest identyczne ze wzorcem console.log($message), który widzieliśmy wcześniej, ale staje się szybko bardziej interesujące, gdy dodamy inne operatory do mieszanki:

1
`console.$method($message)` where {
2
    $method <: or { `log`, `info`, `warn`, `error` }
3
}

Dopasowywanie węzłów składni Biome

Dla bardziej precyzyjnych zapytań możesz dopasować bezpośrednio do wewnętrznych węzłów składni Biome. Każdy węzeł jest identyfikowany przez unikalną nazwę PascalCase.

Na przykład, aby znaleźć wszystkie instrukcje JavaScript if, możesz dopasować węzeł JsIfStatement:

1
engine biome(1.0)
2
language js(typescript,jsx)
3

4
JsIfStatement() as $stmt where {
5
  register_diagnostic(
6
    span=$stmt,
7
    message="Found an if statement"
8
  )
9
}

Możesz odkryć nazwy węzłów dla swojego kodu, eksplorując drzewo składni w Biome Playground. Pełna lista wszystkich dostępnych węzłów jest również dostępna w plikach .ungram w katalogu xtask/codegen repozytorium Biome.

Dokumentacja języka

Aby uzyskać więcej informacji o GritQL i jego składni, zobacz oficjalną Dokumentację języka GritQL.

Proszę pamiętać, że Biome nie obsługuje jeszcze wszystkich funkcji Grit.

Status integracji

Obsługa GritQL w Biome jest aktywnie rozwijana. Wiele rzeczy już działa, ale nadal można oczekiwać błędów, a niektóre funkcje są nadal całkowicie brakujące.

Aby uzyskać szczegółowy przegląd, które funkcje GritQL są obsługiwane, a które są nadal w trakcie, zobacz issue na GitHubie: https://github.com/biomejs/biome/issues/2582.

Mamy również szczegółowy RFC, który kieruje kierunkiem naszych wysiłków związanych z wtyczkami: https://github.com/biomejs/biome/discussions/1762

tl;dr: Pracujemy nad obsługą wtyczek, które mogą być albo czystymi wtyczkami GritQL albo wtyczkami JS/TS, które używają GritQL do wyboru kodu, na którym chcą działać. Bądźcie czujni!