Add API to fetch repository status via uhub #21
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
Soreine
approved these changes
Nov 7, 2016
| * @param {Driver} driver | ||
| * @return {Promise<List<LocalFile>>} | ||
| */ | ||
| LocalFileUtils.status = function status(repoState, driver) { |
There was a problem hiding this comment.
Can we name it simply "LocalUtils" ?
Soreine
suggested changes
Nov 14, 2016
| * } | ||
| * } | ||
| * | ||
| * @param {String} opts.message List of files with name and status. |
There was a problem hiding this comment.
"commit message" ?
If it is optional, you can put it between brackets [opts.message] or indicate it is (optional) as for opts.author for example.
| * "message": "Commit message", | ||
| * "files": [{ | ||
| * "name": "README.md", | ||
| * "status": "modified" |
There was a problem hiding this comment.
Does the status has a meaning here ? Should it be removed ? (i would guess it is of no use here)
There was a problem hiding this comment.
it is used indeed in uhub
There was a problem hiding this comment.
Ok, so we should mention that status is useful. And as long as there is no documentation for Uhub, it's good to have it written somewhere, like here.
Added -> File will be added and committed
Copied -> ?
Deleted -> File will be removed
Modified -> Modification will be committed
Renamed -> ?
Unmodified -> Nothing
Untracked -> File will be added and committed
| @@ -21,3 +21,23 @@ LocalFileUtils.status = function status(repoState, driver) { | |||
| branch: branch | |||
| }); | |||
| }; | |||
|
|
|||
| /** | |||
| * Perform a git status on a given repository branch | |||
There was a problem hiding this comment.
Docstring needs to be updated
Soreine
approved these changes
Nov 15, 2016
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.
Hi!
This PR introduces new APIs to the driver, a new utility called
LocalFileUtilsand a new modelLocalFile.It also update the uhub version we are using in tests to match 2.5.1 which includes the needed API to fetch the repository status.