Remoto.el: Duyệt kho lưu trữ GitHub trực tiếp trên Emacs mà không cần Clone

Bạn có bao giờ ước rằng mình có thể nhấn C-x C-f (find-file) trên Emacs, nhập một URL GitHub và duyệt mã nguồn ngay lập tức như thể đó là một thư mục cục bộ? Với remoto.el, điều này giờ đây đã trở thành hiện thực.

Demo Remoto.el

Remoto.el là gì?

Remoto.el là một gói mở rộng cho Emacs đăng ký một hệ thống tệp ảo thông qua file-name-handler-alist. Nó chuyển đổi các thao tác tệp tiêu chuẩn của Emacs thành các cuộc gọi API GitHub thông qua công cụ dòng lệnh gh.

Kết quả là các công cụ làm việc với tệp quen thuộc của Emacs như find-file, dired, tab-completion, hay dired-subtree đều hoạt động trơn tru trên một kho lưu trữ GitHub từ xa. Lưu ý rằng hiện tại công cụ này hoạt động ở chế độ chỉ đọc (read-only).

Tại sao nên sử dụng?

Đôi khi bạn chỉ muốn xem mã nguồn, kiểm tra chữ ký của một hàm, đọc tệp README hoặc duyệt cấu trúc dự án. Việc clone toàn bộ kho chứa cho những mục đích này là quá mức cần thiết; nó tốn dung lượng đĩa, tạo ra thêm các thư mục cần quản lý và làm gián đoạn luồng làm việc của bạn.

Cách hoạt động

Khi truy cập lần đầu vào bất kỳ tệp nào trong kho, toàn bộ cây thư mục sẽ được lấy về qua Git Trees API (một cuộc gọi HTTP). Sau đó:

• Liệt kê thư mục, kiểm tra tệp tồn tại, và tự động hoàn thành đều được phục vụ từ cây thư mục được lưu trong bộ nhớ đệm.
• Nội dung tệp chỉ được tải khi bạn thực sự mở tệp đó.
• Nội dung được lưu cache theo mã băm SHA, nên việc mở lại cùng một tệp là tức thì.
• Xác thực, SSO và các kho lưu trữ riêng tư đều được xử lý minh bạch bởi gh.

Cài đặt và Sử dụng

Hiện tại gói này chưa có trên MELPA, bạn có thể cài đặt thông qua use-package và straight:

(use-package remoto
  :straight (:host github :repo "agzam/remoto.el")
  :demand t)

Các lệnh chính

• remoto-browse: Điểm nhập chính. Nó chấp nhận mọi định dạng URL GitHub:

  • M-x remoto-browse RET https://github.com/torvalds/linux RET
  • M-x remoto-browse RET [email protected]:torvalds/linux.git RET
  • M-x remoto-browse RET torvalds/linux RET

• Tự động phát hiện trong Dired và find-file: Bạn cũng có thể nhập trực tiếp URL vào các lệnh tiêu chuẩn:

  • C-x d /github.com/torvalds/linux RET
  • C-x C-f https://github.com/torvalds/linux/blob/master/README RET

Hệ thống tệp ảo sử dụng đường dẫn theo định dạng: /github:OWNER/REPO@REF:/PATH.

Tại sao không sử dụng backend TRAMP?

TRAMP về cơ bản là một sự trừu tượng hóa shell-over-transport. Mọi backend TRAMP đều giả định một shell từ xa ở phía bên kia, trong khi remoto.el không có shell từ xa.

• API của backend TRAMP rất lớn, yêu cầu triển khai hoặc giả lập hàng chục thao tác.
• Quản lý kết nối của TRAMP được xây dựng xung quanh các phiên liên tục, trong khi GitHub API là HTTP stateless.
• Lớp cache của TRAMP dựa trên đường dẫn và mỗi kết nối, trong khi mô hình cây cache của remoto (một cuộc gọi API lấy toàn bộ cây) hiệu quả hơn nhiều cho API dạng cây chỉ đọc.

Hạn chế

• Chỉ đọc: Không thể commit, push hay sửa đổi tệp.
• Không có các thao tác git như log, blame, diff.
• Dấu thời gian trong dired là tổng hợp (do API cây không cung cấp dấu thời gian).
• Các kho chứa rất lớn (100k+ tệp) sẽ sử dụng cơ chế lấy theo từng thư mục chậm hơn.
• Giới hạn tốc độ: 5.000 yêu cầu/giờ (nhưng duyệt thông thường vẫn nằm trong giới hạn này).

Remoto.el là một công cụ hữu ích cho các lập trình viên sử dụng Emacs, giúp tối ưu hóa quy trình làm việc khi cần tham khảo mã nguồn nhanh chóng.