adding sync command

README.md

@@ -12,6 +12,7 @@ automatically update the dependent PR when the base PR is updated. Read more at
 PRs](https://www.aviator.co/blog/rethinking-code-reviews-with-stacked-prs/).
 
 # Community
+
 Join our discord community: [https://discord.gg/TFgtZtN8](https://discord.gg/NFsYWNzXcH)
 
 # Features
@@ -82,7 +83,7 @@ $ gh pr merge feature-1
 Sync the stack:
 
 ```sh
-$ av stack sync
+$ av sync
 
   ✓ GitHub fetch is done
   ✓ Restack is done
@@ -142,21 +143,26 @@ Add Aviator to your APT repositories.
 echo "deb [trusted=yes] https://apt.fury.io/aviator/ /" > \
 /etc/apt/sources.list.d/fury.list
 ```
+
 And then apt install.
+
 ```sh
 sudo apt update
 sudo apt install av
 ```
 
 ### Alternatively
+
 If you'd prefer you can download the `.deb` file from the [releases page](https://github.com/aviator-co/av/releases).
 
 ```sh
 apt install ./av_$VERSION_linux_$ARCH.deb
 ```
 
 ## RPM-based systems
+
 Add the following file `/etc/yum.repos.d/fury.repo`.
+
 ```conf
 [fury]
 name=Gemfury Private Repo
@@ -166,16 +172,19 @@ gpgcheck=0
 ```
 
 Run the following command to confirm the configuration is working.
+
 ```sh
 yum --disablerepo=* --enablerepo=fury list available
 ```
 
 And then run yum install.
+
 ```sh
 sudo yum install av
 ```
 
 ### Alternatively
+
 If you'd prefer you can download the `.rpm` file from the [releases page](https://github.com/aviator-co/av/releases).
 
 ```sh
@@ -215,19 +224,19 @@ Download the binary from the [releases page](https://github.com/aviator-co/av/re
 
 # Example commands
 
-| Command               | Description                                                |
-| --------------------- | ---------------------------------------------------------- |
-| `av stack branch`     | Create a new child branch from the current branch.         |
-| `av stack restack`    | Rebase the branches to their parents.                      |
-| `av pr create`        | Create or update a PR.                                     |
-| `av stack tree`       | Visualize the PRs.                                         |
-| `av stack sync --all` | Fetch and rebase all branches.                             |
-| `av stack adopt`      | Adopt a branch that is not created from `av stack branch`. |
-| `av stack reparent`   | Change the parent of the current branch.                   |
-| `av stack switch`     | Check out branches interactively.                          |
-| `av stack reorder`    | Reorder the branches.                                      |
-| `av commit amend`     | Amend the last commit and rebase the children.             |
-| `av commit split`     | Split the last commit.                                     |
+| Command             | Description                                                |
+| ------------------- | ---------------------------------------------------------- |
+| `av stack branch`   | Create a new child branch from the current branch.         |
+| `av stack restack`  | Rebase the branches to their parents.                      |
+| `av pr create`      | Create or update a PR.                                     |
+| `av stack tree`     | Visualize the PRs.                                         |
+| `av sync --all`     | Fetch and rebase all branches.                             |
+| `av stack adopt`    | Adopt a branch that is not created from `av stack branch`. |
+| `av stack reparent` | Change the parent of the current branch.                   |
+| `av stack switch`   | Check out branches interactively.                          |
+| `av stack reorder`  | Reorder the branches.                                      |
+| `av commit amend`   | Amend the last commit and rebase the children.             |
+| `av commit split`   | Split the last commit.                                     |
 
 # How it works
 
@@ -238,6 +247,6 @@ new base branch using the remembered starting point as the merge base.
 
 # Learn more
 
-* [Rethinking code reviews with stacked PRs](https://www.aviator.co/blog/rethinking-code-reviews-with-stacked-prs/)
-* [Issue Tracker](https://github.com/aviator-co/av/issues)
-* [Changelog](https://github.com/aviator-co/av/releases)
+- [Rethinking code reviews with stacked PRs](https://www.aviator.co/blog/rethinking-code-reviews-with-stacked-prs/)
+- [Issue Tracker](https://github.com/aviator-co/av/issues)
+- [Changelog](https://github.com/aviator-co/av/releases)

cmd/av/auth.go

@@ -1,16 +1,86 @@
 package main
 
 import (
+	"context"
+	"fmt"
+	"os"
+
+	"emperror.dev/errors"
+	"github.com/aviator-co/av/internal/gh"
+
+	"github.com/aviator-co/av/internal/avgql"
+	"github.com/aviator-co/av/internal/utils/colors"
 	"github.com/spf13/cobra"
 )
 
 var authCmd = &cobra.Command{
-	Use:   "auth",
-	Short: "Manage authentication",
+	Use:          "auth",
+	Short:        "Check user authentication status",
+	SilenceUsage: true,
+	Args:         cobra.NoArgs,
+	Run: func(cmd *cobra.Command, args []string) {
+		if err := checkAviatorAuthStatus(); err != nil {
+			fmt.Fprintln(os.Stderr, colors.Warning(err.Error()))
+		}
+		if err := checkGitHubAuthStatus(); err != nil {
+			fmt.Fprintln(os.Stderr, colors.Failure(err.Error()))
+		}
+	},
+}
+
+func checkAviatorAuthStatus() error {
+	avClient, err := avgql.NewClient()
+	if err != nil {
+		return err
+	}
+
+	var query struct{ avgql.ViewerSubquery }
+	if err := avClient.Query(context.Background(), &query, nil); err != nil {
+		return err
+	}
+	if err := query.CheckViewer(); err != nil {
+		return err
+	}
+
+	fmt.Fprint(os.Stderr,
+		"Logged in to Aviator as ", colors.UserInput(query.Viewer.FullName),
+		" (", colors.UserInput(query.Viewer.Email), ").\n",
+	)
+	return nil
+}
+
+func checkGitHubAuthStatus() error {
+	ghClient, err := getGitHubClient()
+	if err != nil {
+		return err
+	}
+
+	viewer, err := ghClient.Viewer(context.Background())
+	if err != nil {
+		// GitHub API returns 401 Unauthorized if the token is invalid or
+		// expired.
+		if gh.IsHTTPUnauthorized(err) {
+			return errors.New(
+				"You are not logged in to GitHub. Please verify that your API token is correct.",
+			)
+		}
+		return errors.Wrap(err, "Failed to query GitHub")
+	}
+
+	fmt.Fprint(os.Stderr,
+		"Logged in to GitHub as ", colors.UserInput(viewer.Name),
+		" (", colors.UserInput(viewer.Login), ").\n",
+	)
+	return nil
 }
 
 func init() {
+	// deprecated 'av auth status', hidden to avoid it showing up in 'av auth --help'
+	// since that is the new command name
+	var deprecatedAuthStatus = deprecateCommand(*authCmd, "av auth", "status")
+	deprecatedAuthStatus.Hidden = true
+
 	authCmd.AddCommand(
-		authStatusCmd,
+		deprecatedAuthStatus,
 	)
 }

cmd/av/commit_split.go

@@ -131,7 +131,7 @@ func splitCommit(repo *git.Repo, currentBranchName, currentCommitOID string) err
 		// TODO: We should rebase the stacks after split.
 		_, _ = fmt.Fprint(
 			os.Stderr,
-			"Run `av stack sync` to sync your stack if necessary.",
+			"Run 'av sync' to sync your stack if necessary.",
 		)
 
 	}

cmd/av/helpers.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"fmt"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -11,6 +12,7 @@ import (
 	"github.com/aviator-co/av/internal/meta"
 	"github.com/aviator-co/av/internal/meta/jsonfiledb"
 	"github.com/aviator-co/av/internal/meta/refmeta"
+	"github.com/spf13/cobra"
 )
 
 var cachedRepo *git.Repo
@@ -116,3 +118,29 @@ func stripRemoteRefPrefixes(repo *git.Repo, possibleRefName string) string {
 	}
 	return ret
 }
+
+// deprecateCommand will create a new version of the command that injects a deprecation message
+// into the command's short and long descriptions. As well as a pre-run hook that will print
+// a deprecation warning before running the command.
+func deprecateCommand(
+	cmd cobra.Command,
+	newCmd string,
+	use string,
+) *cobra.Command {
+	deprecatedCommand := cmd
+
+	deprecatedCommand.Use = use
+	deprecatedCommand.Short = fmt.Sprintf("Deprecated: %s (use '%s' instead)", cmd.Short, newCmd)
+
+	if deprecatedCommand.Long != "" {
+		var long = fmt.Sprintf("This command is deprecated. Please use '%s' instead.\n\n", newCmd)
+
+		deprecatedCommand.Long = long + deprecatedCommand.Long
+	}
+
+	deprecatedCommand.PreRun = func(cmd *cobra.Command, args []string) {
+		fmt.Printf("This command is deprecated. Please use '%s' instead.\n", newCmd)
+	}
+
+	return &deprecatedCommand
+}

cmd/av/main.go

@@ -99,6 +99,7 @@ func init() {
 		stackCmd,
 		versionCmd,
 		authCmd,
+		syncCmd,
 	)
 }
 

cmd/av/stack.go

@@ -11,7 +11,10 @@ var stackCmd = &cobra.Command{
 }
 
 func init() {
+	deprecatedStackSyncCmd := deprecateCommand(*syncCmd, "av sync", "sync")
+
 	stackCmd.AddCommand(
+		deprecatedStackSyncCmd,
 		stackAdoptCmd,
 		stackBranchCmd,
 		stackBranchCommitCmd,
@@ -25,7 +28,6 @@ func init() {
 		stackRestackCmd,
 		stackSubmitCmd,
 		stackSwitchCmd,
-		stackSyncCmd,
 		stackTidyCmd,
 		stackTreeCmd,
 	)

cmd/av/stack_adopt.go

@@ -460,7 +460,7 @@ func init() {
 		"dry-run adoption",
 	)
 
-	_ = stackSyncCmd.RegisterFlagCompletionFunc(
+	_ = stackAdoptCmd.RegisterFlagCompletionFunc(
 		"parent",
 		func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			branches, _ := allBranches()

cmd/av/stack_diff.go

@@ -117,7 +117,7 @@ Generates the diff between the working tree and the parent branch
 				colors.Warning("\nWARNING: Branch "), colors.UserInput(currentBranchName),
 				colors.Warning(" is not up to date with parent branch "),
 				colors.UserInput(branch.Parent.Name), colors.Warning(". Run "),
-				colors.CliCmd("av stack sync"), colors.Warning(" to synchronize the branch.\n"),
+				colors.CliCmd("av sync"), colors.Warning(" to synchronize the branch.\n"),
 			)
 			return actions.ErrExitSilently{ExitCode: 1}
 		}

cmd/av/stack_switch.go

@@ -293,7 +293,7 @@ func (vm stackSwitchViewModel) View() string {
 	return ret
 }
 
-func (_ stackSwitchViewModel) renderBranchInfo(
+func (stackSwitchViewModel) renderBranchInfo(
 	stbi *stackTreeBranchInfo,
 	currentBranchName string,
 	branchName string,