kontent-ai / model-generator-net

Kontent.ai .NET model generator.
https://www.nuget.org/packages/Kontent.Ai.ModelGenerator
MIT License
17 stars 19 forks source link

Improve user experience #154

Closed Sevitas closed 1 year ago

Sevitas commented 2 years ago

Motivation

Improves user experience while running generation tool.

Proposed solution

1. Improve logging of intended model SDK with version

actual message:

16 content type models were successfully created.
CustomTypeProvider class was successfully created. 

proposed message:

16 content type models were successfully created.
CustomTypeProvider class was successfully created. 
Models were generated for Delivery/Management SDK version x.x.x

2. Introduce check for invalid parameters instead of ignoring them

We have 2 options for reacting to invalid character: a. Fail with an error message (breaking change) b. Display error message and continue with execution if possible

Additional context

Discovered while https://github.com/kontent-ai/management-sdk-net/issues/183

Sevitas commented 2 years ago

@Simply007 What do you think is the best option in: 2. Introduce check for invalid parameters instead of ignoring them?

Simply007 commented 2 years ago

I would say warning/error message and continue with execution if possible is better.