More clear instructions on how to add names (Products and Companies)

[warrenjokinen]

Feature Description

I would like Codebook to support...

The correction of the software product Tree-sitter from (at least) 3 incorrect versions:

tree-sitter
Treesitter
treesitter

More generally, I am new to Codebook and zed and don't know how to do this on my system, but this should apply to everybody(?)

Thanks for a great product!

Use Case

I want to add more unique words in the future.

Proposed Solution

Easier to make changes and share them to the community.

Alternative Solutions

No response

Examples

No response

Additional Context

No response

[blopker]

Hey! I'll add a note in the docs. However, due to the way code (mostly) doesn't conform to normal capitalization rules, Codebook suggestions try to replicate the capitalization of the misspelled word. I also have not tested adding words that are hyphenated to the allow list before, since Codebook may treat hyphens as a word separator, like a space.

In any case, the built-in allow list behaves exactly like the user-defined allow list in the codebook.toml file. The lists just get merged together. If adding a word there behaves like you'd expect, and it's a common enough word (like Tree-sitter), I'd be happy to add it to the built-in list.