ast-grep: viết lại code và tìm kiếm cấu trúc CLI

Hiểu cơ chế so khớp code theo cấu trúc của ast-grep

ast-grep là một CLI viết bằng Rust, phân tích source code thành cây cú pháp trừu tượng (AST) bằng tree-sitter, rồi so khớp pattern với cấu trúc của cây đó thay vì với văn bản gốc. Pattern được viết trông giống code bình thường, dùng dấu `$` cộng chữ hoa (như `$MATCH`) làm ký tự đại diện cho bất kỳ node AST nào. Cùng một engine so khớp này vận hành ba lệnh: search, lint qua file rule YAML, và rewrite.

Các khả năng cốt lõi để biến đổi code

• ✓Cú pháp pattern trông như code thật — viết `$PATTERN` ở vị trí một biểu thức, nó sẽ bắt bất kỳ node AST nào ở đó mà không cần escape ký tự như regex.
• ✓Ký tự đại diện `$` cộng chữ hoa (`$MATCH`, `$A`,...) cho phép bắt một node rồi tham chiếu lại ở chỗ khác trong cùng pattern hoặc trong phần thay thế của `--rewrite`.
• ✓Cờ `--rewrite` biến một pattern đã khớp thành một thay đổi code tự động, chạy trực tiếp từ dòng lệnh nhắm vào ngôn ngữ chỉ định qua `--lang`.
• ✓File rule YAML để định nghĩa các kiểm tra lint hoặc chuỗi rewrite nhiều bước dưới dạng cấu hình, thay vì viết một script riêng cho từng rule.
• ✓Một API để duyệt và thao tác trên AST, phỏng theo phong cách chuỗi lệnh (chaining) kiểu jQuery, dùng để viết script kiểm tra vượt ra ngoài các cờ có sẵn của CLI.
• ✓Một binary Rust được biên dịch sẵn, phân tích bằng tree-sitter và theo README có tận dụng nhiều nhân CPU.
• ✓Một playground chạy trên trình duyệt để thử pattern với code mẫu trước khi viết bất kỳ cấu hình nào ở máy local.

Ai nên dùng ast-grep?

ast-grep phù hợp với các lập trình viên cần thay đổi nhiều vị trí gọi hàm theo cùng một cách: người duy trì thư viện mã nguồn mở khi tung ra một thay đổi API gây breaking change, tech lead muốn một rule lint kiểm tra theo cấu trúc code thay vì theo mẫu văn bản, và bất kỳ ai đang làm một lần migration như ví dụ viết lại cấu hình Zodios trong README. Công cụ này ít hữu ích hơn cho việc tìm chuỗi văn bản đơn giản trên nhiều file — lúc đó grep thông thường vẫn là lựa chọn nhanh hơn.

Bắt đầu với ast-grep

Theo README, ast-grep cài được qua nhiều trình quản lý package: `npm install --global @ast-grep/cli` (người dùng Node có thể cần chạy thêm `pnpm approve-builds`), `pip install ast-grep-cli`, hoặc `brew install ast-grep`. Ngoài ra còn có `cargo install ast-grep --locked`, `cargo binstall ast-grep`, Scoop (`scoop install main/ast-grep`), MacPorts (`sudo port install ast-grep`), Nix (`nix-shell -p ast-grep`), và mise (`mise use -g ast-grep`). Để build từ source, cài rustup, clone repo rồi chạy `cargo install --path ./crates/cli --locked`. README cũng dẫn tới Repology để tìm package cho các nền tảng khác.

Ví dụ dòng lệnh và các pattern

Cấu trúc lệnh cốt lõi là `ast-grep --pattern 'var code = $PATTERN' --rewrite 'let code = new $PATTERN' --lang ts`, tìm mọi chỗ khớp pattern và viết lại trong một lần chạy. Chính README cũng đưa ví dụ dùng cờ viết tắt: `ast-grep -p '$A && $A()' -l ts -r '$A?.()'` chuyển một lệnh gọi có kiểm tra điều kiện thành optional chaining, còn `ast-grep -p 'new Zodios($URL, $CONF as const,)' -l ts -r 'new Zodios($URL, $CONF)' -i` dùng để migrate một lệnh gọi cấu hình Zodios. Các rule lint hay codemod phức tạp hơn một pattern đơn dòng thì được viết dưới dạng cấu hình YAML thay vì truyền trực tiếp trên dòng lệnh.

So sánh ast-grep với các công cụ khác

Câu hỏi thường gặp về ast-grep

Vấn đề mà ast-grep giải quyết

Refactor trên cả một codebase thường buộc phải chọn giữa hai phương án không trọn vẹn: một lệnh grep/sed so khớp văn bản và vỡ trận ngay khi code được format lại hoặc biến đổi tên, hoặc một AST transform đầy đủ viết bằng thứ như babel, đòi hỏi thiết lập không nhỏ cho một thay đổi có khi chỉ chạy một lần. ast-grep nằm ở giữa hai lựa chọn đó — pattern của nó trông như code bình thường nên chi phí bắt đầu gần với grep, nhưng việc so khớp lại dựa trên cấu trúc AST, nên nó không bị phá vỡ bởi thay đổi khoảng trắng hay đổi tên biến như so khớp văn bản.

Các use case phù hợp nhất

• •Đính kèm một rewrite rule cùng với một thay đổi API gây breaking change, để người dùng thư viện tự động migrate code thay vì phải đọc hướng dẫn nâng cấp thủ công.
• •Mã hóa quy ước code riêng của team thành rule lint YAML rồi chạy trong CI để bắt một cấu trúc code mà linter dựa trên regex sẽ bỏ sót.
• •Thử nghiệm một kiểm tra theo mẫu lỗ hổng bảo mật dưới dạng pattern AST thay vì phải xây cả một plugin phân tích tĩnh từ đầu.
• •Các đợt migration framework một lần, như ví dụ viết lại cấu hình Zodios trong README, được script hóa thay vì sửa tay từng vị trí gọi hàm.

Repo liên quan