gritql

Parque infantil | Tutorial | Documentos

---

GritQL é uma linguagem de consulta declarativa para pesquisar e modificar código-fonte.

• Comece de forma simples, sem aprender os detalhes do AST: qualquer trecho de código é uma consulta GritQL válida
• ⚡️ Use Rust e otimização de consulta para escalar até mais de 10 milhões de repositórios de linha
• ? Use o sistema de módulos integrados do Grit para reutilizar mais de 200 padrões padrão ou compartilhar os seus próprios
• ♻️ Depois de aprender GritQL, você poderá usá-lo para reescrever qualquer linguagem de destino: JavaScript/TypeScript, Python, JSON, Java, Terraform, Solidity, CSS, Markdown, YAML, Rust, Go ou SQL
• ? O GritQL facilita a inclusão de regras de correção automática para uma correção mais rápida

Começando

Leia a documentação, o tutorial interativo ou execute grit --help .

Instalação

Instale a CLI do Grit:

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

Uso

Pesquise todas as suas chamadas console.log colocando o padrão desejado entre crases:

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

Substitua console.log por winston.log , usando => para criar reescritas:

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

Salve o padrão em um arquivo grit.yaml e exclua os casos de teste em uma cláusula 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

Execute grit check para impor seus padrões como lints personalizados.

 grit check

Exemplos

Remova todas as chamadas console.log , a menos que estejam dentro de um bloco try-catch

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

Substitua uma chamada de método por uma nova chamada de método

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

Mais exemplos

Muitos outros exemplos podem ser encontrados na biblioteca padrão GritQL.

Os padrões podem ser combinados para criar consultas complexas, incluindo grandes refatoradores.

Por que GritQL?

GritQL vem de nossas experiências na condução de refatorações e migrações em grande escala.

Normalmente, as migrações começam com um trabalho exploratório para descobrir o escopo do problema – geralmente usando buscas grep simples. É fácil começar, mas a maioria das migrações acaba acumulando requisitos adicionais, como garantir que os pacotes certos sejam importados e excluir casos que não tenham um caminho de migração viável.

Eventualmente, qualquer migração complexa acaba sendo um programa codemod completo escrito com uma ferramenta como jscodeshift. Isso traz seus próprios problemas:

• A maior parte do trabalho exploratório deve ser abandonada enquanto você descobre como representar sua pesquisa regex original como um AST.
• Ler/escrever um codemod requer a tradução mental dos nomes AST para a aparência real do código-fonte.
• A maioria das estruturas não é combinável, então você fica preso copiando padrões de um lado para outro.
• O desempenho costuma ser uma reflexão tardia, portanto, a iteração em um codemod grande pode ser dolorosamente lenta.
• As estruturas Codemod são específicas de cada linguagem, portanto, se você estiver alternando entre várias linguagens — ou tentando migrar uma API compartilhada — precisará aprender estruturas diferentes.

GritQL é nossa tentativa de desenvolver um meio-termo poderoso:

• A análise exploratória é fácil: basta colocar um trecho de código entre crases e usar $metavariables para os buracos que você deseja representar.
• Adicione complexidade gradativamente introduzindo condições secundárias com cláusulas where.
• Reutilize padrões nomeados para evitar a reconstrução de consultas e use padrões compartilhados de nossa biblioteca padrão para tarefas comuns, como garantir que os módulos sejam importados.
• Escrito em Rust para desempenho máximo: reescreva milhões de linhas de código em segundos.

Agradecimentos

GritQL usa tree-sitter para todos os analisadores de linguagem e se beneficia muito do ecossistema Rust.

GritQL é lançado sob a licença do MIT.

Contribuindo

Contribuições são bem-vindas. Para começar, confira as diretrizes de contribuição .

Você também pode se juntar a nós no Discord .