added fullpath option #34
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
scottstanfield
added a commit
that referenced
this pull request
Jan 26, 2024
Included community PR #34 and lots of dependabot. Tested with node v21.6.1.
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.
This PR introduces the option to return the full file path for a parsed piece of content. By adding the
fullpathoption to the configuration and setting it totrue, the results metadata will include afullpathproperty.This change was inspired by work I did using this library to implement documentation search. In order to make the results clickable, we needed the full path for the file. I hacked together a solution for that project, but felt like this change might benefit others using this library.
Added a test to support this new functionality as well.