bukinoshita / git-synced Goto Github PK

View Code? Open in Web Editor NEW

15.0 2.0 3.0 40.07 MB

:wind_chime: Keep a fork up to date

License: MIT License

JavaScript 100.00%

git github nodejs javascript cli command-line sync git-synced fork

git-synced's Introduction

git-synced

🎐 Keep a fork up to date

Install

$ npm install -g git-synced

Usage

$ git-synced --help

  Usage:
    $ git-synced                Update fork
    $ git-synced <repo url>     Update fork with GitHub repo url
    $ git-synced <user/repo>    Update fork with GitHub repo

  Example:
    $ git-synced
    $ git-synced https://github.com/bukinoshita/git-synced
    $ git-synced bukinoshita/git-synced
    $ git-synced --branch=staging
    $ git-synced --default

  Options:
    -b BRANCH, --branch=BRANCH  Choose branch as default
    -d, --default               Use master branch as default
    -h, --help                  Show help options
    -v, --version               Show version

Demo

del-git-index — Safely delete index.lock of the current project
repo-exist — Checks if GitHub repository exist
gopn — Open GitHub repositories
is-github-repo — Checks if string is a git repository
git-url-prettify — Prettify git url
git-url-uglify — Uglify git url

License

MIT © Bu Kinoshita

git-synced's People

Contributors

Stargazers

Watchers

Forkers

fjsnogueira ddg00 freestylerosx

git-synced's Issues

`git-synced` can't find repo

If git-synced can't find repo return message saying that it can't find repo and to try with url

add `git-synced <repo url>`

Should add upstream with the repo url and sync

Use shout to return messages

https://github.com/bukinoshita/shout-success
https://github.com/bukinoshita/shout-message
https://github.com/bukinoshita/shout-error

choose branch to update

when user update their fork, it update from master, show list of branches so user can select.

add branch flag

If we can't get the repository branches it returns only master as default. If user want to sync their fork with a private project, we can't get their branches bc it's private.

So to solve that it should have a fallback where users can still sync with other branches having a branch flag as an option.

$ git-synced --branch=staging

// or

$ git-synced -b staging

By running that command should skip the getting branches process, also make sure userRepo assignment is done when checking upstream.

return getBranches(repo)
  .then(branches => {
    spinner.stop()
    userRepo = repo // `userRepo` should be assigned on `checkUpstream` process.
    return branches
  })
  .catch(err => {
    spinner.stop()
    shoutError(err)
    process.exit()
  })

add default flag

Add default flag to skip getting branches process.

$ git-synced --default

// or

$ git-synced -d

Default branch should be master

upstream is already up-to-date

if upstream is already up-to-date return Upstream is already up-to-date instead of fork updated

it return an error when repository is `owner/repoName`

If repository field is like this: "repository": "bukinoshita/git-synced" it returns an error.

Before finding a repository here it should check if repo is a valid url, if it is it needs to prettify the url and then search.

lib to validate if it's Git repo is-github-repo (it return a type, if returns a type: repo it should prettify the url.
lib to prettify git url: git-url-prettify