[ARM]: Extend linting rule of arm-resource-key-invalid-chars to report invalid words

[raych1]

Clear and concise description of the problem

Context Currently for any invalid words defined as model/parameter names in the typespec/swagger, we need to add suppressions in two places:

• custom-words.txt in the spec repo.
• cspell.json in the azure-sdk-for-net repo.

We propose extending the current lint rule arm-resource-key-invalid-chars or adding a new lint rule to validate these words. This would allow the suppression in typespec to be carried over and consumed by the downstream SDK emitters. With this, we can avoid the need for multiple suppressions for the same word.

Example Looking at the following oracle typespec, where the key is defined as adbscharsetname, an invalid word:

model AutonomousDatabaseCharacterSet
  is ProxyResource<AutonomousDatabaseCharacterSetProperties> {
  @doc("AutonomousDatabaseCharacterSet name")
  @key("adbscharsetname")
  @path
  @segment("autonomousDatabaseCharacterSets")
  @pattern(".*")
  name: string;
}

Currently, the suppression must be added to both the spec repo at custom-words.txt and the azure-sdk-for-net repo at cspell.json

With this feature, we can keep the consistency across repositories.

//CC: @ArthurMa1978

Checklist

• [X] Follow our Code of Conduct
• [X] Check that this issue is about the Azure libraries for typespec. For feature request in the typespec language or core libraries file it in the TypeSpec repo
• [X] Read the docs.
• [X] Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

[raych1]

@allenjzhang @markcowl
do you think if the lint rule can be improved to cover this check?

[allenjzhang]

This is a bigger question around EngSys to ensure consistency between various SDK team owned repos. I am all for consistency though I suspect that they would be overlapping, or at best cases, rest-api spec repo being the common subset for each language repos.

@mikeharder, @weshaggard, your thoughts on this?

[weshaggard]

I tend to agree with @allenjzhang here that this is a larger issue and cannot easily be solved by adding a linting rule. We have long had an issue of duplication with our spelling dictionaries between the specs and language repos but have not yet found a great way to share a common dictionary. However, that said we currently only error on spelling issues if they are in the public APIs, if they are just in the text somewhere it is only a warning but ideally, we would also fix those warnings.

[mikeharder]

@raych1: In azure-rest-api-specs repo, please use file cSpell.json instead of custom-words.txt going forward.