Cabal go to module's definition #4380
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
fendor
requested changes
Aug 16, 2024
plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/CabalFields.hs
Outdated
Show resolved
Hide resolved
…Fields.hs Co-authored-by: fendor <fendor@users.noreply.github.com>
* Add goto-definitions for cabal common sections * Add default direct cradle hie.yaml file to testdata * incorporate changes requested in haskell#4375 * add tests for cabal goto-definition
|
Noteworthy change: |
VeryMilkyJoe
requested changes
Aug 21, 2024
plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/CabalFields.hs
Outdated
Show resolved
Hide resolved
plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/CabalFields.hs
Outdated
Show resolved
Hide resolved
plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/CabalFields.hs
Outdated
Show resolved
Hide resolved
plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/CabalFields.hs
Outdated
Show resolved
Hide resolved
Co-authored-by: VeryMilkyJoe <jana.chadt@nets.at>
VenInf
requested review from
VeryMilkyJoe and
fendor
and removed request for
VeryMilkyJoe
soulomoon
pushed a commit
to soulomoon/haskell-language-server
that referenced
this pull request
Sep 23, 2024
If you click go-to definition on the field under `exposed-module` or `other-module` it will open the file where this module was defined. The go-to definition function compares the highlighted text with modules in the cabal file. If there is a match, it takes the respective build target and tries to fetch their `hsSourceDirs` from the `PackageDescription`. (by looking at all `buildInfos` with matching names). After finding them, it constructs a path using directory where the cabal file is located, the info from `hsSourceDirs` and a name of the module converted to a path. If the file exists it returns the `Definition` with the acquired location. --------- Co-authored-by: fendor <fendor@users.noreply.github.com> Co-authored-by: Chrizzl <hochrainer.christoph@gmail.com> Co-authored-by: VeryMilkyJoe <jana.chadt@nets.at>
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.
Go to the module's definition
If you click go-to definition on the field under
exposed-moduleorother-moduleit will open the file where this module was defined.
Video with an example:
go-to-definition-cut.mp4
Implementation details
The go-to definition function compares the highlighted text with modules in the cabal file.
If there is a match, it takes the respective build target and tries to fetch their
hsSourceDirsfrom thePackageDescription. (by looking at allbuildInfoswith matching names).After finding them, it constructs a path using directory where the cabal file is located, the info from
hsSourceDirsand a name of the module converted to a path.If the file exists it returns the
Definitionwith the acquired location.What isn't implemented
if's