Add heading error with explanation on how to fix it

StylianosGakis commented 1 year ago

🚀 Description

For cases where the heading is not set properly, the plugin will give a detailed explanation of what goes wrong and how to fix it. Addresses #1

You may want to edit the text provided and/or even add the groovy syntax describing how to fix the issue if you wish. For the text itself I think this should suffice but definitely feel free to suggest a better error message if you wish.

📄 Motivation and Context

See #1

🧪 How Has This Been Tested?

Inside module-graph/sample/build.gradle.kts, edit the moduleGraphConfig block and make a typo in the heading.set to be heading.set("### Dependency Diagrm") instead of heading.set("### Dependency Diagram"). Then run./gradlew :sample:createModuleGraph` Then you get a gradle error with the following message:

📦 Types of changes

[X] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

✅ Checklist

[X] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.

StylianosGakis commented 1 year ago

Sorry for the multiple pushes, this is now ready for review. I was changing my mind about the error message, but this is a good start now I think, you may want to change it, if so feel free to either do it yourself or tell me about it and I can push an update to the PR

iurysza commented 1 year ago

Looks great! I think we can merge it like that. 🎉

iurysza / module-graph