diff --git a/internal/app/help_topics.go b/internal/app/help_topics.go index c3ed3405..209cccc5 100644 --- a/internal/app/help_topics.go +++ b/internal/app/help_topics.go @@ -36,7 +36,7 @@ const ( // help omits --repo, --remote and --cwd. var noRepoCommands = []string{ "tea admin", "tea alias", "tea auth", "tea completion", "tea config", "tea help", "tea man", "tea org", - "tea repo create", "tea repo list", "tea search repo", "tea ssh-key", "tea team", "tea version", + "tea repo create", "tea repo list", "tea repo migrate", "tea search repo", "tea ssh-key", "tea team", "tea version", } // writeHelp prints the help page of cmd. diff --git a/internal/app/repos.go b/internal/app/repos.go index a9e5ce14..6331aa0b 100644 --- a/internal/app/repos.go +++ b/internal/app/repos.go @@ -5,9 +5,11 @@ package app import ( "errors" + "strings" "gitea.dev/tea/internal/clierr" "gitea.dev/tea/internal/services" + "gitea.dev/tea/internal/settings" "gitea.dev/tea/internal/terminal" "github.com/spf13/cobra" ) @@ -24,10 +26,32 @@ func (a *application) repositoryArgument(args []string) error { return nil } +// rejectRepoFlag fails when --repo is passed to a command that acts on no repository; suggest +// words the command the user probably meant for the owner that --repo names. +func (a *application) rejectRepoFlag(cmd *cobra.Command, suggest func(owner string) string) error { + if a.options.repo == "" { + return nil + } + text := "--repo is not used by " + strings.TrimPrefix(cmd.CommandPath(), cmd.Root().Name()+" ") + if ref, err := settings.ParseRepository(a.options.repo, nil); err == nil && ref.Owner != "" { + text += "; did you mean: " + suggest(ref.Owner) + } + return clierr.Wrap(clierr.Usage, errors.New(text)) +} + func (a *application) repoCommand() *cobra.Command { group := &cobra.Command{Use: "repo", Short: "Work with Gitea repositories"} var opts services.RepositoryListOptions - list := &cobra.Command{Use: "list", Short: "List your repositories", Args: argsExact(0), RunE: func(cmd *cobra.Command, _ []string) error { + list := &cobra.Command{Use: "list []", Short: "List your repositories", Args: usageArgs(cobra.MaximumNArgs(1)), RunE: func(cmd *cobra.Command, args []string) error { + if err := a.rejectRepoFlag(cmd, func(owner string) string { return "tea repo list " + owner }); err != nil { + return err + } + if len(args) > 0 { + if cmd.Flags().Changed("owner") { + return clierr.Wrap(clierr.Usage, errors.New("supply the owner as an argument or --owner, not both")) + } + opts.Owner = args[0] + } if err := validateRepositoryKind(opts.Kind); err != nil { return err } diff --git a/internal/app/repository_argument_test.go b/internal/app/repository_argument_test.go index ec20d062..f75d1728 100644 --- a/internal/app/repository_argument_test.go +++ b/internal/app/repository_argument_test.go @@ -6,6 +6,7 @@ package app import ( "context" "net/http" + "strings" "testing" "github.com/stretchr/testify/require" @@ -40,3 +41,48 @@ func TestRepositoryCommandsAcceptPositionalRepository(t *testing.T) { }) } } + +func TestCommandsWithoutRepositoryRejectRepoFlag(t *testing.T) { + for _, test := range []struct { + args []string + want string + }{ + {[]string{"repo", "list", "-R", "acme/service"}, "--repo is not used by repo list; did you mean: tea repo list acme"}, + {[]string{"repo", "create", "foo", "-R", "alice/project", "--yes"}, "--repo is not used by repo create; did you mean: tea repo create alice/foo"}, + {[]string{"repo", "migrate", "https://example.com/x.git", "--name", "x", "--repo", "acme/x"}, "--repo is not used by repo migrate; did you mean: tea repo migrate URL --owner acme"}, + {[]string{"search", "repo", "tea", "-R", "acme/x"}, "--repo is not used by search repo; did you mean: tea search repo --owner acme"}, + } { + t.Run(strings.Join(test.args[:2], " "), func(t *testing.T) { + requireUsageBeforeRequests(t, test.want, test.args...) + }) + } +} + +func TestRepositoryOwnerArguments(t *testing.T) { + var requests []string + server := newAuthenticatedServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + requests = append(requests, r.Method+" "+r.URL.Path) + switch { + case r.URL.Path == "/api/v1/orgs/acme": + _, _ = w.Write([]byte(`{"id":3,"name":"acme"}`)) + case r.Method == http.MethodGet: + _, _ = w.Write([]byte(`[]`)) + default: + _, _ = w.Write([]byte(`{"full_name":"acme/tool"}`)) + } + })) + defer server.Close() + for _, test := range []struct { + args []string + want string + }{ + {[]string{"repo", "list", "acme"}, "GET /api/v1/orgs/acme/repos"}, + {[]string{"repo", "create", "acme/tool"}, "POST /api/v1/orgs/acme/repos"}, + {[]string{"repo", "create", "alice/tool"}, "POST /api/v1/user/repos"}, + } { + requests = nil + deps, _, _ := serverDeps(t, server.URL) + require.NoError(t, Execute(context.Background(), deps, append(test.args, "--no-input", "--json"))) + require.Equal(t, test.want, requests[len(requests)-1], test.args) + } +} diff --git a/internal/app/repository_create.go b/internal/app/repository_create.go index 85bcb08c..24e7baef 100644 --- a/internal/app/repository_create.go +++ b/internal/app/repository_create.go @@ -4,6 +4,7 @@ package app import ( + "cmp" "errors" "fmt" "strings" @@ -32,6 +33,15 @@ func (a *application) repoCreateCommand() *cobra.Command { } opts.Name = args[0] } + if err := a.rejectRepoFlag(cmd, func(owner string) string { return "tea repo create " + owner + "/" + cmp.Or(opts.Name, "NAME") }); err != nil { + return err + } + if owner, name, ok := strings.Cut(opts.Name, "/"); ok { + if cmd.Flags().Changed("org") { + return clierr.Wrap(clierr.Usage, errors.New("supply the owner as OWNER/NAME or --org, not both")) + } + org, opts.Name = owner, name + } if cmd.Flags().Changed("team") && (org == "" || strings.TrimSpace(team) == "") { return clierr.Wrap(clierr.Usage, errors.New("--team requires --org and a team name")) } @@ -66,9 +76,6 @@ func (a *application) repoCreateCommand() *cobra.Command { } selected := *a if source != "" { - if a.options.repo != "" { - return clierr.Wrap(clierr.Usage, errors.New("--template and --repo cannot both select a source repository")) - } for _, flag := range []string{"auto-init", "label-template", "gitignores", "license", "readme", "as-template", "trust-model", "object-format"} { if cmd.Flags().Changed(flag) { return clierr.Wrap(clierr.Usage, errors.New("repository initialization options cannot be combined with --template")) @@ -86,6 +93,12 @@ func (a *application) repoCreateCommand() *cobra.Command { if err != nil { return err } + if !cmd.Flags().Changed("org") && strings.EqualFold(org, target.User) { + if team != "" { + return clierr.Wrap(clierr.Usage, errors.New("--team requires a repository owned by an organization")) + } + org = "" + } if prompted { if err := a.confirm(cmd, "Create repository "+opts.Name+" on "+target.Host); err != nil { return err diff --git a/internal/app/repository_migrate.go b/internal/app/repository_migrate.go index d94ef478..0e616693 100644 --- a/internal/app/repository_migrate.go +++ b/internal/app/repository_migrate.go @@ -26,6 +26,9 @@ func (a *application) repoMigrateCommand() *cobra.Command { var opts services.RepositoryMigrationOptions var passwordFile, tokenFile, serverPath string command := &cobra.Command{Use: "migrate [clone-url]", Short: "Import a remote repository through Gitea", Args: usageArgs(cobra.MaximumNArgs(1)), RunE: func(cmd *cobra.Command, args []string) error { + if err := a.rejectRepoFlag(cmd, func(owner string) string { return "tea repo migrate URL --owner " + owner }); err != nil { + return err + } if len(args) > 0 { if cmd.Flags().Changed("clone-url") { return clierr.Wrap(clierr.Usage, errors.New("supply clone URL as an argument or --clone-url, not both")) diff --git a/internal/app/search.go b/internal/app/search.go index c32932d1..19a67800 100644 --- a/internal/app/search.go +++ b/internal/app/search.go @@ -27,6 +27,9 @@ func (a *application) searchCommand() *cobra.Command { var opts services.RepositorySearchOptions var private, archived bool command := &cobra.Command{Use: "repo [query]...", Short: "Search repository names, descriptions or topics", RunE: func(cmd *cobra.Command, args []string) error { + if err := a.rejectRepoFlag(cmd, func(owner string) string { return "tea search repo --owner " + owner }); err != nil { + return err + } if err := validateRepositoryKind(opts.Kind); err != nil { return err } diff --git a/internal/app/validation_test.go b/internal/app/validation_test.go index 96a1f4c9..b8b61b46 100644 --- a/internal/app/validation_test.go +++ b/internal/app/validation_test.go @@ -150,7 +150,7 @@ func TestUsageErrorsPrecedeRequests(t *testing.T) { {[]string{"release", "edit", "v1"}, "supply release fields to edit"}, {[]string{"release", "edit", "v1", "v2", "--tag", "v3"}, "--tag requires one release and a nonempty new tag"}, {[]string{"repo", "create"}, "missing required input: supply --name"}, - {[]string{"repo", "create", "bad/name"}, "repository name must be nonempty, at most 100 bytes, and contain no path separators or whitespace"}, + {[]string{"repo", "create", "acme/bad/name"}, "repository name must be nonempty, at most 100 bytes, and contain no path separators or whitespace"}, {[]string{"repo", "create", "name", "--name", "other"}, "supply name as an argument or --name, not both"}, {[]string{"repo", "create", "name", "--default-branch", "bad..branch", "--auto-init"}, "invalid branch name"}, {[]string{"repo", "create", "name", "--license", "MIT"}, "initial content and default branch options require --auto-init"}, @@ -161,7 +161,7 @@ func TestUsageErrorsPrecedeRequests(t *testing.T) { {[]string{"repo", "create", "name", "--copy-content=false"}, "copy options require --template owner/repo"}, {[]string{"repo", "create", "name", "--template="}, "--template requires owner/repo or a repository URL"}, {[]string{"repo", "create", "name", "--template", "owner/source", "--auto-init"}, "repository initialization options cannot be combined with --template"}, - {[]string{"repo", "create", "name", "--template", "owner/source", "-R", "owner/other"}, "--template and --repo cannot both select a source repository"}, + {[]string{"repo", "create", "name", "--template", "owner/source", "-R", "owner/other"}, "--repo is not used by repo create; did you mean: tea repo create owner/name"}, {[]string{"repo", "edit", "--name="}, "repository name cannot be empty"}, {[]string{"repo", "edit", "--default-branch="}, "default branch cannot be empty"}, {[]string{"repo", "archive", "alice/project", "-R", "alice/other", "--yes"}, "supply the repository as an argument or --repo, not both"},