fix: don't rely on string context for package source #170
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
Before this commit, the type of a package source (haskell-source-type) depended on string contexts in its `check` function. However, string contexts do not work well to represent a path to a package source. For instance, "hello ./subdirectory" would have a string context, but is obviously not a valid path. Furthermore, a `nix` bug (NixOS/nix#8428) related to string contexts triggers an issue where setting the project root causes a type error with haskell-source-type (srid#169). This commit replaces haskell-source-type with `with type; either path str` and instances of `isPathUnderNixStore` with `lib.types.path.check` to avoid using string contexts.
I observed this in https://github.com/srid/emanote. Using your PR in emanote, I see no regressions. So think this PR is good to merge. |
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.
Fixes #169.
Summary:
haskell-source-typeand useswith types; either path strfor package source type.haskell-source-type'scheck,isPathUnderNixStorewas used to differentiate between a path to a package source and a version string. All usage ofisPathUnderNixStorehas been replaced withlib.types.path.check.Todo:
projectRootis set (I haven't looked into how testing is done inhaskell-flake; feel free to add one).types.pathcover all valid paths? If not, we need to add tests.