Merge branch 'main' into feature-timeout-syntax-check

Author: EbodShojaei

INSTALLATION.md

@@ -14,7 +14,7 @@ pip install mbake
 
 ### 2. Configuration
 
-Your configuration file is located at `~/.bake.toml`. It contains sensible defaults for Makefile formatting:
+Your configuration file is located at `{XDG_CONFIG_HOME}/bake.toml`. It contains sensible defaults for Makefile formatting:
 
 ```toml
 # Global settings
@@ -158,7 +158,7 @@ Once installed, the extension provides:
 Access these settings through VS Code preferences (`Cmd/Ctrl + ,`) and search for "bake":
 
 - **`bake.executablePath`**: Path to bake executable (default: `"bake"`)
-- **`bake.configPath`**: Path to config file (default: uses `~/.bake.toml`)
+- **`bake.configPath`**: Path to config file (default: uses `{XDG_CONFIG_HOME}/bake.toml`)
 - **`bake.formatOnSave`**: Auto-format on save (default: `false`)
 - **`bake.showDiff`**: Show diff when formatting (default: `false`)
 - **`bake.verbose`**: Enable verbose output (default: `false`)
@@ -232,12 +232,12 @@ bake_fmt/
 │   └── plugins/                   # Formatting rule plugins
 ├── tests/                         # Test suite
 ├── vscode-bake-extension/         # VS Code extension
-│   ├── package.json              # Extension manifest
-│   ├── extension.js              # Extension logic
-│   └── README.md                 # Extension documentation
-├── pyproject.toml                # Python package configuration
-├── .bake.toml.example            # Example configuration
-└── ~/.bake.toml                  # Your configuration file
+│   ├── package.json               # Extension manifest
+│   ├── extension.js               # Extension logic
+│   └── README.md                  # Extension documentation
+├── pyproject.toml                 # Python package configuration
+├── .bake.toml.example             # Example configuration
+└── {XDG_CONFIG_HOME}/bake.toml    # Your configuration file
 ```
 
 ## 🚀 Quick Start Examples
@@ -289,8 +289,9 @@ Now every time you save a Makefile, it's automatically formatted!
 
 **Configuration errors:**
 
-- Ensure `~/.bake.toml` exists and is valid TOML
-- Use the provided example: `cp .bake.toml.example ~/.bake.toml`
+- Ensure `{XDG_CONFIG_HOME}/bake.toml` exists and is valid TOML
+- Use the provided example: `cp .bake.toml.example ${XDG_CONFIG_HOME}/bake.toml`
+  or `cp .bake.toml.example ~/.config/bake.toml`
 
 ### VS Code Extension Issues
 

README.md

@@ -29,7 +29,7 @@
 - **Smart formatting**: Tabs for recipes, consistent spacing, line continuation cleanup
 - **Intelligent .PHONY detection**: Automatically identifies and manages phony targets
 - **Syntax validation**: Ensures Makefiles are valid before and after formatting
-- **Configurable rules**: Customize behavior via `~/.bake.toml`
+- **Configurable rules**: Customize behavior via `{XDG_CONFIG_HOME}/bake.toml`
 - **CI/CD ready**: Check mode for automated formatting validation
 - **VSCode extension**: Full editor integration available
 

mbake/cli.py

@@ -409,7 +409,9 @@ def format(
         10, "--timeout", help="Set timeout for Makefile syntax check"
     ),
     config_file: Optional[Path] = typer.Option(
-        None, "--config", help="Path to configuration file (default: ~/.bake.toml)."
+        None,
+        "--config",
+        help="Path to configuration file (default: {XDG_CONFIG_HOME}/bake.toml).",
     ),
     backup: bool = typer.Option(
         False, "--backup", "-b", help="Create backup files before formatting."

vscode-mbake-extension/README.md

@@ -59,7 +59,7 @@ Access these settings through VS Code's settings (`Cmd/Ctrl + ,`) and search for
 
 - **Type**: `string`
 - **Default**: `""`
-- **Description**: Path to the bake configuration file. Leave empty to use default (~/.bake.toml).
+- **Description**: Path to the bake configuration file. Leave empty to use default ({XDG_CONFIG_HOME}/bake.toml).
 
 ### `mbake.formatOnSave`
 
@@ -88,7 +88,7 @@ Add these settings to your VS Code `settings.json`:
 ```json
 {
     "mbake.executablePath": "/usr/local/bin/bake",
-    "mbake.configPath": "/path/to/your/.bake.toml",
+    "mbake.configPath": "/path/to/your/bake.toml",
     "mbake.formatOnSave": true,
     "mbake.verbose": true,
     "mbake.showDiff": false
@@ -183,7 +183,7 @@ bake --help
 
 If you see errors about missing configuration files, either:
 
-1. Create a `~/.bake.toml` configuration file
+1. Create a `{XDG_CONFIG_HOME}/bake.toml` configuration file
 2. Set a custom path in `mbake.configPath`
 3. Use the example configuration provided in the mbake repository
 
@@ -197,7 +197,7 @@ Make sure your file is recognized as a Makefile:
 
 ## Example Configuration File
 
-Create `~/.bake.toml` with these contents:
+Create `{XDG_CONFIG_HOME}/bake.toml` with these contents:
 
 ```toml
 # Global settings

vscode-mbake-extension/package.json

@@ -106,7 +106,7 @@
                 "mbake.configPath": {
                     "type": "string",
                     "default": "",
-                    "description": "Path to the bake configuration file. Leave empty to use default (~/.bake.toml)."
+                    "description": "Path to the bake configuration file. Leave empty to use default ({XDG_CONFIG_HOME}/bake.toml)."
                 },
                 "mbake.formatOnSave": {
                     "type": "boolean",
@@ -157,4 +157,4 @@
         "color": "#1e1e1e",
         "theme": "dark"
     }
-}
+}