disable spell check for go package names

[pseidemann]

dear devs,

according to the official go package name conventions, go package names are often compressed/abbreviated and thus are by definition not real words.

I would like to request to include an option to disable spell checking of go package names altogether.
wrong spelling hints for packages can be very annoying because the package name precedes any const/variable/function/type used of a package (importing packages directly without the namespace is possible but discouraged in go).

here are some examples of standard library go packages which have wrong spelling according to the extension today:

• hash/maphash
• net/netip
• testing/fstest
• time/tzdata

from: https://pkg.go.dev/std

as can be seen, they don't try to be real words but are still readable to a developer knowing the (go) context.

[Jason3S]

@pseidemann,

Thank you for the detailed description. I think this is related to #12

[pseidemann]

@Jason3S,
yes, good point. I think additionally to package names, also the whole import path of a package should not be spell checked

[jeremiah-snee-openx]

Yes, was just thinking of writing similar ticket. cspell should have config option to auto parse/ import dependency files.
For nodejs/ typescript projects from package.json pulling name (used throughout monorepos) dependencies.keys [], devDependencies.keys, and peerDependency [].

[pseidemann]

@jeremiah-snee-openx,
I think this would go too far for a spell checker, because it would then need to be aware of dependency management of any programming language it wants to support. also note that some languages have multiple dependency management mechanisms (most notably python, also go in the past; both got better).

I think it would be more sustainable if the spell checker would be aware of the grammar of the language itself and just "knows" that an import is an import and that it doesn't need to spell check it. this logic could be applied to all languages.

that imports are correct should be checked by your IDE or similar tools.
e.g. go has a tool (goimports) which adds imports automatically so you don't need to type or spell check anything.

imo typos in import paths are not spell errors but simple programming errors and should be detected otherwise.

[Jason3S]

@jeremiah-snee-openx,

Some larger repos have written their own scanning tool to generate a dictionary based upon the packages used by the repo. Often these are best written in the native language so that reflection can be used. An example of on-the-fly is discussed here: #3215 (comment)

As @pseidemann points out, the better long term solution is to enhance the spell checker parsing so that it can ignore imports. Enhancing the parser also brings the added benefits of more control over what is checked and how, like string, comments, variable names. It would be possible to have comments in English while the strings are in French.