v1.4.2: Upstream merge

.github/workflows/ci.yml

@@ -9,8 +9,13 @@ jobs:
     name: Ex${{matrix.elixir}}/OTP${{matrix.otp}}
     strategy:
       matrix:
-        elixir: ['1.15.7', '1.16.0', '1.17.0-rc.0']
-        otp: ['25.1.2']
+        elixir: ["1.15.8", "1.16.3", "1.17.3", "1.18.2"]
+        otp: ["25.3.2", "26.2.5", "27.2.4"]
+        exclude:
+          - elixir: "1.15.8"
+            otp: "27.2.4"
+          - elixir: "1.16.3"
+            otp: "27.2.4"
     steps:
       - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1

.tool-versions

@@ -1,2 +1,2 @@
-erlang 26.1.2
-elixir 1.16.0-otp-26
+elixir 1.18.2-otp-27
+erlang 27.2.3

CHANGELOG.md

@@ -4,6 +4,231 @@
 they can and will change without that change being reflected in Styler's semantic version.
 ## main
 
+## 1.4.2
+
+### Fixes
+
+- fix comment misplacement for large comment blocks in config files and `# styler:sort` (#230, h/t @cschmatzler)
+
+## 1.4.1
+
+### Improvements
+
+- `to_timeout/1` rewrites to use the next largest unit in some simple instances
+
+    ```elixir
+    # before
+    to_timeout(second: 60 * m)
+    to_timeout(day: 7)
+    # after
+    to_timeout(minute: m)
+    to_timeout(week: 1)
+    ```
+
+### Fixes
+
+- fixed styler raising when encountering invalid function definition ast
+
+## 1.4.0
+
+- A very nice change in alias lifting means Styler will make sure that your code is _using_ the aliases that it's specified.
+- Shoutout to the smartrent folks for finding pipifying recursion issues
+- Elixir 1.17 improvements and fixes
+- Elixir 1.19-dev: delete struct updates
+
+Read on for details.
+
+### Improvements
+
+#### Alias Lifting
+
+This release taught Styler to try just that little bit harder when doing alias lifting.
+
+- general improvements around conflict detection, lifting in more correct places and fewer incorrect places (#193, h/t @jsw800)
+- use knowledge of existing aliases to shorten invocations (#201, h/t me)
+
+    example:
+
+        alias A.B.C
+
+        A.B.C.foo()
+        A.B.C.bar()
+        A.B.C.baz()
+
+    becomes:
+
+        alias A.B.C
+
+        C.foo()
+        C.bar()
+        C.baz()
+
+#### Struct Updates => Map Updates
+
+1.19 deprecates struct update syntax in favor of map update syntax.
+
+```elixir
+# This
+%Struct{x | y}
+# Styles to this
+%{x | y}
+```
+
+**WARNING** Double check your diffs to make sure your variable is pattern matching against the same struct if you want to harness 1.19's type checking features. Apologies to folks who hoped Styler would do this step for you <3 (#199, h/t @SteffenDE)
+
+#### Ex1.17+
+
+- Replace `:timer.units(x)` with the new `to_timeout(unit: x)` for `hours|minutes|seconds` (This style is only applied if you're on 1.17+)
+
+### Fixes
+
+- `pipes`: handle pipifying when the first arg is itself a pipe: `c(a |> b, d)` => `a |> b() |> c(d)` (#214, h/t @kybishop)
+- `pipes`: handle pipifying nested functions `d(c(a |> b))` => `a |> b |> c() |> d` (#216, h/t @emkguts)
+- `with`: fix a stabby `with` `, else: (_ -> :ok)` being rewritten to a case (#219, h/t @iamhassangm)
+
+## 1.3.3
+
+### Improvements
+
+- `with do: body` and variations with no arrows in the head will be rewritten to just `body`
+- `# styler:sort` will sort arbitrary ast nodes within a `do end` block:
+
+    Given:
+
+        # styler:sort
+        my_macro "some arg" do
+          another_macro :q
+          another_macro :w
+          another_macro :e
+          another_macro :r
+          another_macro :t
+          another_macro :y
+        end
+
+    We get
+
+        # styler:sort
+        my_macro "some arg" do
+          another_macro :e
+          another_macro :q
+          another_macro :r
+          another_macro :t
+          another_macro :w
+          another_macro :y
+        end
+
+### Fixes
+
+- fix a bug in comment-movement when multiple `# styler:sort` directives are added to a file at the same time
+
+## 1.3.2
+
+### Improvements
+
+- `# styler:sort` can be used to sort values of key-value pairs. eg, sort the value of a single key in a map (Closes #208, h/t @ypconstante)
+
+## 1.3.1
+
+### Improvements
+
+- `# styler:sort` now works with maps and the `defstruct` macro
+
+### Fixes
+
+- `# styler:sort` no longer blows up on keyword lists :X
+
+## 1.3.0
+
+### Improvements
+
+#### `# styler:sort` Styler's first comment directive
+
+Styler will now keep a user-designated list or wordlist (`~w` sigil) sorted as part of formatting via the use of comments. Elements of the list are sorted by their string representation.
+
+The intention is to remove comments to humans, like `# Please keep this list sorted!`, in favor of comments to robots: `# styler:sort`. Personally speaking, Styler is much better at alphabetical-order than I ever will be.
+
+To use the new directive, put it on the line before a list or wordlist.
+
+This example:
+
+```elixir
+# styler:sort
+[:c, :a, :b]
+
+# styler:sort
+~w(a list of words)
+
+# styler:sort
+@country_codes ~w(
+  en_US
+  po_PO
+  fr_CA
+  ja_JP
+)
+
+# styler:sort
+a_var =
+  [
+    Modules,
+    In,
+    A,
+    List
+  ]
+```
+
+Would yield:
+
+```elixir
+# styler:sort
+[:a, :b, :c]
+
+# styler:sort
+~w(a list of words)
+
+# styler:sort
+@country_codes ~w(
+  en_US
+  fr_CA
+  ja_JP
+  po_PO
+)
+
+# styler:sort
+a_var =
+  [
+    A,
+    In,
+    List,
+    Modules
+  ]
+```
+
+## 1.2.1
+
+### Fixes
+
+* `|>` don't pipify when the call is itself in a pipe (aka don't touch `a |> b(c |> d() |>e()) |> f()`) (Closes #204, h/t @paulswartz)
+
+## 1.2.0
+
+### Improvements
+
+* `pipes`: pipe-ifies when first arg to a function is a pipe. reach out if this happens in unstylish places in your code (Closes #133)
+* `pipes`: unpiping assignments will make the assignment one-line when possible (Closes #181)
+* `deprecations`: 1.18 deprecations
+    * `List.zip` => `Enum.zip`
+    * `first..last = range` => `first..last//_ = range`
+
+### Fixes
+
+* `pipes`: optimizations are less likely to move comments (Closes #176)
+
+## 1.1.2
+
+### Improvements
+
+* Config Sorting: improve comment handling when only sorting a few nodes (Closes #187)
+
 ## 1.1.1
 
 ### Improvements

README.md

@@ -11,17 +11,18 @@ You can learn more about the history, purpose and implementation of Styler from
 
 ## Features
 
-- auto-fixes [many credo rules](docs/credo.md), meaning you can turn them off to speed credo up
-- [keeps a strict module layout](docs/module_directives.md#directive-organization)
-  - alphabetizes module directives
-- [extracts repeated aliases](docs/module_directives.md#alias-lifting)
-- [makes your pipe chains pretty as can be](docs/pipes.md)
-  - pipes and unpipes function calls based on the number of calls
-  - optimizes standard library calls (`a |> Enum.map(m) |> Enum.into(Map.new)` => `Map.new(a, m)`)
-- replaces strings with sigils when the string has many escaped quotes
-- ... and so much more
-
-[See our Rewrites documentation on hexdocs](https://hexdocs.pm/styler/styles.html)
+Styler fixes a plethora of elixir style and optimization issues automatically as part of mix format.
+
+[See Styler's documentation on Hex](https://hexdocs.pm/styler/styles.html) for the comprehensive list of its features.
+
+The fastest way to see what all it can do you for you is to just try it out in your codebase... but here's a list of a few features to help you decide if you're interested in Styler:
+
+- sorts and organizes `import`/`alias`/`require` and other [module directives](docs/module_directives.md)
+- keeps lists, sigils, and even arbitrary code sorted with the `# styler:sort` [comment directive](docs/comment_directives.md)
+- automatically creates aliases for repeatedly referenced modules names ([_"alias lifting"_](docs/module_directives.md#alias-lifting))
+- optimizes pipe chains for [readability and performance](docs/pipes.md)
+- rewrites strings as sigils when it results in fewer escapes
+- auto-fixes [many credo rules](docs/credo.md), meaning you can spend less time fighting with CI
 
 ## Who is Styler for?
 
@@ -41,7 +42,7 @@ Add `:styler` as a dependency to your project's `mix.exs`:
 ```elixir
 def deps do
   [
-    {:styler, "~> 1.1", only: [:dev, :test], runtime: false},
+    {:styler, "~> 1.4", only: [:dev, :test], runtime: false},
   ]
 end
 ```
@@ -75,10 +76,54 @@ Styler's only current configuration option is `:alias_lifting_exclude`, which ac
 
 #### No Credo-Style Enable/Disable
 
-Styler [will not add configuration](https://github.com/adobe/elixir-styler/pull/127#issuecomment-1912242143) for ad-hoc enabling/disabling of rewrites. Sorry! Its implementation simply does not support that approach. There are however many forks out there that have attempted this; please explore the [Github forks tab](https://github.com/adobe/elixir-styler/forks) to see if there's a project that suits your needs or that you can draw inspiration from.
+Styler [will not add configuration](https://github.com/adobe/elixir-styler/pull/127#issuecomment-1912242143) for ad-hoc enabling/disabling of rewrites. Sorry!
+
+However, Smartrent has a fork of Styler named [Quokka](https://github.com/smartrent/quokka) that allows for finegrained control of Styler. Maybe it's what you're looking for. If not, you can always fork it or Styler as a starting point for your own tool!
 
 Ultimately Styler is @adobe's internal tool that we're happy to share with the world. We're delighted if you like it as is, and just as excited if it's a starting point for you to make something even better for yourself.
 
+## 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 :)
+
+A simple example of a way Styler changes the behaviour of code is the following rewrite:
+
+```elixir
+# Before: this case statement...
+case foo do
+  true -> :ok
+  false -> :error
+end
+
+# After: ... is rewritten by Styler to be an if statement!.
+if foo do
+  :ok
+else
+  :error
+end
+```
+
+These programs are not semantically equivalent. The former would raise if `foo` returned any value other than `true` or `false`, while the latter blissfully completes.
+
+However, Styler is about _style_, and the `if` statement is (in our opinion) of much better style. If the exception behaviour was intentional on the code author's part, they should have written the program like this:
+
+```elixir
+case foo do
+  true -> :ok
+  false -> :error
+  other -> raise "expected `true` or `false`, got: #{inspect other}"
+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!
+
+>>>>>>> upstream/main
 ## Thanks & Inspiration
 
 ### [Sourceror](https://github.com/doorgan/sourceror/)