Possible improvements

[fvvliet]

Hello Ryan,

First of all I want to tell you UncrustifyX is a great tool ! I use it config Uncrustify for formatting Objective-C sources.

I have some suggestions for improvement (possibly because I don't fully understand the usage of UncrustifyX yet):

• A 'Getting Started' instruction video/manual how to use UncrustifyX.
• The usage of the preview in the documentation window: most of the time nothing happens in the preview window when changing a setting. Do I have to include my own source file in the preview to see the effects ?
• Make the list of options expand/collapse by clicking on categories

Thank you for any advice Frank

[ryanmaxwell]

Thank you for your feedback and suggestions. I basically built this tool for myself as I often prefer to use a GUI tool that wraps a command line tool, as I'm too lazy to remember the exact commands. I also found that uncrustify itself had far too many options and was tedious for me to test them all quickly to figure out how they behaved.

So I'm all for making the tool as easy as possible to use. Documentation is always a chore, and I find most people don't read it anyway, so it's best to just make the tool as obvious as possible.

The intention of the preview snippets is to have a piece of code handy to try a configuration option on. However, as you noted, often nothing will happen - due to the option you are choosing not being applicable for the code shown. I would really like to increase the amount of code samples included, and make them more diverse. I haven't even included samples for some languages, (e.g pawn/vala) as I don't write in them personally.

I will also try and document how you can customize the code samples. Right now all the data lives within UncrustifyX.app/Contents/Resources/Definitions.plist - If you update/add anything in there, and adjust the "UpdatedAt" value to a more recent date - the new data will be imported when you launch the app.

[ryanmaxwell]

One warning if you customize your data by editing the bundled Definitions.plist - It will be overwritten by an app upgrade. When I get around to documenting this, I'll place the file into ~/Library/...