package list import ( "fmt" "strings" "github.com/MakeNowJust/heredoc/v2" "github.com/spf13/cobra" gitlab "gitlab.com/gitlab-org/api/client-go/v3" "gitlab.com/gitlab-org/cli/internal/api" "gitlab.com/gitlab-org/cli/internal/cmdutils" "gitlab.com/gitlab-org/cli/internal/glrepo" "gitlab.com/gitlab-org/cli/internal/iostreams" "gitlab.com/gitlab-org/cli/internal/mcpannotations" "gitlab.com/gitlab-org/cli/internal/utils" ) type options struct { io *iostreams.IOStreams apiClient func(repoHost string) (*api.Client, error) baseRepo func() (glrepo.Interface, error) group string page int perPage int outputFormat string } func NewCmdList(f cmdutils.Factory) *cobra.Command { opts := &options{ io: f.IO(), apiClient: f.ApiClient, baseRepo: f.BaseRepo, } iterationListCmd := &cobra.Command{ Use: "list [flags]", Short: `List project iterations.`, Long: heredoc.Docf(` By default, lists the iterations for the current project. Use %[1]s--group%[1]s to list a group's iterations instead, or %[1]s--repo%[1]s to target a project other than the current one. `, "`"), Aliases: []string{"ls"}, Example: heredoc.Doc(` glab iteration list glab iteration ls glab iteration list -R owner/repository glab iteration list -g mygroup`), Args: cobra.NoArgs, ValidArgsFunction: cobra.NoFileCompletions, Annotations: map[string]string{ mcpannotations.Safe: "true", }, RunE: func(cmd *cobra.Command, args []string) error { return opts.run() }, } iterationListCmd.Flags().IntVarP(&opts.page, "page", "p", 1, "Page number.") iterationListCmd.Flags().IntVarP(&opts.perPage, "per-page", "P", 30, "Number of items to list per page.") cmdutils.EnableJSONOutput(iterationListCmd, opts.io, &opts.outputFormat) iterationListCmd.Flags().StringVarP(&opts.group, "group", "g", "", "List iterations for a group.") return iterationListCmd } type listProjectIterationsOptions struct { IncludeAncestors *bool PerPage int64 Page int64 } func (opts *listProjectIterationsOptions) listProjectIterationsOptions() *gitlab.ListProjectIterationsOptions { projectOpts := &gitlab.ListProjectIterationsOptions{} projectOpts.IncludeAncestors = opts.IncludeAncestors projectOpts.PerPage = opts.PerPage projectOpts.Page = opts.Page return projectOpts } func (opts *listProjectIterationsOptions) listGroupIterationsOptions() *gitlab.ListGroupIterationsOptions { groupOpts := &gitlab.ListGroupIterationsOptions{} groupOpts.IncludeAncestors = opts.IncludeAncestors groupOpts.PerPage = opts.PerPage groupOpts.Page = opts.Page return groupOpts } func (o *options) run() error { // NOTE: this command can not only be used for projects, // so we have to manually check for the base repo, if it doesn't exist, // we bootstrap the client with the default hostname. var repoHost string if baseRepo, err := o.baseRepo(); err == nil { repoHost = baseRepo.RepoHost() } apiClient, err := o.apiClient(repoHost) if err != nil { return err } client := apiClient.Lab() iterationApiOpts := &listProjectIterationsOptions{} iterationApiOpts.IncludeAncestors = new(true) if o.page != 0 { iterationApiOpts.Page = int64(o.page) } if o.perPage != 0 { iterationApiOpts.PerPage = int64(o.perPage) } else { iterationApiOpts.PerPage = api.DefaultListLimit } var iterationBuilder strings.Builder if o.group != "" { iterations, resp, err := client.GroupIterations.ListGroupIterations(o.group, iterationApiOpts.listGroupIterationsOptions()) if err != nil { return err } if o.outputFormat == "json" { if err := o.io.PrintJSON(iterations); err != nil { return err } } else { o.io.LogInfof("%s\n", o.listTitle(o.group, len(iterations), resp)) for _, iteration := range iterations { iterationBuilder.WriteString(formatIterationInfo(iteration.Description, iteration.Title, iteration.WebURL)) } o.io.LogInfo(utils.Indent(iterationBuilder.String(), " ")) } } else { repo, err := o.baseRepo() if err != nil { return err } iterations, resp, err := client.ProjectIterations.ListProjectIterations(repo.FullName(), iterationApiOpts.listProjectIterationsOptions()) if err != nil { return err } if o.outputFormat == "json" { if err := o.io.PrintJSON(iterations); err != nil { return err } } else { o.io.LogInfof("%s\n", o.listTitle(repo.FullName(), len(iterations), resp)) for _, iteration := range iterations { iterationBuilder.WriteString(formatIterationInfo(iteration.Description, iteration.Title, iteration.WebURL)) } o.io.LogInfo(utils.Indent(iterationBuilder.String(), " ")) } } return nil } func formatIterationInfo(description string, title string, webURL string) string { if description != "" { description = fmt.Sprintf(" -> %s", description) } return fmt.Sprintf("%s%s (%s)\n", title, description, webURL) } func (o *options) listTitle(repoName string, count int, resp *gitlab.Response) string { title := utils.NewListTitle("iteration") title.RepoName = repoName title.Page = o.page title.CurrentPageTotal = count if resp != nil { title.Total = int(resp.TotalItems) } return title.Describe() }