`clojure-project-root-path` returns wrong value

[bolivier]

Expected behavior

When I am in a file src/app/project.clj in a deps.edn project, clojure-project-root-path returns my root directory.

Actual behavior

clojure-project-root-path interprets this as a leiningen project and returns the current (nested) directory.

Steps to reproduce the problem

See the repo https://github.com/bolivier/clojure-mode-root-dir-bug

Environment & Version information

Linux

cider 1.18.0-snapshot

clojure-mode version

clojure-mode (5.20.0-snapshot)

Emacs version

30.1

Operating system

Arch Linux

[bolivier]

A different selection method here (maybe shortest path?) would fix this

    (when (> (length choices) 0)
      (car (sort choices #'file-in-directory-p)))

My short-term immediate fix was to replace that with this

(when (> (length choices) 0)
        (car (sort choices)))

[svantevonerichsen6906]

To be honest, I would expect the actual behaviour.

[bolivier]

It seems incorrect to say that a root directory is some directory inside my project with a confusingly named file vs the root of my project where a deps.edn file and .git directory are.

Is there a case where the current behavior would be correct? Nested projects, I guess?

[svantevonerichsen6906]

I understand that feeling, but I'd understand the following feeling just the same:

»It seems incorrect to say that the root directory is some directory outside of my project, just because some kind of project marker with somehow higher priority is found there. Where is that priority defined anyway?«

I think the actual problem is not priorities or search order, but incorrect file identification. The algorithm would need to look closer, e. g. looking for a toplevel defproject form inside the file.

A more flexible way might be to use dir-locals to explicitly specify the project root.