This repository was archived by the owner on Dec 15, 2022. It is now read-only.
Issue #77 Allow end-user configuration of tags path relative to project root#137
Open
mshenfield wants to merge 1 commit into
Open
Issue #77 Allow end-user configuration of tags path relative to project root#137mshenfield wants to merge 1 commit into
mshenfield wants to merge 1 commit into
Conversation
Allow user to specify the directory, relative to the root of each project open within Atom, where symbols-view looks for the `tags` file, using the `tagsDirectory` config variable. This only effects `toggle-project-symbols`. The impetus behind this commit is to allow popular confirations, such as storing tags files in the `.git` directory, to work. The change required additional information on each `tag` object, mainly specifiying the path of the project the tag was generated for. This was to a) easily display the project directory when multiple projects were open and b) to programatically resolve the full path of the symbol's file when generating symbols relative to root. This also required adding a configuration variable `tagsDirectory`, which should be a directory relative to the project root that contains the tags file. Also refactored the reloadTags method inside of watchTagsFiles into a separate instance method, with a different name (triggerReloadTags) so that it didn't shadow the instance attribute reloadTags, and could be used in the configuration watcher for the new `tagsDirectory` configuration variable. Added an appropriate test to run `toggle-project-symbols` with a relative `tagsDirectory` config set.
Contributor
Author
|
I feel like there is an implied AtomTag class floating around, but would like to refactor in a separate PR. We have |
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Allow user to specify the directory, relative to the root of each project
open within Atom, where symbols-view looks for the
tagsfile, usingthe
tagsDirectoryconfig variable. This closes #77 and is a step towards#127.
This only effects
toggle-project-symbols. The impetus behind this commitis to allow popular confirations, such as storing tags files in the
.gitdirectory, to work. The change required additional information on each
tagobject, mainly specifiying the path of the project the tag was generatedfor. This was to a) easily display the project directory when multiple projects
were open and b) to programatically resolve the full path of the symbol's file
when generating symbols relative to root.
This also required adding a configuration variable
tagsDirectory, which shouldbe a directory relative to the project root that contains the tags file.
Also refactored the reloadTags method inside of watchTagsFiles into a separate
instance method, with a different name (triggerReloadTags) so that it didn't
shadow the instance attribute reloadTags, and could be used in the configuration
watcher for the new
tagsDirectoryconfiguration variable.Added an appropriate test to run
toggle-project-symbolswith a relativetagsDirectoryconfig set.