graphql-zeus icon indicating copy to clipboard operation
graphql-zeus copied to clipboard

Renaming and Exporting

Open seanonthenet opened this issue 2 years ago • 2 comments

A suggestion for 5.0... 🤗

Unless using another client (Apollo, React Query) then the Chain client (and Subscription) is the main "entry point" into Zeus for users but it's hidden way down at the bottom of the generated index.ts.

It might be better if there was another zeusTools.ts generated file with Chain, Thunder, Subscription, Zeus, etc... functions exported there and all commented nicely with how to use them and with links to documentation too. (I can help with more documentation)

Also, it might be better for consistency, UX and brand that these tools are all given similar and more explanatory names. eg:

Chain => zeusClient Thunder => zeusFetch Subscription => zeusSubscription Zeus => zeusGenerateGql Selector => zeusSelector etc...

also with lowercase first letters so they don't look like classes or types.

Also wondering if renaming the Types would be beneficial too? eg: GraphQLTypes => ZeusGraphQLTypes ModelTypes => ZeusModelTypes ValueTypes => ZeusValueTypes

seanonthenet avatar Apr 17 '22 11:04 seanonthenet

Good idea we can work on it in 5.0!

aexol avatar Apr 19 '22 12:04 aexol

NICE!

seanonthenet avatar Apr 19 '22 15:04 seanonthenet