gritql

놀이터 | 튜토리얼 | 문서

---

GritQL은 소스 코드를 검색하고 수정하기 위한 선언적 쿼리 언어입니다.

• AST 세부 정보를 배우지 않고 간단히 시작하세요. 모든 코드 조각은 유효한 GritQL 쿼리입니다.
• ⚡️ Rust 및 쿼리 최적화를 사용하여 최대 1천만 개 이상의 라인 리포지토리까지 확장
• ? Grit의 내장 모듈 시스템을 사용하여 200개 이상의 표준 패턴을 재사용하거나 자신만의 패턴을 공유하세요.
• ♻️ GritQL을 배우면 이를 사용하여 JavaScript/TypeScript, Python, JSON, Java, Terraform, Solidity, CSS, Markdown, YAML, Rust, Go 또는 SQL 등 모든 대상 언어를 다시 작성할 수 있습니다.
• ? GritQL을 사용하면 더 빠른 문제 해결을 위해 자동 수정 규칙을 쉽게 포함할 수 있습니다.

시작하기

문서나 대화형 튜토리얼을 읽거나 grit --help 실행하세요.

설치

그릿 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

예

try-catch 블록 내부에 있지 않는 한 모든 console.log 호출을 제거합니다.

 `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 검색을 사용합니다. 시작하기 쉽지만 대부분의 마이그레이션에서는 올바른 패키지를 가져왔는지 확인하고 실행 가능한 마이그레이션 경로가 없는 경우를 제외하는 등의 추가 요구 사항이 누적됩니다.

결국 복잡한 마이그레이션은 결국 jscodeshift와 같은 도구를 사용하여 작성된 전체 codemod 프로그램이 됩니다. 여기에는 자체적인 문제가 있습니다.

• 원래 정규식 검색을 AST로 표현하는 방법을 알아내면서 대부분의 탐색 작업을 포기해야 합니다.
• codemod를 읽고 쓰려면 AST 이름을 소스 코드의 실제 모습으로 정신적으로 변환해야 합니다.
• 대부분의 프레임워크는 구성 가능하지 않으므로 패턴을 앞뒤로 복사해야 합니다.
• 성능은 나중에 고려하는 경우가 많으므로 대규모 codemod를 반복하는 것은 고통스러울 정도로 느려질 수 있습니다.
• Codemod 프레임워크는 언어별로 다르므로 여러 언어 사이를 이동하거나 공유 API를 마이그레이션하려는 경우 다양한 프레임워크를 배워야 합니다.

GritQL은 강력한 중간 지점을 개발하려는 우리의 시도입니다.

• 탐색적 분석은 쉽습니다. 백틱 안에 코드 조각을 넣고 표시하려는 구멍에 $metavariables 사용하기만 하면 됩니다.
• where 절과 함께 부가 조건을 도입하여 복잡성을 점진적으로 추가합니다.
• 쿼리 재구축을 방지하려면 명명된 패턴을 재사용하고, 모듈 가져오기 확인과 같은 일반적인 작업에는 표준 라이브러리의 공유 패턴을 사용하세요.
• 최대 성능을 위해 Rust로 작성되었습니다. 수백만 줄의 코드를 몇 초 만에 다시 작성합니다.

감사의 말

GritQL은 모든 언어 파서에 tree-sitter를 사용하며 Rust 생태계의 이점을 크게 활용합니다.

GritQL은 MIT 라이선스로 출시됩니다.

기여

기여를 환영합니다. 시작하려면 기여 지침을 확인하세요.

Discord 에서도 참여할 수 있습니다.