Cake: Look for cake.ini instead of cake.config

[RavinduL]

The current format for the Cake configuration file cake.config is that of the INI file format. Its .config extension makes many text editors syntax highlight it wrong, or report errors, or as Visual Studio does, both,

I propose to either,

• Change the name of the configuration file that Cake looks for, from cake.config to cake.ini, or (as this would require projects with unpinned versions of Cake to rename their files after updating / bootstrapping),

• Make Cake look for both cake.config and cake.ini files, with preference being for the latter, and a warning being emitted if it detects the former.

[gep13]

@RavinduL can you please confirm which editor you use to edit this file, typically?

[gep13]

@RavinduL also, can you confirm if you are using the Cake extension for that editor?

[RavinduL]

@gep13 I usually use Visual Studio, with the Cake for Visual Studio extension, or Visual Studio Code with the Cake extension.

The screenshots attached with https://github.com/cake-build/cake/issues/1911#issue-271191667 are of Visual Studio.

[gep13]

@RavinduL okay, perfect, thank you for letting me know.

[gep13]

@RavinduL we added ini support for the cake.config file in the recent release of the VSCode Extension for Cake. You can see this in action here:

https://youtu.be/ZgLWyIxFl8U

[RavinduL]

@gep13 syntax highlighting for Cake.config in VS Code! Nice 👍. Is a similar feature planned to be shipped with Cake for VS?

[gep13]

@RavinduL yes, that is the plan. Not sure when that will happen though.

[RavinduL]

@gep13 have you considered the second proposal at https://github.com/cake-build/cake/issues/1911#issue-271191667 wherein Cake could prefer a cake.ini file, but support both?

Doing so wouldn't require you to change the Visual Studio plugin, or develop plugins for _any_ text editor, for this purpose.

[gep13]

@RavinduL we have spoken about it, yes. However, this is more work than it sounds. For example that cake.config file is read by Cake, Cake.Bakery, within the Cake Extension for Visual Studio, etc. So changing it to be called cake.ini means updates to all of those other components. Not saying that might not do that work, but for now, it is easier to add this type of support to the editors we support rather than what you have suggested.

[gep13]

@RavinduL why did you close this issue?

As I said, I didn't say that we wouldn't do this, but rather, for now, it is more work than we want to take on immediately. The interim solution is to provide support for ini content in the supported editors.

[RavinduL]

@gep13 I see.
I apologize -- I misunderstood your intentions.

[gep13]

@RavinduL not a problem, just wanted to check 👍

[jnm2]

Usually having two ways of doing the same thing comes at a cost. I'd be against it.

[ramoneeza]

I have same problem.
But I use "Resharper" and It arises more problems with that file.

[patriksvensson]

@ramoneeza I don't know what the error is since I don't speal Spanish, but you can exclude that file in Resharper's settings.