projectile-get-immediate-sub-projects won't work with non-root argument

[milouse]

This issue is a copy of #1369 as I cannot re-open it. See the Discussion section to know more why I want to reopen it.

Expected behavior

(projectile-get-immediate-sub-projects "/project/a-sub-dir/")

should return a list of /project's sub-modules that are also within a-sub-dir/, nil if none.

Actual behavior

Returns non-existing paths, where each sub-module path is appended to /a-sub-dir.

Steps to reproduce the problem

1. Create a new git project in /project
2. Add a git-submodule "foo" to the project under /project/lib/foo
3. Add a folder to the project under /project/a-sub-dir
4. Execute the code above

You get ("/project/a-sub-dir/lib/foo") which is a non-existing path. Instead, you wanted nil because there is no submodule below /project/a-sub-dir.

Environment & Version information

Projectile version information

Projectile 20200329.1908

Emacs version

GNU Emacs 26.3 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.10) of 2019-08-29

Operating system

Archlinux

Discussion

There is already a MR to fix this problem: #1370. However, @bbatsov seems to reject it because

this command is generally supposed to be invoked in the root of a project, so I'm not certain if we'd be fixing a bug here.

But this command may be called from a non-root directory through usage of projectile-dir-files and projectile-dir-files-alien. Does it mean that these two commands must be used only from the project root directory?

The current behavior breaks projectile-rails (see asok/projectile-rails#132) for exemple. As the proposed fix is of very little impact, I would like to consider it again. Or at least ask to precise comment of projectile-dir-files to say it only works from the project root directory.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contribution and understanding!

[milouse]

… without any other argument, I imagine we’ll have to add-advice around this method in project using it…

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contribution and understanding!

[stale]

This issues been automatically closed due to lack of activity. Feel free to re-open it if you ever come back to it.