From 3a66e42cd529a3a085f84b91cf97a8797988bf60 Mon Sep 17 00:00:00 2001 From: Matt Enlow Date: Tue, 27 Aug 2024 10:03:01 -0600 Subject: [PATCH] reword warning to list examples of breakages --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 39c2592..c235065 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,6 @@ Ultimately Styler is @adobe's internal tool that we're happy to share with the w ## WARNING: Styler can change the behaviour of your program! In some cases, this can introduce bugs. It goes without saying, but look over your changes before committing to main :) -(Here's an [example issue](https://github.com/adobe/elixir-styler/issues/186) where Styler unexpectedly changed the behaviour of a user's program.) A simple example of a way Styler changes the behaviour of code is the following rewrite: @@ -115,6 +114,12 @@ end Also good style! But Styler assumes that most of the time people just meant the `if` equivalent of the code, and so makes that change. If issues like this bother you, Styler probably isn't the tool you're looking for. +Other ways Styler can change your program: + +- [`with` statement rewrites](https://github.com/adobe/elixir-styler/issues/186) +- [config file sorting](https://hexdocs.pm/styler/mix_configs.html#this-can-break-your-program) +- and likely other ways. stay safe out there! + ## Thanks & Inspiration ### [Sourceror](https://github.com/doorgan/sourceror/)