Common subcommand naming scheme (#208)

drop tea mile alias

document command schema in CONTRIBUTING.md

and update this file, its a plain copy from gitea

add "list" as alias for "ls" subcommand

add singular command aliases

Co-authored-by: Norwin Roosen <git@nroo.de>
Reviewed-on: https://gitea.com/gitea/tea/pulls/208
Reviewed-by: 6543 <6543@noreply.gitea.io>
Reviewed-by: techknowlogick <techknowlogick@gitea.io>
This commit is contained in:
Norwin
2020-10-02 15:46:51 +00:00
committed by 6543
parent f5dbd44ebe
commit 3ee5501257
14 changed files with 43 additions and 24 deletions

View File

@ -17,6 +17,7 @@ import (
// CmdIssues represents to login a gitea server.
var CmdIssues = cli.Command{
Name: "issues",
Aliases: []string{"issue"},
Usage: "List, create and update issues",
Description: "List, create and update issues",
ArgsUsage: "[<issue index>]",

View File

@ -19,6 +19,7 @@ import (
// CmdIssuesList represents a sub command of issues to list issues
var CmdIssuesList = cli.Command{
Name: "ls",
Aliases: []string{"list"},
Usage: "List issues of the repository",
Description: `List issues of the repository`,
Action: RunIssuesList,

View File

@ -23,6 +23,7 @@ import (
// CmdLabels represents to operate repositories' labels.
var CmdLabels = cli.Command{
Name: "labels",
Aliases: []string{"label"},
Usage: "Manage issue labels",
Description: `Manage issue labels`,
Action: runLabels,

View File

@ -12,7 +12,8 @@ import (
// CmdLogin represents to login a gitea server.
var CmdLogin = cli.Command{
Name: "login",
Name: "logins",
Aliases: []string{"login"},
Usage: "Log in to a Gitea server",
Description: `Log in to a Gitea server`,
Action: login.RunLoginAddInteractive, // TODO show list if no arg & detail if login as arg

View File

@ -18,6 +18,7 @@ import (
// CmdLoginList represents to login a gitea server.
var CmdLoginList = cli.Command{
Name: "ls",
Aliases: []string{"list"},
Usage: "List Gitea logins",
Description: `List Gitea logins`,
Action: runLoginList,

View File

@ -16,7 +16,7 @@ import (
// CmdMilestones represents to operate repositories milestones.
var CmdMilestones = cli.Command{
Name: "milestones",
Aliases: []string{"ms", "mile"},
Aliases: []string{"milestone", "ms"},
Usage: "List and create milestones",
Description: `List and create milestones`,
ArgsUsage: "[<milestone name>]",

View File

@ -19,6 +19,7 @@ import (
// CmdMilestonesList represents a sub command of milestones to list milestones
var CmdMilestonesList = cli.Command{
Name: "ls",
Aliases: []string{"list"},
Usage: "List milestones of the repository",
Description: `List milestones of the repository`,
Action: RunMilestonesList,

View File

@ -19,7 +19,7 @@ import (
// CmdNotifications is the main command to operate with notifications
var CmdNotifications = cli.Command{
Name: "notifications",
Aliases: []string{"notif"},
Aliases: []string{"notification", "notif"},
Usage: "Show notifications",
Description: "Show notifications, by default based of the current repo and unread one",
Action: runNotifications,

View File

@ -19,6 +19,7 @@ import (
// CmdPullsList represents a sub command of issues to list pulls
var CmdPullsList = cli.Command{
Name: "ls",
Aliases: []string{"list"},
Usage: "List pull requests of the repository",
Description: `List pull requests of the repository`,
Action: RunPullsList,

View File

@ -14,8 +14,8 @@ import (
// CmdReleases represents to login a gitea server.
// ToDo: ReleaseDetails
var CmdReleases = cli.Command{
Name: "release",
Aliases: []string{"releases"},
Name: "releases",
Aliases: []string{"release"},
Usage: "Manage releases",
Description: "Manage releases",
Action: releases.RunReleasesList,

View File

@ -19,6 +19,7 @@ import (
// CmdReleaseList represents a sub command of Release to list releases
var CmdReleaseList = cli.Command{
Name: "ls",
Aliases: []string{"list"},
Usage: "List Releases",
Description: "List Releases",
Action: RunReleasesList,

View File

@ -18,8 +18,9 @@ import (
// CmdRepos represents to login a gitea server.
var CmdRepos = cli.Command{
Name: "repos",
Usage: "Show repositories details",
Description: "Show repositories details",
Aliases: []string{"repo"},
Usage: "Show repository details",
Description: "Show repository details",
ArgsUsage: "[<repo owner>/<repo name>]",
Action: runRepos,
Subcommands: []*cli.Command{

View File

@ -20,6 +20,7 @@ import (
// CmdReposList represents a sub command of repos to list them
var CmdReposList = cli.Command{
Name: "ls",
Aliases: []string{"list"},
Usage: "List available repositories",
Description: `List available repositories`,
Action: RunReposList,