0

VietLint - Dự án Open Source kiểm tra tiếng Việt cho README, Docs và Markdown

VietLint - Mình đang xây dựng một linter cho tiếng Việt 🇻🇳

Xin chào mọi người,

Mình là 1 vibecoding dev của cũng là tác giả của VietLint, một dự án Open Source với mục tiêu mang khái niệm linting đến với tiếng Việt.

Repository:

https://github.com/NgoHuuLoc0612/vietlint

Ý tưởng

Trong thế giới lập trình, chúng ta có rất nhiều công cụ giúp cải thiện chất lượng mã nguồn:

  • ESLint cho JavaScript
  • Pylint cho Python
  • Clippy cho Rust
  • GolangCI-Lint cho Go

Nhưng đối với tiếng Việt trong:

  • README.md
  • Documentation
  • Markdown
  • Blog kỹ thuật
  • Comment source code

thì gần như chưa có công cụ chuyên biệt nào.

Đó là lý do VietLint ra đời.

VietLint làm gì?

Mục tiêu của VietLint là phát hiện và gợi ý sửa các lỗi phổ biến trong văn bản tiếng Việt.

Ví dụ:

ko biet cai nay

gợi ý thành:

không biết cái này

Hoặc:

mik dang code

gợi ý thành:

mình đang code

Trong tương lai, VietLint có thể hỗ trợ:

  • Chính tả
  • Từ viết tắt
  • Dấu câu
  • Quy tắc trình bày tài liệu
  • Chuẩn hóa văn phong kỹ thuật

Tại sao đây là một dự án thú vị?

Khác với nhiều dự án CRUD thông thường, VietLint nằm ở giao điểm của:

  • Software Engineering
  • Tooling
  • NLP (Natural Language Processing)
  • Developer Experience
  • LLVM
  • Clang
  • Tree-sitter
  • ONNX Runtime
  • LSP

Nó vừa là một công cụ hữu ích cho lập trình viên, vừa là nơi để thử nghiệm các ý tưởng xử lý ngôn ngữ tiếng Việt.

Mình đang cần contributor

Hiện tại dự án vẫn còn ở giai đoạn đầu và mình rất mong nhận được sự hỗ trợ từ cộng đồng. Mình biết là một mình mình không thể gánh hết project này, nên mình cần sự chung tay của cả cộng đồng.

Các lĩnh vực có thể tham gia:

Rule Engine

  • Phát hiện từ viết tắt
  • Phát hiện lỗi chính tả
  • Phát hiện lỗi dấu câu
  • Xây dựng hệ thống rule

Testing

  • Unit tests
  • Integration tests
  • Dataset kiểm thử tiếng Việt

CLI

  • Cải thiện trải nghiệm dòng lệnh
  • Tối ưu hiệu năng

Tooling

  • GitHub Actions
  • CI/CD
  • Packaging
  • Release automation

Documentation

  • Hướng dẫn sử dụng
  • Ví dụ thực tế
  • Tài liệu cho contributor

Người mới có thể tham gia không?

Có.

Mình rất hoan nghênh những bạn:

  • Chưa từng contribute Open Source
  • Muốn học GitHub Workflow
  • Muốn luyện kỹ năng code review
  • Muốn tham gia một dự án thực tế

Ngay cả việc sửa typo, bổ sung test hoặc cải thiện tài liệu cũng là những đóng góp rất giá trị.

Định hướng tương lai

Một số mục tiêu mình muốn thực hiện:

  • VS Code Extension
  • GitHub Action
  • Web Playground
  • Hệ thống plugin
  • Bộ rule mở rộng
  • Hỗ trợ nhiều loại tài liệu hơn

Tham gia cùng VietLint

Nếu bạn thấy ý tưởng này thú vị, hãy ghé thăm repository:

https://github.com/NgoHuuLoc0612/vietlint

Mọi issue, pull request, ý tưởng hoặc góp ý đều được chào đón.

Hy vọng VietLint có thể trở thành một công cụ hữu ích cho cộng đồng lập trình viên Việt Nam.

Mình xin chân thành cảm ơn mọi người!


All rights reserved

Viblo
Hãy đăng ký một tài khoản Viblo để nhận được nhiều bài viết thú vị hơn.
Đăng kí