typos.toml configuration is too difficult

[aspizu]

Description

its not clear how to write a config to ignore a typo. the examples in readme are way too complex and confusing

[epage]

At https://github.com/crate-ci/typos?tab=readme-ov-file#false-positives, we show three different ways of doing this, which you use is dependent on your situation.

In understanding how to improve the documentation, it would help to know

• Whether you found that. If not, what path you followed
• What problems you have in understanding that

[aspizu]

I tried all the three methods, none of them worked. I use the vscode extension. also what is supposed to be the filename? .typos.toml or _typos.toml or typos.toml?

[epage]

Any of those file names work.

Can you provide reproduction steps with just the command line? I do not maintain any vscode extensions or use it, so I can't speak to that and its helpful to isolate parts of a system to figure out whats going wrong.

[s-banach]

How do I ignore the string "np.arange"? I can't figure it out from the documentation.

[epage]

As our dictionaries are focused on identifiers and words, that would require default.extend-ignore-re to write a custom regex.

[odinho]

Is there a way to fix strings though? Al = 'AI' in extend-words work well. But that will hit a bit many ID's or keys hard-coded in source files. So if possible it'd be nicer to do 'al chat -> AI Chat' and a few other real common mistakes. (I have no idea why people keep writing Al instead of AI, but it's really frustrating and can be hard to spot in UI-strings 😂).

Edit, found my answer:

#1018
#795

(Turns out I was only searching in PRs when searching for an issue about this, which is why I didn't find those :) )

[hemangandhi]

I think it'd be nice to just note the difference between words and identifiers next to the examples (with a link to details in https://github.com/crate-ci/typos/blob/master/docs/design.md#identifiers-and-words)

[epage]

Good idea, see c4bf6da and 7e5797c