[FEATURE]: Improve handling of mix-case words

Đang mở
#116 6 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
57/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
rust
Lĩnh vực
tooling

Hướng nghiên cứu

The issue points to crates/codebook/src/splitter.rs around lines 46–47. Read the splitter and trace how its configuration is defined and used, then check the related tests. Done looks like mixed-case words such as “PostgreSQL” are handled according to a configurable case-splitting choice without breaking existing behavior.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement
Feature Description

Hi! Thanks for a great bit of software, I've dropped nvim's built-in spellcheck due to issues with tree-sitter and I'm really liking using codebook-lsp instead!
That said, I've noticed that mixed-case words, such as "PostgreSQL", don't quite work as I would expect. This seems to be because the splitter code here is splitting on case changes.
It would be really great if there was a way to enable/disable case-based splitting to account for proper nouns such as "PostgreSQL" — a word that codebook knows about out-of-the-box!

I am not filing this is a bug because I don't think it's something not working as intended per-se, but you might prefer that it is one? Please let me know.

Use Case

In my case I have comments/docs that refer to PostgreSQL, and codebook detects that "Postgre" is not a word it knows, and helpfully offers to replace it with PostgreSQL, which then makes the word PostgreSQLSQL 😂 Which is, of course, still flagged as a mis-spelling.

Proposed Solution

The simplest solution is a config-driven toggle, to control whether the splitter splits on case boundaries at all?

Alternative Solutions

A more complicated solution would be to have the splitter return the whole word as the first potential split for case based splits (not just the individual parts), and if that happens (and is a valid word), then it could ignore the subsequent split elements?

Examples

This is an example of the problem, and what I'd like to see instead

Image

https://github.com/user-attachments/assets/0a61c7f4-91de-47fd-8bde-22e2601186cd

Additional Context

I am not really a rust dev, so I might have missed something very obvious when reading the code. That said, I am happy to try my hand at writing some rust for this as a PoC, if you'd want to see the code explored at least a little bit first.

Ngôn ngữ chính
Rust
Star
925
Fork
59
Merge trung bình
53 phút
Pull request đã merge (30 ngày)
10

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của blopker/codebook

Tất cả issue của blopker/codebook

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.