cake-build/cake

Look for cake.ini instead of cake.config

Open

#1,911 opened on Nov 4, 2017

View on GitHub
 (15 comments) (2 reactions) (0 assignees)C# (3,742 stars) (738 forks)batch import
Help wantedImprovementUp-for-grabs

Description

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,

cake.config

cake.ini

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

Tech stack
csharp
Domain
build systemdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Cake build systemBasic C# knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Start by examining how Cake currently reads the configuration file, likely in `src/Cake.Core/Configuration/CakeConfiguration.cs`. The issue suggests adding support for `cake.ini` with preference over `cake.config` and emitting a warning if the old file is found. Review the comments in the issue for any discussed implementation details or edge cases.