From cdc093ab719c41b436d17aeb3ec0c6edb7c6a43c Mon Sep 17 00:00:00 2001 From: Kevin Amado Date: Sun, 8 Dec 2024 19:55:13 -0700 Subject: [PATCH] doc: experimental configuration options --- README.md | 11 +++++++++-- alejandra.toml | 3 +++ 2 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 alejandra.toml diff --git a/README.md b/README.md index c513772..f4469eb 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,7 @@ who have used [Nix](https://nixos.org) at scale for several years, producing a very **well-grounded** [**style guide**](./STYLE.md). + For everything else, some pieces of the style are [configurable](#experimental-configuration-options). - ✔️ **Transparent** @@ -198,9 +199,15 @@ $ alejandra --help } ``` -## Do I need to configure anything? +## (experimental) Configuration Options -- No. +You can configure Alejandra through a file named `alejandra.toml`. +This file will be automatically detected if found in the same directory +where Alejandra is being run from, +or you can tell Alejandra to use a different location by using the +`--experimental-config ./path/to/alejandra.toml` flag in the CLI. + +You can find a full configuration file and the supported options here: [alejandra.toml](./alejandra.toml). ## Cool libraries diff --git a/alejandra.toml b/alejandra.toml new file mode 100644 index 0000000..868dd0b --- /dev/null +++ b/alejandra.toml @@ -0,0 +1,3 @@ +# (experimental) Configuration options for Alejandra + +indentation = "TwoSpaces" # Or: FourSpaces, Tabs