clojure-emacs / cider

The Clojure Interactive Development Environment that Rocks for Emacs
https://cider.mx
GNU General Public License v3.0
3.55k stars 645 forks source link

Inconsistent indentation for custom threading macros #3684

Closed DerGuteMoritz closed 5 months ago

DerGuteMoritz commented 5 months ago

Expected behavior

Custom threading macros (like the ones found in promesa) should be indented like the ones from clojure.core when operands are given in separate lines, i.e. they should line up vertically like so:

(p/->> 1
       inc
       inc)

Actual behavior

Instead, CIDER indents such custom macros like a macro with a "head" form (e.g. like doto):

(p/->> 1
  inc
  inc)

This might be a regression of the fix introduced for #3490.

Steps to reproduce the problem

  1. Checkout https://github.com/bevuta/cider-inconsistent-indentation-for-custom-thrush-macros/ - this repo is a self-contained reproducer which doesn't rely on any external dependencies (such as promesa)
  2. Start a CIDER REPL via M-x cider-jack-in from the project root and select the clojure-cli command
  3. Open src/repro/core.clj and re-indent the main function in there
  4. As you can see, the p/ok->> form will be indented like clojure.core/->> but the p/not-ok->> form won't. If you look at their definitions in src/repro/p.cljc you can see that the only difference is that not-ok->> has a standalone first argument while ok->> doesn't. This also happens when renaming not-ok->> to just ->> (as is the case in promesa).

This also happens with ClojureScript which can be tested by M-x cider-jack-in-cljs and selecting the :main build.

Environment & Version information

CIDER version information

;; CIDER 1.13.1 (Santiago), nREPL 1.0.0
;; Clojure 1.11.1, Java 21

Lein / Clojure CLI version

Clojure CLI version 1.11.3.1463

Emacs version

GNU Emacs 29.3 (build 1, x86_64-pc-linux-gnu, X toolkit, cairo version 1.18.0, Xaw3d scroll bars)

Operating system

NixOS 24.05

JDK distribution

OpenJDK

vemv commented 5 months ago

Thanks, I'll check.

vemv commented 5 months ago

The bug is that one should be able to specify {:style/indent nil} and have cider-nrepl honor that explicit specification.

Most likely we conflate "nothing was specified at all" with "nil was specified".

I'll try to fix this in the first half of the week, please do ping us if that doesn't happen.

(PR also welcome for anyone wanting to grab it)

DerGuteMoritz commented 5 months ago

Friendly ping :smile: No hurry, though. I'll also try to look into it using your hint when I find some spare cycles again. But that might be a while.

vemv commented 5 months ago

You can check out https://github.com/clojure-emacs/cider-nrepl/commit/7fdca1335bcd51a10b883f301b00f89d620d6688 and run:

export LEIN_JVM_OPTS="-Dmranderson.internal.no-parallelism=true"
PROJECT_VERSION=0.49.0 make install

Change, if needed, 0.49.0 to whatever version of cider-nrepl you normally use.

Then, adding {:style/indent nil} should work.

LMK how it goes - thanks!

DerGuteMoritz commented 5 months ago

Thanks!

Then, adding {:style/indent nil} should work.

Where would I add that? To the macro's metadata? If so, then this won't do the trick for third-party macros, e.g. promesa.core/->>, right?

DerGuteMoritz commented 5 months ago

(Unless they are willing to include it upstream, that is)

vemv commented 5 months ago

To the macro's metadata?

Yes. You can alter-meta as a local experiment.

After we conclude it works, I can PR it myself in case a generous explanation helps th change making it in.