cake-build / cake-build/cake

Look for cake.ini instead of cake.config

Open
#1,911 15 comments 2 reactions 0 assignees View on GitHub
Help wanted Improvement Up-for-grabs
Dominant language
C#
Stars
4.2k
Forks
778
Avg merge
3h 37m
Merged PRs (30d)
21

Description

The current format for the Cake configuration file `cake.config` is that of the [INI file format](https://en.wikipedia.org/wiki/INI_file). Its `.config` extension makes many text editors syntax highlight it wrong, or report errors, or as Visual Studio does, both,

![cake.config](https://user-images.githubusercontent.com/7352580/32405678-ea672026-c18f-11e7-944f-4347a07da59d.png)

![cake.ini](https://user-images.githubusercontent.com/7352580/32405679-ee7b5c5e-c18f-11e7-9e89-0c61e16ad133.png)

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.

Contributor guide

Open the contributing guide

Research direction

Start by locating the configuration-file lookup that currently searches for cake.config, then trace how the selected file is loaded and warnings are emitted. Compare the two proposed compatibility behaviors and verify that the chosen behavior prefers cake.ini while preserving or warning about cake.config.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
build-system, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.