Resurrect Default src-dir and test-dir for project-types #1769
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
Use "src/" and "test/" as defaults for the src-dir and test-dir attributes of a project type when toggling between implementation and test files. Improve error messages for implementation and test file toggling
LaurenceWarne
commented
Apr 4, 2022
| @@ -3674,6 +3749,25 @@ to a custom function, else return nil." | |||
| #'projectile--test-name-for-impl-name) | |||
| (projectile-project-root))))) | |||
|
|
|||
| (defmacro projectile--acond (&rest clauses) | |||
There was a problem hiding this comment.
I've added acond from anaphora.el (though with a tweak for emacs 25 compat) in an effort to make projectile--find-matching-file and projectile--find-matching-test a bit nicer. If you prefer it I can remove it and go back to using the chain of if-lets.
LaurenceWarne
commented
Apr 4, 2022
| @@ -530,6 +530,22 @@ See also `projectile-update-mode-line'." | |||
| :type 'function | |||
| :package-version '(projectile . "2.0.0")) | |||
|
|
|||
| (defcustom projectile-default-src-directory "src/" | |||
| "The default value of a project's src-dir property. | |||
There was a problem hiding this comment.
Sorry I'm not sure the convention for :package-version, do you wait until a new release before adding this?
|
The fix looks good. Thanks for tackling this! |
|
Thanks 🙂 |
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 is a proposed fix for #1765, it (re) adds a default value for the
src-dirandtest-dirproperties for project types (="src/"and"test/"). The main effect is forprojectile-toggle-between-implementation-and-test, so these defaults will be used as a fallback if no other method can be found for finding an impl/test file.There was a breaking change in #1734 (sorry!) which removed this fallback, so project types without a
src-dirorrelated-files-fnproperty wouldn't have a method for finding corresponding test/impl files, as shown in #1765. This fallback is not always particularly useful however, for example when your implementation file doesn't contain"src/", this PR throws an error in such cases.I've also tweaked some error messages around this area to hopefully make debugging a little easier:
"Project type foo not supported!""Cannot determine a test file name, one of "test-suffix" or "test-prefix" must be set for project type foo"(or an equivalent message for test -> impl)projectile-create-missing-test-filesis not set"No matching test file found for project type foo""Determined test file to be "foo", which does not exist. Set `projectile-create-missing-test-files' to allow `projectile-find-implementation-or-test' to create new files"src-dirandtest-dirare set for a project type, but the impl/test file does not contain these as substrings"Attempted to find a test file by switching this project type's (foo) src-dir property "src" with this project type's test-dir property "test", but foo/bar does not contain "src"(or an equivalent message for test -> impl)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!