fix: Use -dir suffix for plugin package arguments (#1213)

hermanschaaf · web-flow · commit 93f93988d033 · 2023-09-13T14:30:16.000Z
I noticed we use the `-dir` suffix fairly consistently in the CloudQuery CLI, so figured we should keep it the same here.
diff --git a/serve/package.go b/serve/package.go
@@ -214,12 +214,12 @@ func (s *PluginServe) newCmdPluginPackage() *cobra.Command {
 			pluginDirectory := args[0]
 			pluginVersion := args[1]
 			distPath := path.Join(pluginDirectory, "dist")
-			if cmd.Flag("dist").Changed {
-				distPath = cmd.Flag("dist").Value.String()
+			if cmd.Flag("dist-dir").Changed {
+				distPath = cmd.Flag("dist-dir").Value.String()
 			}
 			docsPath := path.Join(pluginDirectory, "docs")
-			if cmd.Flag("docs").Changed {
-				docsPath = cmd.Flag("docs").Value.String()
+			if cmd.Flag("docs-dir").Changed {
+				docsPath = cmd.Flag("docs-dir").Value.String()
 			}
 			if err := os.MkdirAll(distPath, 0755); err != nil {
 				return err
@@ -247,7 +247,7 @@ func (s *PluginServe) newCmdPluginPackage() *cobra.Command {
 			return nil
 		},
 	}
-	cmd.Flags().String("dist", "", "dist directory to output the built plugin. (default: <plugin_directory>/dist)")
-	cmd.Flags().String("docs", "", "docs directory to copy to the dist directory. (default: <plugin_directory>/docs)")
+	cmd.Flags().StringP("dist-dir", "D", "", "dist directory to output the built plugin. (default: <plugin_directory>/dist)")
+	cmd.Flags().StringP("docs-dir", "", "", "docs directory containing markdown files to copy to the dist directory. (default: <plugin_directory>/docs)")
 	return cmd
 }
diff --git a/serve/package_test.go b/serve/package_test.go
@@ -34,7 +34,7 @@ func TestPluginPackage(t *testing.T) {
 	srv := Plugin(p)
 	cmd := srv.newCmdPluginRoot()
 	distDir := t.TempDir()
-	cmd.SetArgs([]string{"package", "--dist", distDir, simplePluginPath, packageVersion})
+	cmd.SetArgs([]string{"package", "--dist-dir", distDir, simplePluginPath, packageVersion})
 	if err := cmd.Execute(); err != nil {
 		t.Fatal(err)
 	}

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ func TestPluginPackage(t *testing.T) {`
`34`	`34`	`srv := Plugin(p)`
`35`	`35`	`cmd := srv.newCmdPluginRoot()`
`36`	`36`	`distDir := t.TempDir()`
`37`		`- cmd.SetArgs([]string{"package", "--dist", distDir, simplePluginPath, packageVersion})`
	`37`	`+ cmd.SetArgs([]string{"package", "--dist-dir", distDir, simplePluginPath, packageVersion})`
`38`	`38`	`if err := cmd.Execute(); err != nil {`
`39`	`39`	`t.Fatal(err)`
`40`	`40`	`}`