[FEATURE]: Improve handling of mix-case words

Aberta
#116 6 comentários 1 reação 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
57/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
rust
Domínio
tooling

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Rust
Estrelas
925
Forks
59
Merge médio
53min
PRs com merge (30d)
10

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de blopker/codebook

Todas as issues de blopker/codebook

Issues semelhantes

Mais issues de Rust

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.