Allow Function for :src-dir #1679
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make changes to projectile--find-matching file to the effect that it will circumvent any existing logic if it is detected that the src-dir property of the current project has been set to a function, in which case, that function is called instead with the path of the test file.
Add tests for projectile--test-name-for-impl-name, projectile--impl-file-from-src-dir-fn and add test for projectile--find-matching-file to check precedence logic is as expected.
Document usage and behaviour of the src-dir option allowing a function as a value.
LaurenceWarne
commented
Jun 23, 2021
|
|
||
| | :test | ||
| | A command to test the project. | ||
|
|
||
| | :test-dir | ||
| | A path, relative to the project root, where the test code lives. A function may also be specified which takes one parameter - the directory of a file, and it should return the directory in which the test file should reside. | ||
| | A path, relative to the project root, where the test code lives. A function may also be specified which takes one parameter - the directory of a file, and it should return the directory in which the test file should reside. This option is only used for implementation/test toggling. |
There was a problem hiding this comment.
From looking at the source, please correct me if this is wrong.
7133f61 to
70ff939
Compare
LaurenceWarne
commented
Jun 23, 2021
| src-dir | ||
| #'projectile--impl-name-for-test-name))) | ||
| (when (file-exists-p impl-file) | ||
| (file-relative-name impl-file (projectile-project-root))))))) |
There was a problem hiding this comment.
Pretty much projectile--test-file-from-test-dir-fn but with the lookup reversed and it's also checked that the implementation file exists.
LaurenceWarne
commented
Jun 23, 2021
| test-file (cl-remove-if-not predicate (projectile-current-project-files)))))) | ||
| (if-let ((impl-file-from-src-dir-fn | ||
| (projectile--impl-file-from-src-dir-fn test-file))) | ||
| (list impl-file-from-src-dir-fn) |
There was a problem hiding this comment.
Where :src-dir takes precendence if it's set to a function.
|
Great work! |
|
Awesome! Thanks for you ⚡ response |
|
Should this PR be resolved since it was merged? Also, does it resolve #1650 as well? |
|
I've just pinged the creator of that issue to ask if he's happy that it's resolved. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi! This PR is a follow up to #1671, it allows the
:src-dirproperty of projects to be set to a function like:test-dirwas in the previous PR.Similar to to
:test-dir, whenprojectile-toggle-between-implementation-and-testis called and the user is in a test file, and it's determined a project type has it's:src-dirproperty set to a function, this function will be called to obtain the directory in which the implementation file of the corresponding test file resides.The result is that from the project in #1650 with the config:
Is that calling
projectile-toggle-between-implementation-and-testfrom:src/main/scala/bar/package.scalasticks you insrc/test/scala/bar/packageSpec.scala(regardless of the test file existing)src/main/scala/foo/package.scalasticks you insrc/test/scala/foo/packageSpec.scala(regardless of the test file existing)src/test/scala/bar/packageSpec.scalasticks you insrc/main/scala/bar/package.scala(if the latter file exists)src/test/scala/foo/packageSpec.scalasticks you insrc/main/scala/foo/package.scala(if the latter file exists)Before submitting a PR make sure the following things have been done (and denote this
by checking the relevant checkboxes):
eldev test)M-x checkdocwarningsThanks!