This repository was archived by the owner on Apr 1, 2025. It is now read-only.
Make readProjectFromPaths use typed paths. #355
Merged
Conversation
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
added 2 commits
October 21, 2019 18:06
robrix
approved these changes
Oct 22, 2019
| <*> argument str (metavar "DIR") | ||
| <*> optional (pathOption (long "root" <> help "Root directory of project. Optional, defaults to entry file/directory." <> metavar "DIR")) | ||
| <*> many (pathOption (long "exclude-dir" <> help "Exclude a directory (e.g. vendor)" <> metavar "DIR")) | ||
| <*> argument path (metavar "PATH") |
There was a problem hiding this comment.
It’s still expected to be a directory, right? The metavar should probably still indicate that.
Edit: I believe I was mistaken, so this is a good detail to have caught 👍 thank you!
| readProjectFromPaths :: MonadIO m => Maybe FilePath -> FilePath -> Language -> [FilePath] -> m Project | ||
| readProjectFromPaths :: MonadIO m | ||
| => Maybe Path.AbsRelDir -- ^ An optional root directory for the project | ||
| -> Path.AbsRelFileDir -- ^ A file or directory to parse. Passing a file path loads all files in that file's parent directory. |
There was a problem hiding this comment.
I gotta say, I’m not sold on this semantic, but it looks to me like you’re maintaining the current behaviour and not introducing this so let’s see about resolving it separately from this PR.
There was a problem hiding this comment.
Yeah, it’s pretty shifty! Revealing weirdnesses like this is one of my favorite parts of adding pathtype everywhere: it lays bare the sins were committing and not even knowing it.
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.
This function has been a bête noire for some time; I’m glad to see it getting some type safety.