[FEATURE]: Improve handling of mix-case words

オープン
#116 コメント 6 件 リアクション 1 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
57/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
rust
領域
tooling

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Rust
スター
925
フォーク
59
平均マージ
53分
マージ済み PR(30日)
10

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

blopker/codebook のほかの issue

blopker/codebook の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。