ดาวน์โหลด gritql - ดาวน์โหลดซอร์สโค้ด gritql

gritql

ซอร์สโค้ดอื่น ๆ

v0.1.0-alpha.1732682283

ดาวน์โหลด

สนามเด็กเล่น | บทช่วยสอน | เอกสาร

GritQL เป็นภาษาคิวรีที่ประกาศสำหรับการค้นหาและแก้ไขซอร์สโค้ด

เริ่มต้นง่ายๆ โดยไม่ต้องเรียนรู้รายละเอียด AST: ข้อมูลโค้ดใดๆ ก็เป็นแบบสอบถาม GritQL ที่ถูกต้อง
⚡️ ใช้การเพิ่มประสิทธิภาพ Rust และการสืบค้นเพื่อขยายพื้นที่เก็บข้อมูลบรรทัดสูงสุด 10M+
- ใช้ระบบโมดูลในตัวของ 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 ทั้งหมดของคุณโดยใส่รูปแบบที่ต้องการใน backticks:

 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 แบบง่ายๆ สิ่งเหล่านี้เริ่มต้นได้ง่าย แต่การโยกย้ายส่วนใหญ่จบลงด้วยการสะสมข้อกำหนดเพิ่มเติม เช่น การตรวจสอบให้แน่ใจว่ามีการนำเข้าแพ็คเกจที่ถูกต้อง และไม่รวมกรณีต่างๆ ที่ไม่มีเส้นทางการย้ายที่ทำงานได้

ในที่สุด การโยกย้ายที่ซับซ้อนใดๆ ก็กลายเป็นโปรแกรมโค้ดโมดเต็มรูปแบบที่เขียนด้วยเครื่องมืออย่าง jscodeshift สิ่งนี้มาพร้อมกับปัญหาของตัวเอง:

งานสำรวจส่วนใหญ่ต้องถูกยกเลิกไปเมื่อคุณทราบวิธีแสดงการค้นหา regex ดั้งเดิมของคุณเป็น AST
การอ่าน/การเขียนโค้ดโมดจำเป็นต้องแปลจากชื่อ AST กลับไปเป็นซอร์สโค้ดที่ดูเหมือนจริง
เฟรมเวิร์กส่วนใหญ่ไม่สามารถประกอบได้ ดังนั้นคุณจึงติดอยู่กับการคัดลอกรูปแบบไปมา
ประสิทธิภาพมักจะเป็นสิ่งที่ต้องคำนึงถึงในภายหลัง ดังนั้นการวนซ้ำโค้ดโมดขนาดใหญ่จึงอาจช้าอย่างเจ็บปวด
เฟรมเวิร์ก Codemod เป็นภาษาเฉพาะ ดังนั้นหากคุณข้ามไปมาระหว่างหลายภาษา หรือพยายามย้าย API ที่ใช้ร่วมกัน คุณจะต้องเรียนรู้เฟรมเวิร์กที่แตกต่างกัน

GritQL คือความพยายามของเราในการพัฒนาจุดกึ่งกลางที่ทรงพลัง:

การวิเคราะห์เชิงสำรวจนั้นง่ายดาย เพียงใส่ข้อมูลโค้ดใน backticks และใช้ $metavariables สำหรับช่องโหว่ที่คุณต้องการนำเสนอ
เพิ่มความซับซ้อนทีละน้อยโดยแนะนำเงื่อนไขด้านข้างพร้อมกับคำสั่งย่อย
ใช้รูปแบบที่มีชื่อซ้ำเพื่อหลีกเลี่ยงการสร้างการสืบค้นใหม่ และใช้รูปแบบที่ใช้ร่วมกันจากไลบรารีมาตรฐานของเราสำหรับงานทั่วไป เช่น การตรวจสอบให้แน่ใจว่ามีการนำเข้าโมดูล
เขียนด้วยภาษา Rust เพื่อประสิทธิภาพสูงสุด: เขียนโค้ดหลายล้านบรรทัดใหม่ภายในไม่กี่วินาที