gritql

Детская площадка | Учебное пособие | Документы

---

GritQL — это декларативный язык запросов для поиска и изменения исходного кода.

• Начните с простого, не изучая детали AST: любой фрагмент кода является валидным запросом GritQL.
• ⚡️ Используйте Rust и оптимизацию запросов для масштабирования до 10+ миллионов строковых репозиториев.
• ? Используйте встроенную систему модулей Grit, чтобы повторно использовать более 200 стандартных шаблонов или поделиться своими собственными.
• ♻️ Изучив GritQL, вы сможете использовать его для переписывания любого целевого языка: JavaScript/TypeScript, Python, JSON, Java, Terraform, Solidity, CSS, Markdown, YAML, Rust, Go или SQL.
• ? GritQL позволяет легко включать правила автоматического исправления для более быстрого исправления ошибок.

Начиная

Прочтите документацию, интерактивное руководство или запустите grit --help .

Установка

Установите Grit CLI:

 curl -fsSL https://docs.grit.io/install | bash

Использование

Найдите все вызовы console.log , поместив нужный шаблон в обратные кавычки:

 grit apply '`console.log($_)`'

Замените console.log на winston.log , используя => для перезаписи:

 grit apply '`console.log($msg)` => `winston.log($msg)`'

Сохраните шаблон в файле grit.yaml и исключите тестовые примеры в предложенииwhere:

 cat << 'EOF' > .grit/grit.yaml
patterns:
  - name: use_winston
    level: error
    body: |
      `console.log($msg)` => `winston.log($msg)` where {
        $msg <: not within or { `it($_, $_)`, `test($_, $_)`, `describe($_, $_)` }
      }
EOF
grit apply use_winston

Запустите grit check чтобы применить ваши шаблоны как пользовательские проверки.

 grit check

Примеры

Удалите все вызовы console.log , если они не находятся внутри блока try-catch.

 `console.log($log)` => . where {
  $log <: not within `try { $_ } catch { $_ }`
}

Замените вызов метода новым вызовом метода

 `$instance.oldMethod($args)` => `$instance.newMethod($args)` where {
  $program <: contains `$instance = new TargetClass($_)`
}

Больше примеров

Еще больше примеров можно найти в стандартной библиотеке GritQL.

Шаблоны можно комбинировать для создания сложных запросов, включая крупные рефакторинги.

Почему GritQL?

GritQL основан на нашем опыте проведения крупномасштабных рефакторингов и миграций.

Обычно миграция начинается с исследовательской работы по выяснению масштаба проблемы — часто с использованием простого поиска с помощью grep. С этого легко начать, но большинство миграций в конечном итоге приводят к накоплению дополнительных требований, таких как обеспечение импорта правильных пакетов и исключение случаев, для которых нет жизнеспособного пути миграции.

В конце концов, любая сложная миграция превращается в полноценную программу codemod, написанную с помощью такого инструмента, как jscodeshift. Это связано со своими проблемами:

• От большей части исследовательской работы придется отказаться, поскольку вы поймете, как представить исходный поиск по регулярным выражениям в виде AST.
• Чтение/запись codemod требует мысленного перевода имен AST обратно в то, как на самом деле выглядит исходный код.
• Большинство фреймворков не являются компонуемыми, поэтому вам приходится копировать шаблоны туда и обратно.
• О производительности часто думают второстепенно, поэтому итерация большого кода может быть мучительно медленной.
• Фреймворки Codemod зависят от языка, поэтому, если вы переключаетесь между несколькими языками или пытаетесь перенести общий API, вам придется изучить разные фреймворки.

GritQL — это наша попытка разработать мощную золотую середину:

• Исследовательский анализ прост: просто поместите фрагмент кода в обратные кавычки и используйте $metavariables для дыр, которые вы хотите отобразить.
• Постепенно добавляйте сложность, вводя дополнительные условия с помощью предложенийwhere.
• Повторно используйте именованные шаблоны, чтобы избежать повторного построения запросов, и используйте общие шаблоны из нашей стандартной библиотеки для общих задач, таких как обеспечение импорта модулей.
• Написан на Rust для максимальной производительности: перепишите миллионы строк кода за секунды.

Благодарности

GritQL использует Tree-sitter для всех парсеров языка и получает большую выгоду от экосистемы Rust.

GritQL выпускается под лицензией MIT.

Содействие

Взносы приветствуются. Для начала ознакомьтесь с правилами участия .

Вы также можете присоединиться к нам в Discord .