[naming-convention] Update property schema to accept objects. Add prefix and suffix option

[eddeee888]

To make this rule more flexible, it needs to be able to take an object as well as format style string. For example, we might want to check whether a field has a certain suffix. More details: #195

The config is normalized into an object before passing into the validation function.

Note that we can no longer rely on the default enum check because it also tries to validate that an object is part of the enum. Therefore, the validation function needs to check the format enums now.

Also, added a suffix option. The targeted property must have the correct suffix or it will error.

TODO

• Update docs ?

[changeset-bot]

🦋 Changeset detected

Latest commit: 1177431

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages

Name	Type
@graphql-eslint/eslint-plugin	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[dotansimha]

Thanks @eddeee888 ! Sorry for the late reply. I will look into that and review in a few days :)

[dotansimha]

Looks great, thank you @eddeee888 . A few notes:

1. Please make sure to add a changeset (run yarn changeset and it will guide you). Please bump minor.
2. We have self-documenting rules now, so I had to make some changes to the rules definition, can you please rebase? (to run the docs generation, use yarn generate:docs.

[eddeee888]

Hi @dotansimha, thank you for your feedback! I have made some changes as suggested. Please let me know if you still see problems!

The only thing I'm not 100% sure about is the doc generation. I have run yarn generate:doc it but it looks like it's not handling the object case very well. Am I supposed to fill in the missing space?

[dotansimha]

Hi @dotansimha, thank you for your feedback! I have made some changes as suggested. Please let me know if you still see problems!

The only thing I'm not 100% sure about is the doc generation. I have run yarn generate:doc it but it looks like it's not handling the object case very well. Am I supposed to fill in the missing space?

Thank you so much!

It should be generated correctly, so maybe it's just something with the generation script. Can you please point me to the missing/incorrect generate doc? I will try to fix that.

[eddeee888]

Looking at the generated doc file, there are only headers with no expected values / comment in between:
https://github.com/dotansimha/graphql-eslint/blob/1764bca129cef8ac62ab38f9348757b601f5a822/docs/rules/naming-convention.md

Maybe it's how the doc generator works but maybe something like this communicates the config values a bit better? :)

#### `InputValueDefinition` (string,object)
- style: string, enum
  - `option1`
  - `option2`
  -  ...
- prefix: string
- suffix: string

[dotansimha]

Oh it should follow JSON schema structure, and I think declaring type: ['string', 'object'], along with properties isn't valid in this case. Also, there is a bug in the json-schema-to-markdown we are using (see saibotsivad/json-schema-to-markdown#15).

It seems like using definitions should fix that, but then it doesn't support enum correctly. I think eventually we'll have to switch to a different library, but I couldn't find one that is stable/maintained/output single-file.

I applied a workaround and it seems good enough for now. Thank you @eddeee888 !