issue: 169 - shell auto complete using client and project names

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - new config `lang` to allow setting the number format to be used when printing
+- support to using client's name or id for autocompletion on bash
 
 ## [v0.52.0] - 2024-06-02
 

cmd/gendocs/main.go

@@ -53,8 +53,7 @@ func execute() error {
 		return "/en/commands/" + strings.ToLower(base) + "/"
 	}
 
-	var f cmdutil.Factory
-	cmd := cmd.NewCmdRoot(f)
+	cmd := cmd.NewCmdRoot(cmdutil.NewFactory(cmdutil.Version{}))
 
 	fmt.Println("Generating Hugo command-line documentation in", docdir, "...")
 	err := doc.GenMarkdownTreeCustom(cmd, docdir, prepender, linkHandler)

pkg/cmd/project/get/get.go

@@ -27,7 +27,7 @@ func NewCmdGet(
 		Use:  "get",
 		Args: cmdutil.RequiredNamedArgs("project"),
 		ValidArgsFunction: cmdcompl.CombineSuggestionsToArgs(
-			cmdcomplutil.NewProjectAutoComplete(f)),
+			cmdcomplutil.NewProjectAutoComplete(f, f.Config())),
 		Short: "Get a project on a Clockify workspace",
 		Example: heredoc.Docf(`
 			$ %[1]s 621948458cb9606d934ebb1c

pkg/cmd/project/get/get_test.go

@@ -37,7 +37,10 @@ func TestCmdGet(t *testing.T) {
 			args: []string{"--format={}", "-q", "-j", "p1"},
 			err:  "flags can't be used together.*format.*json.*quiet",
 			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
+				f := mocks.NewMockFactory(t)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
+
+				return f
 			},
 		},
 		{
@@ -46,6 +49,8 @@ func TestCmdGet(t *testing.T) {
 			args: []string{"p1"},
 			factory: func(t *testing.T) cmdutil.Factory {
 				f := mocks.NewMockFactory(t)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
+
 				f.EXPECT().GetWorkspaceID().
 					Return("", errors.New("workspace error"))
 				return f
@@ -57,6 +62,8 @@ func TestCmdGet(t *testing.T) {
 			args: []string{"p1"},
 			factory: func(t *testing.T) cmdutil.Factory {
 				f := mocks.NewMockFactory(t)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
+
 				f.EXPECT().GetWorkspaceID().
 					Return("w", nil)
 				f.EXPECT().Client().Return(nil, errors.New("client error"))

pkg/cmd/task/add/add_test.go

@@ -28,6 +28,12 @@ func TestCmdAdd(t *testing.T) {
 		}
 	}
 
+	dFactory := func(t *testing.T) cmdutil.Factory {
+		f := mocks.NewMockFactory(t)
+		f.EXPECT().Config().Return(&mocks.SimpleConfig{})
+		return f
+	}
+
 	tts := []struct {
 		name    string
 		args    []string
@@ -37,44 +43,34 @@ func TestCmdAdd(t *testing.T) {
 		err string
 	}{
 		{
-			name: "only one format",
-			args: []string{"--format={}", "-q", "-j", "-n=OK", "-p=OK"},
-			err:  "flags can't be used together.*format.*json.*quiet",
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "only one format",
+			args:    []string{"--format={}", "-q", "-j", "-n=OK", "-p=OK"},
+			err:     "flags can't be used together.*format.*json.*quiet",
+			factory: dFactory,
 		},
 		{
-			name: "billable or not",
-			args: []string{"--billable", "--not-billable", "-n=OK", "-p=OK"},
-			err:  "flags can't be used together.*billable.*not-billable",
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "billable or not",
+			args:    []string{"--billable", "--not-billable", "-n=OK", "-p=OK"},
+			err:     "flags can't be used together.*billable.*not-billable",
+			factory: dFactory,
 		},
 		{
-			name: "assignee or no assignee",
-			args: []string{"--assignee=l", "--no-assignee", "-n=OK", "-p=OK"},
-			err:  "flags can't be used together.*assignee.*no-assignee",
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "assignee or no assignee",
+			args:    []string{"--assignee=l", "--no-assignee", "-n=OK", "-p=OK"},
+			err:     "flags can't be used together.*assignee.*no-assignee",
+			factory: dFactory,
 		},
 		{
-			name: "name required",
-			args: []string{"-p=OK"},
-			err:  `"name" not set`,
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "name required",
+			args:    []string{"-p=OK"},
+			err:     `"name" not set`,
+			factory: dFactory,
 		},
 		{
-			name: "project required",
-			args: []string{"-n=OK"},
-			err:  `"project" not set`,
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "project required",
+			args:    []string{"-n=OK"},
+			err:     `"project" not set`,
+			factory: dFactory,
 		},
 		{
 			name: "client error",
@@ -97,6 +93,7 @@ func TestCmdAdd(t *testing.T) {
 			args: []string{"-n=a", "-p=b"},
 			factory: func(t *testing.T) cmdutil.Factory {
 				f := mocks.NewMockFactory(t)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
 				f.On("GetWorkspaceID").
 					Return("", errors.New("workspace error"))
 				return f

pkg/cmd/task/delete/delete_test.go

@@ -31,15 +31,19 @@ func TestCmdDelete(t *testing.T) {
 			args: []string{},
 			err:  "requires arg task",
 			params: func(t *testing.T) (cmdutil.Factory, report) {
-				return mocks.NewMockFactory(t), nil
+				f := mocks.NewMockFactory(t)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
+				return f, nil
 			},
 		},
 		{
 			name: "project is required",
 			err:  "flag.*project.*not set",
 			args: []string{"task-id"},
 			params: func(t *testing.T) (cmdutil.Factory, report) {
-				return mocks.NewMockFactory(t), nil
+				f := mocks.NewMockFactory(t)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
+				return f, nil
 			},
 		},
 		{
@@ -48,6 +52,7 @@ func TestCmdDelete(t *testing.T) {
 			args: []string{"task-id", "-p", "p-1"},
 			params: func(t *testing.T) (cmdutil.Factory, report) {
 				f := mocks.NewMockFactory(t)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
 				f.On("GetWorkspaceID").Return("", errors.New("w error"))
 				return f, nil
 			},
@@ -58,6 +63,7 @@ func TestCmdDelete(t *testing.T) {
 			args: []string{"task-id", "-p", "p-1"},
 			params: func(t *testing.T) (cmdutil.Factory, report) {
 				f := mocks.NewMockFactory(t)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
 				f.On("GetWorkspaceID").Return("w", nil)
 				f.On("Client").Return(nil, errors.New("c error"))
 				return f, nil

pkg/cmd/task/done/done_test.go

@@ -29,6 +29,12 @@ func TestCmdDone(t *testing.T) {
 		}
 	}
 
+	dFactory := func(t *testing.T) cmdutil.Factory {
+		f := mocks.NewMockFactory(t)
+		f.EXPECT().Config().Return(&mocks.SimpleConfig{})
+		return f
+	}
+
 	tts := []struct {
 		name    string
 		args    []string
@@ -38,59 +44,48 @@ func TestCmdDone(t *testing.T) {
 		err string
 	}{
 		{
-			name: "task id required",
-			args: []string{"-p=cli"},
-			err:  `requires arg task`,
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "task id required",
+			args:    []string{"-p=cli"},
+			err:     `requires arg task`,
+			factory: dFactory,
 		},
 		{
-			name: "project required",
-			args: []string{"task"},
-			err:  `"project" not set`,
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "project required",
+			args:    []string{"task"},
+			err:     `"project" not set`,
+			factory: dFactory,
 		},
 		{
-			name: "project not empty",
-			args: []string{"task", "-p=          "},
-			err:  `project should not be empty`,
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "project not empty",
+			args:    []string{"task", "-p=          "},
+			err:     `project should not be empty`,
+			factory: dFactory,
 		},
 		{
-			name: "task id not empty",
-			args: []string{"   ", "-p=cli"},
-			err:  `task id/name should not be empty`,
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "task id not empty",
+			args:    []string{"   ", "-p=cli"},
+			err:     `task id/name should not be empty`,
+			factory: dFactory,
 		},
 		{
-			name: "task id not empty (nice try)",
-			args: []string{"not-empty", "  ", "-p=cli"},
-			err:  `task id/name should not be empty`,
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "task id not empty (nice try)",
+			args:    []string{"not-empty", "  ", "-p=cli"},
+			err:     `task id/name should not be empty`,
+			factory: dFactory,
 		},
 		{
-			name: "only one format",
-			args: []string{"--format={}", "-q", "-j", "-p=OK", "done"},
-			err:  "flags can't be used together.*format.*json.*quiet",
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "only one format",
+			args:    []string{"--format={}", "-q", "-j", "-p=OK", "done"},
+			err:     "flags can't be used together.*format.*json.*quiet",
+			factory: dFactory,
 		},
 		{
 			name: "client error",
 			err:  "client error",
 			args: []string{"done", "-p=b"},
 			factory: func(t *testing.T) cmdutil.Factory {
 				f := mocks.NewMockFactory(t)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
 				f.On("GetWorkspaceID").
 					Return("w", nil)
 
@@ -104,6 +99,7 @@ func TestCmdDone(t *testing.T) {
 			args: []string{"done", "-p=b"},
 			factory: func(t *testing.T) cmdutil.Factory {
 				f := mocks.NewMockFactory(t)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
 				f.On("GetWorkspaceID").
 					Return("", errors.New("workspace error"))
 				return f

pkg/cmd/task/edit/edit_test.go

@@ -28,6 +28,11 @@ func TestCmdEdit(t *testing.T) {
 			return nil
 		}
 	}
+	dFactory := func(t *testing.T) cmdutil.Factory {
+		f := mocks.NewMockFactory(t)
+		f.EXPECT().Config().Return(&mocks.SimpleConfig{})
+		return f
+	}
 
 	tts := []struct {
 		name    string
@@ -38,52 +43,40 @@ func TestCmdEdit(t *testing.T) {
 		err string
 	}{
 		{
-			name: "task id required",
-			args: []string{"-p=cli"},
-			err:  `requires arg task`,
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "task id required",
+			args:    []string{"-p=cli"},
+			err:     `requires arg task`,
+			factory: dFactory,
 		},
 		{
-			name: "project required",
-			args: []string{"task"},
-			err:  `"project" not set`,
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "project required",
+			args:    []string{"task"},
+			err:     `"project" not set`,
+			factory: dFactory,
 		},
 		{
-			name: "task id not empty",
-			args: []string{"   ", "-p=cli"},
-			err:  `task id should not be empty`,
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "task id not empty",
+			args:    []string{"   ", "-p=cli"},
+			err:     `task id should not be empty`,
+			factory: dFactory,
 		},
 		{
-			name: "only one format",
-			args: []string{"--format={}", "-q", "-j", "-p=OK", "edit"},
-			err:  "flags can't be used together.*format.*json.*quiet",
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "only one format",
+			args:    []string{"--format={}", "-q", "-j", "-p=OK", "edit"},
+			err:     "flags can't be used together.*format.*json.*quiet",
+			factory: dFactory,
 		},
 		{
-			name: "billable or not",
-			args: []string{"--billable", "--not-billable", "edit", "-p=OK"},
-			err:  "flags can't be used together.*billable.*not-billable",
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "billable or not",
+			args:    []string{"--billable", "--not-billable", "edit", "-p=OK"},
+			err:     "flags can't be used together.*billable.*not-billable",
+			factory: dFactory,
 		},
 		{
-			name: "assignee or no assignee",
-			args: []string{"--assignee=l", "--no-assignee", "edit", "-p=OK"},
-			err:  "flags can't be used together.*assignee.*no-assignee",
-			factory: func(t *testing.T) cmdutil.Factory {
-				return mocks.NewMockFactory(t)
-			},
+			name:    "assignee or no assignee",
+			args:    []string{"--assignee=l", "--no-assignee", "edit", "-p=OK"},
+			err:     "flags can't be used together.*assignee.*no-assignee",
+			factory: dFactory,
 		},
 		{
 			name: "client error",
@@ -106,6 +99,7 @@ func TestCmdEdit(t *testing.T) {
 			args: []string{"edit", "-p=b"},
 			factory: func(t *testing.T) cmdutil.Factory {
 				f := mocks.NewMockFactory(t)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
 				f.On("GetWorkspaceID").
 					Return("", errors.New("workspace error"))
 				return f