AlemTuzlak/kiira

🧪 Type-check code trong Markdown ngay trong editor

Kiira rút trích code TS/JS từ Markdown, kiểm tra kiểu và báo lỗi về đúng dòng nguồn.

Kiira là công cụ kiểm tra kiểu TypeScript & JavaScript trong tài liệu Markdown/MDX — chống lỗi sai khi copy-paste ví dụ. Hỗ trợ editor (VS Code), CLI (kiira check) và CI (GitHub Action). Phát hiện lỗi import, export, tên hàm/prop sai, code không hợp lệ.

✨ Điểm nổi bật

• Type-check trong Markdown: rút trích code fence TS/JS, kiểm tra kiểu ngay trong editor, CLI, CI.
• Metadata trên fence: ignore, validate=type|runtime|none, fixture=, name=, package=, group=.
• Gom nhóm snippet: dùng group= để kiểm tra nhiều fence liên quan; tự động phát hiện và --fix thêm nhãn.
• defaultGroup: "file": tự động gom mọi fence trong một file theo thứ tự.
• Hỗ trợ monorepo: tự động ánh xạ package workspace, không cần cấu hình paths.
• Per-glob overrides: thiết lập compiler options khác nhau cho từng nhóm file.
• VS Code extension: hiển thị lỗi ngay trong code fence.
• GitHub Action: AlemTuzlak/kiira@v1 cho CI.

💡 Vì sao đáng chú ý

Kiira không chỉ là linter Markdown — nó kiểm tra code trong tài liệu thực sự như một phần của dự án. Đây là giải pháp hoàn hảo cho docs-as-code, nơi tài liệu viết bởi AI thường gây lỗi API. Với hỗ trợ monorepo, VS Code và CI, Kiira giúp đảm bảo ví dụ luôn chạy được.

#TypeScript #Markdown #DocsAsCode #DeveloperTools #TiniX