DocCoverage là một trình phân tích tự động quét codebase của bạn để xác định các tài liệu còn thiếu, docstrings không đầy đủ và các lỗ hổng chất lượng trên nhiều ngôn ngữ lập trình.
Cài đặt & Tải xuống
1. ClawHub CLI
Cách nhanh nhất để cài đặt kỹ năng trực tiếp từ thư viện.
npx clawhub@latest install doccoverage
2. Cài đặt Thủ công
Sao chép thư mục kỹ năng vào một trong những vị trí sau
~/.openclaw/skills/ <project>/skills/ Ưu tiên: Không gian làm việc > Cục bộ > Gói sẵn
3. Cài đặt Prompt
Sao chép prompt này vào OpenClaw để tự động cài đặt.
Giúp tôi cài đặt doccoverage bằng Clawhub. Nếu Clawhub chưa
Bạn muốn tải xuống?
Nhận các tệp kỹ năng gốc dưới dạng lưu trữ ZIP.
DocCoverage là gì?
DocCoverage là một công cụ kiểm tra tài liệu toàn diện được thiết kế để duy trì các codebase chất lượng cao. Là một trong những Openclaw Skills thực tế nhất, nó đánh giá mã nguồn của bạn để tìm các phần JSDoc, docstrings và README bị thiếu. Nó hỗ trợ các ngôn ngữ chính bao gồm JavaScript, TypeScript, Python, Go, Java và Ruby, đảm bảo rằng các hàm công khai và kiểu xuất khẩu được giải thích đúng cách.
Bằng cách tận dụng so khớp mẫu dựa trên regex với hơn 85 tiêu chuẩn tài liệu, kỹ năng này giúp các nhà phát triển thu hẹp khoảng cách giữa mã nguồn và tài liệu. Cho dù bạn đang quản lý một dự án solo hay một kho lưu trữ doanh nghiệp lớn, DocCoverage đều cung cấp điểm số hành động và các bước khắc phục để cải thiện sức khỏe tổng thể của tài liệu dự án.
Trường hợp sử dụng DocCoverage
- Xác định các hàm công khai hoặc lớp đã xuất không được ghi lại trong các kho lưu trữ lớn.
- Kiểm tra các tệp README và CHANGELOG để tìm các phần bị thiếu hoặc phiên bản không nhất quán.
- Thực thi các tiêu chuẩn tài liệu trước khi mã được commit vào kiểm soát phiên bản bằng cách sử dụng pre-commit hooks.
- Tạo báo cáo độ bao phủ tài liệu chi tiết cho các cuộc kiểm tra tiêu chuẩn nhóm.
- Phát hiện các chú thích dư thừa, TODO không có tham chiếu vé hoặc các khối mã bị chú thích.
Cách thức hoạt động của DocCoverage
- Kỹ năng xác định các tệp hoặc thư mục mục tiêu và tự động phát hiện ngôn ngữ lập trình dựa trên phần mở rộng tệp.
- Nó thực thi hơn 85 mẫu chất lượng tài liệu để quét các docstrings bị thiếu, thiếu tham số hoặc mô tả trả về không đầy đủ.
- Điểm độ bao phủ tài liệu từ 0 đến 100 được tính bằng cách khấu trừ điểm dựa trên mức độ nghiêm trọng của các vấn đề được xác định.
- Các phát hiện chi tiết được báo cáo cho người dùng, bao gồm số dòng, ID kiểm tra, cấp độ nghiêm trọng và các đề xuất cụ thể để cải thiện.
- Đối với các cấp độ nâng cao, kết quả có thể được tích hợp vào git hooks hoặc xuất dưới dạng tệp SARIF để tích hợp liền mạch vào quy trình CI/CD.
Cài đặt DocCoverage
Để bắt đầu sử dụng tiện ích bổ sung này cho Openclaw Skills của bạn, hãy làm theo các bước cài đặt sau:
# Cài đặt trình quản lý git hooks bắt buộc (tùy chọn cho gói miễn phí)
brew install lefthook
# Cấu hình khóa giấy phép của bạn trong tệp cấu hình cục bộ
# Đường dẫn: ~\/.openclaw\/openclaw.json
# Chạy quét thủ công trên thư mục hiện tại của bạn
bash "<SKILL_DIR>\/scripts\/doccoverage.sh" scan .
Lược đồ dữ liệu & Hệ thống phân loại của DocCoverage
DocCoverage tổ chức các phát hiện của mình dựa trên hệ thống chấm điểm có cấu trúc và phân loại siêu dữ liệu:
| Danh mục | Chi tiết |
|---|---|
| Hệ thống chấm điểm | Thang điểm 0-100; khấu trừ: Nghiêm trọng (25), Cao (15), Trung bình (8), Thấp (3). |
| Hỗ trợ tệp | Phân tích các tệp .js, .ts, .py, .go, .java, .rb và Markdown. |
| Định dạng đầu ra | Đầu ra console, báo cáo Markdown và SARIF 2.1.0 JSON. |
| Siêu dữ liệu | Bao gồm ID kiểm tra, đường dẫn tệp, số dòng và lời khuyên khắc phục. |
Tính năng Nâng cao của DocCoverage
- Tích hợp Git pre-commit hook thông qua Lefthook để chặn các commit chứa mã chưa ghi tài liệu.
- Thực thi chính sách tùy chỉnh dành riêng cho tổ chức đối với các tiêu chuẩn tài liệu độc đáo.
- Xác minh CHANGELOG tự động so với các thẻ git để đảm bảo tính nhất quán của lịch sử phiên bản.
- Xác thực giấy phép ngoại tuyến đảm bảo không có mã nguồn nào được gửi đến máy chủ bên ngoài.
- Khả năng quét đa ngôn ngữ xử lý các kho lưu trữ polyglot trong một lần duy nhất.
SKILL.md
Đang tải
Các kỹ năng Openclaw liên quan
Trình theo dõi FuelWatch SA
Một nền tảng theo dõi nhiên liệu dựa trên cộng đồng, ưu tiên thiết bị di động, được thiết kế để giám sát giá cả và khả năng cung cấp trên khắp Nam Phi trong thời gian thiếu hụt nguồn cung.
Quy trình Phê duyệt Email
Một giao thức human-in-the-loop mạnh mẽ để các tác nhân AI soạn thảo, xem xét và gửi các giao tiếp chuyên nghiệp ra bên ngoài.
Khôi phục giới hạn tốc độ mô hình
Một khung kỹ thuật để chẩn đoán và khôi phục từ các giới hạn tốc độ của nhà cung cấp mô hình và lỗi 429 nhằm duy trì thời gian hoạt động của agent.
Affiliate Marketing Optimizer
Một công cụ tự động được thiết kế để tối đa hóa thu nhập từ tiếp thị liên kết thông qua việc lựa chọn sản phẩm dựa trên dữ liệu, tối ưu hóa liên kết và kiểm định tuân thủ.
Thiết lập Gmail + Gog
Kết nối AI Agents của bạn với Gmail bằng Gog CLI để kích hoạt tính năng tự động đọc email và xác thực hộp thư.
Giao diện Web Email
Một bảng điều khiển web tinh gọn để quản lý các tài khoản email của AI agent thông qua tích hợp Gmail và Gog CLI.
Đặc sắc*
