SSkilnexa
SkillKỹ thuật phần mềmHợp với: Lập trình viênMức: Kỹ thuật

Đổi bản review mã Markdown thành trang HTML 2 cột

md-review

Chuyển bài review PR có khối diff và nhãn mức độ (BLOCKER, MAJOR...) thành trang HTML: diff bên trái, thẻ nhận xét bên phải, mục lục lỗi, bắt buộc ghi tên người review.

Tải miễn phí. Theo dõi Skilnexa một lần là mở khoá mọi lượt tải trên web.

Nút theo dõi đang được chuẩn bị.
Link tải đang được chuẩn bị.

Nó là gì

Đổi bản review code viết bằng Markdown, có khối diff và nhãn mức độ như BLOCKER, MAJOR, thành trang HTML hai cột: diff bên trái, ghi chú bên phải. Dành cho lập trình viên hoặc người review PR; bắt buộc phải ghi tên người review.

Hoạt động ra sao

Bạn đưa file Markdown, tên người review và tiêu đề PR. Công cụ tách các khối diff theo từng hunk, gắn ghi chú có nhãn mức độ vào đúng chỗ, rồi dựng HTML hai cột có thanh nhảy nhanh ở đầu. Nếu file không có khối diff, công cụ từ chối và gợi ý dùng md-document.

Ví dụ ứng dụng

Tình huống
Anh Tuấn gửi PR thêm logic thử lại khi gọi API thanh toán, cần người review Lan ký duyệt.
Bạn đưa vào
File pr-retry.md có khối diff, các ghi chú MAJOR, tên người review là Lan và tiêu đề PR.
Bạn nhận được
File review-pr-retry.html có thanh nhảy tới các ghi chú MAJOR, diff hai cột và chân trang ghi tên Lan.

Ví dụ minh họa theo quy trình trong tài liệu gốc, chưa phải kết quả thử chạy.

Dùng khi nào

Khi muốn gửi bản review mã dễ đọc cho cả nhóm xem.

Các phần chính trong hướng dẫn

  1. Khi nào dùng
  2. Quy trình xử lý
  3. Nội dung được dựng ra
  4. Quy tắc bắt buộc
  5. Tệp đầu ra
Xem mô tả gốc của tác giả (tiếng Anh)

Converts a markdown PR writeup or code review (one with ```diff fenced blocks and severity-tagged > [!BLOCKER]/[!MAJOR]/[!MINOR]/[!NIT] callouts) into a single-file 2-column HTML review — unified-diff on the left, severity-tagged annotation cards on the right, top jump-nav listing every finding, mandatory named reviewer footer. Triggers when the markdown-html-orchestrator classifies an input as REVIEW, or when invoked directly via /cs:md-review. Refuses without explicit --reviewer (a code review must name a human), refuses if no diff hunks present (route to md-document instead), and refuses to encode severity in color only (every badge ships color + icon + aria-label per WCAG 1.4.1). Use after orchestrator routing.

Chi tiết tính năng

  • {default_output_dir}/review-{slug}.html (path resolved by orchestrator's output_path_resolver.py; collision suffix -2, -3, … by default).

Cùng nhóm Kỹ thuật phần mềm

Phần giải thích do Skilnexa viết sau khi đọc toàn bộ tài liệu gốc của tác giả và đã đối chiếu lại với nội dung gốc. Chưa phải kết quả thử chạy, nên hãy thử bằng dữ liệu giả trước khi dùng cho việc thật.