Updated code on reviews and feedback

Author: agrasth

IDE_SETUP_COMMANDS.md

@@ -11,19 +11,47 @@ The IDE setup commands allow developers to configure their development environme
 - Maintain control over which extensions/plugins are available
 - Work in air-gapped or restricted network environments
 
+## Prerequisites
+
+Before using the IDE setup commands, ensure you have the JFrog CLI installed:
+
+```bash
+# Install JFrog CLI (macOS/Linux)
+curl -fL https://getcli.jfrog.io | sh && mv jfrog /usr/local/bin/
+
+# Or with Homebrew (macOS/Linux)
+brew install jfrog-cli
+
+# Or with Chocolatey (Windows)
+choco install jfrog-cli
+```
+
+For more details and installation options, see the [JFrog CLI documentation](https://jfrog.com/getcli/).
+
+## How File Modifications Are Performed
+
+The IDE setup commands update configuration files directly on your system. The following tools and methods are used in the background:
+
+- **macOS/Linux:** Uses the `sed` command-line tool to modify JSON or properties files in-place.
+- **Windows:** Uses PowerShell scripts to update configuration files.
+- **Backup:** Before any modification, a backup of the original file is created in the same or a dedicated backup directory.
+
+> **Note:** You must have the required permissions to modify these files. For system-wide installations, you may need to run the command with `sudo` (macOS/Linux) or as Administrator (Windows).
+
 ## Commands
 
-### VSCode Configuration: `jf rt vscode-config`
+### VSCode Configuration: `jf vscode-config`
 
 Configures Visual Studio Code to use JFrog Artifactory for extensions.
 
 #### Syntax
 ```bash
-jf rt vscode-config <service-url> [flags]
+jf vscode-config <service-url> [flags]
 ```
 
 #### Aliases
-- `jf rt vscode`
+- `jf vscode`
+- `jf code`
 
 #### Parameters
 
@@ -47,22 +75,22 @@ https://<artifactory-url>/artifactory/api/vscodeextensions/<repo-key>/_apis/publ
 
 **Basic usage (no server authentication):**
 ```bash
-jf rt vscode-config https://mycompany.jfrog.io/artifactory/api/vscodeextensions/vscode-extensions/_apis/public/gallery
+jf vscode-config https://mycompany.jfrog.io/artifactory/api/vscodeextensions/vscode-extensions/_apis/public/gallery
 ```
 
 **With custom product.json path:**
 ```bash
-jf rt vscode-config https://mycompany.jfrog.io/artifactory/api/vscodeextensions/vscode-extensions/_apis/public/gallery --product-json-path="/custom/path/product.json"
+jf vscode-config https://mycompany.jfrog.io/artifactory/api/vscodeextensions/vscode-extensions/_apis/public/gallery --product-json-path="/custom/path/product.json"
 ```
 
 **With repository validation:**
 ```bash
-jf rt vscode-config https://mycompany.jfrog.io/artifactory/api/vscodeextensions/vscode-extensions/_apis/public/gallery --url https://mycompany.jfrog.io --access-token mytoken123
+jf vscode-config https://mycompany.jfrog.io/artifactory/api/vscodeextensions/vscode-extensions/_apis/public/gallery --url https://mycompany.jfrog.io --access-token mytoken123
 ```
 
 **Using pre-configured server:**
 ```bash
-jf rt vscode-config https://mycompany.jfrog.io/artifactory/api/vscodeextensions/vscode-extensions/_apis/public/gallery --server-id my-artifactory
+jf vscode-config https://mycompany.jfrog.io/artifactory/api/vscodeextensions/vscode-extensions/_apis/public/gallery --server-id my-artifactory
 ```
 
 #### Behavior
@@ -88,17 +116,18 @@ jf rt vscode-config https://mycompany.jfrog.io/artifactory/api/vscodeextensions/
 - `/opt/visual-studio-code/resources/app/product.json`
 - `~/.local/share/applications/code/resources/app/product.json`
 
-### JetBrains Configuration: `jf rt jetbrains-config`
+### JetBrains Configuration: `jf jetbrains-config`
 
 Configures JetBrains IDEs to use JFrog Artifactory for plugins.
 
 #### Syntax
 ```bash
-jf rt jetbrains-config <repository-url> [flags]
+jf jetbrains-config <repository-url> [flags]
 ```
 
 #### Aliases
-- `jf rt jetbrains`
+- `jf jetbrains`
+- `jf jb`
 
 #### Parameters
 
@@ -121,17 +150,17 @@ https://<artifactory-url>/artifactory/api/jetbrainsplugins/<repo-key>
 
 **Basic usage (no server authentication):**
 ```bash
-jf rt jetbrains-config https://mycompany.jfrog.io/artifactory/api/jetbrainsplugins/jetbrains-plugins
+jf jetbrains-config https://mycompany.jfrog.io/artifactory/api/jetbrainsplugins/jetbrains-plugins
 ```
 
 **With repository validation:**
 ```bash
-jf rt jetbrains-config https://mycompany.jfrog.io/artifactory/api/jetbrainsplugins/jetbrains-plugins --url https://mycompany.jfrog.io --access-token mytoken123
+jf jetbrains-config https://mycompany.jfrog.io/artifactory/api/jetbrainsplugins/jetbrains-plugins --url https://mycompany.jfrog.io --access-token mytoken123
 ```
 
 **Using pre-configured server:**
 ```bash
-jf rt jetbrains-config https://mycompany.jfrog.io/artifactory/api/jetbrainsplugins/jetbrains-plugins --server-id my-artifactory
+jf jetbrains-config https://mycompany.jfrog.io/artifactory/api/jetbrainsplugins/jetbrains-plugins --server-id my-artifactory
 ```
 
 #### Behavior
@@ -252,10 +281,10 @@ The IDE setup commands can be integrated into development environment setup scri
 # Developer onboarding script
 
 # Configure VSCode
-jf rt vscode-config https://company.jfrog.io/artifactory/api/vscodeextensions/approved-extensions/_apis/public/gallery
+jf vscode-config https://company.jfrog.io/artifactory/api/vscodeextensions/approved-extensions/_apis/public/gallery
 
 # Configure JetBrains IDEs
-jf rt jetbrains-config https://company.jfrog.io/artifactory/api/jetbrainsplugins/approved-plugins
+jf jetbrains-config https://company.jfrog.io/artifactory/api/jetbrainsplugins/approved-plugins
 
 echo "IDE configuration complete. Please restart your IDEs."
 ```
@@ -297,4 +326,26 @@ echo "IDE configuration complete. Please restart your IDEs."
 └── <plugin-id>/
     └── <version>/
         └── <plugin-name>-<version>.zip
-``` 
+```
+
+## Troubleshooting
+
+If you encounter issues during IDE configuration, consider the following:
+
+- **File modification failed:**
+  - Ensure you have write permissions to the configuration file.
+  - On macOS/Linux, try running the command with `sudo`.
+  - On Windows, run your terminal as Administrator.
+  - Check that `sed` (macOS/Linux) or PowerShell (Windows) is available in your environment.
+- **VSCode/JetBrains not detected:**
+  - Make sure the IDE is installed in a standard location, or specify the path manually using the appropriate flag.
+- **Configuration not applied:**
+  - Verify that a backup file was created (indicates successful file access).
+  - Manually inspect the configuration file to ensure changes were made.
+  - Restart your IDE after running the command.
+- **Permission errors:**
+  - See the error message for instructions on how to resolve permission issues.
+- **Backup/restore issues:**
+  - If something goes wrong, restore the original file from the backup created by the CLI.
+
+For more troubleshooting tips, see the [JFrog CLI documentation](https://jfrog.com/getcli/). 

artifactory/cli/cli.go

@@ -6,8 +6,6 @@ import (
 	"strings"
 
 	ioutils "github.com/jfrog/gofrog/io"
-	"github.com/jfrog/jfrog-cli-artifactory/artifactory/cli/ide/jetbrains"
-	"github.com/jfrog/jfrog-cli-artifactory/artifactory/cli/ide/vscode"
 	"github.com/jfrog/jfrog-cli-artifactory/artifactory/commands/buildinfo"
 	"github.com/jfrog/jfrog-cli-artifactory/artifactory/commands/container"
 	"github.com/jfrog/jfrog-cli-artifactory/artifactory/commands/curl"
@@ -406,10 +404,6 @@ func GetCommands() []components.Command {
 			Category:    replicCategory,
 		},
 	}
-	// Add all VSCode commands
-	commands = append(commands, vscode.GetCommands()...)
-	// Add all JetBrains commands
-	commands = append(commands, jetbrains.GetCommands()...)
 
 	return commands
 }

artifactory/cli/ide/common.go

@@ -0,0 +1,30 @@
+package ide
+
+import (
+	"fmt"
+
+	pluginsCommon "github.com/jfrog/jfrog-cli-core/v2/plugins/common"
+	"github.com/jfrog/jfrog-cli-core/v2/plugins/components"
+)
+
+// ValidateSingleNonEmptyArg checks that there is exactly one argument and it is not empty.
+func ValidateSingleNonEmptyArg(c *components.Context, usage string) (string, error) {
+	if c.GetNumberOfArgs() != 1 {
+		return "", pluginsCommon.WrongNumberOfArgumentsHandler(c)
+	}
+	arg := c.GetArgumentAt(0)
+	if arg == "" {
+		return "", fmt.Errorf("argument cannot be empty\n\nUsage: %s", usage)
+	}
+	return arg, nil
+}
+
+// HasServerConfigFlags checks if any server configuration flags are provided
+func HasServerConfigFlags(c *components.Context) bool {
+	return c.IsFlagSet("url") ||
+		c.IsFlagSet("user") ||
+		c.IsFlagSet("access-token") ||
+		c.IsFlagSet("server-id") ||
+		// Only consider password if other required fields are also provided
+		(c.IsFlagSet("password") && (c.IsFlagSet("url") || c.IsFlagSet("server-id")))
+}

artifactory/cli/ide/descriptions.go

@@ -0,0 +1,42 @@
+package ide
+
+const VscodeConfigDescription = `
+Configure VSCode to use JFrog Artifactory for extensions.
+
+The service URL should be in the format:
+https://<artifactory-url>/artifactory/api/vscodeextensions/<repo-key>/_apis/public/gallery
+
+Examples:
+  jf vscode-config https://mycompany.jfrog.io/artifactory/api/vscodeextensions/vscode-extensions/_apis/public/gallery
+
+This command will:
+- Modify the VSCode product.json file to change the extensions gallery URL
+- Create an automatic backup before making changes
+- Require VSCode to be restarted to apply changes
+
+Optional: Provide server configuration flags (--url, --user, --password, --access-token, or --server-id) 
+to enable repository validation. Without these flags, the command will only modify the local VSCode configuration.
+
+Note: On macOS/Linux, you may need to run with sudo for system-installed VSCode.
+`
+
+const JetbrainsConfigDescription = `
+Configure JetBrains IDEs to use JFrog Artifactory for plugins.
+
+The repository URL should be in the format:
+https://<artifactory-url>/artifactory/api/jetbrainsplugins/<repo-key>
+
+Examples:
+  jf jetbrains-config https://mycompany.jfrog.io/artifactory/api/jetbrainsplugins/jetbrains-plugins
+
+This command will:
+- Detect all installed JetBrains IDEs
+- Modify each IDE's idea.properties file to add the plugins repository URL
+- Create automatic backups before making changes
+- Require IDEs to be restarted to apply changes
+
+Optional: Provide server configuration flags (--url, --user, --password, --access-token, or --server-id) 
+to enable repository validation. Without these flags, the command will only modify the local IDE configuration.
+
+Supported IDEs: IntelliJ IDEA, PyCharm, WebStorm, PhpStorm, RubyMine, CLion, DataGrip, GoLand, Rider, Android Studio, AppCode, RustRover, Aqua
+`

artifactory/cli/ide/jetbrains/cli.go

@@ -2,8 +2,10 @@ package jetbrains
 
 import (
 	"fmt"
+	"net/url"
 	"strings"
 
+	"github.com/jfrog/jfrog-cli-artifactory/artifactory/cli/ide"
 	"github.com/jfrog/jfrog-cli-artifactory/artifactory/commands/ide/jetbrains"
 	pluginsCommon "github.com/jfrog/jfrog-cli-core/v2/plugins/common"
 	"github.com/jfrog/jfrog-cli-core/v2/plugins/components"
@@ -13,39 +15,18 @@ import (
 func GetCommands() []components.Command {
 	return []components.Command{
 		{
-			Name:    "jetbrains-config",
-			Aliases: []string{"jetbrains"},
-			Action:  jetbrainsConfigCmd,
-			Description: `Configure JetBrains IDEs to use JFrog Artifactory for plugins.
-
-The repository URL should be in the format:
-https://<artifactory-url>/artifactory/api/jetbrainsplugins/<repo-key>
-
-Examples:
-  jf rt jetbrains-config https://mycompany.jfrog.io/artifactory/api/jetbrainsplugins/jetbrains-plugins
-
-This command will:
-- Detect all installed JetBrains IDEs
-- Modify each IDE's idea.properties file to add the plugins repository URL
-- Create automatic backups before making changes
-- Require IDEs to be restarted to apply changes
-
-Optional: Provide server configuration flags (--url, --user, --password, --access-token, or --server-id) 
-to enable repository validation. Without these flags, the command will only modify the local IDE configuration.
-
-Supported IDEs: IntelliJ IDEA, PyCharm, WebStorm, PhpStorm, RubyMine, CLion, DataGrip, GoLand, Rider, Android Studio, AppCode, RustRover, Aqua`,
+			Name:        "jetbrains-config",
+			Aliases:     []string{"jetbrains"},
+			Action:      jetbrainsConfigCmd,
+			Description: ide.JetbrainsConfigDescription,
 		},
 	}
 }
 
 func jetbrainsConfigCmd(c *components.Context) error {
-	if c.GetNumberOfArgs() == 0 {
-		return fmt.Errorf("repository URL is required\n\nUsage: jf rt jetbrains-config <repository-url>\nExample: jf rt jetbrains-config https://mycompany.jfrog.io/artifactory/api/jetbrainsplugins/jetbrains-plugins")
-	}
-
-	repositoryURL := c.GetArgumentAt(0)
-	if repositoryURL == "" {
-		return fmt.Errorf("repository URL cannot be empty\n\nUsage: jf rt jetbrains-config <repository-url>")
+	repositoryURL, err := ide.ValidateSingleNonEmptyArg(c, "jf jetbrains-config <repository-url>")
+	if err != nil {
+		return err
 	}
 
 	// Extract repo key from repository URL for potential validation
@@ -54,10 +35,8 @@ func jetbrainsConfigCmd(c *components.Context) error {
 	// Create server details only if server configuration flags are provided
 	// This makes server configuration optional for basic JetBrains setup
 	var rtDetails *config.ServerDetails
-	var err error
 
-	// Check if any server configuration flags are provided
-	if hasServerConfigFlags(c) {
+	if ide.HasServerConfigFlags(c) {
 		rtDetails, err = pluginsCommon.CreateArtifactoryDetailsByFlags(c)
 		if err != nil {
 			return fmt.Errorf("failed to create server configuration: %w", err)
@@ -72,39 +51,29 @@ func jetbrainsConfigCmd(c *components.Context) error {
 	return jetbrainsCmd.Run()
 }
 
-// hasServerConfigFlags checks if any server configuration flags are provided
-func hasServerConfigFlags(c *components.Context) bool {
-	// Check for common server configuration flags
-	return c.IsFlagSet("url") ||
-		c.IsFlagSet("user") ||
-		c.IsFlagSet("password") ||
-		c.IsFlagSet("access-token") ||
-		c.IsFlagSet("server-id")
-}
-
 // extractRepoKeyFromRepositoryURL extracts the repository key from a JetBrains repository URL
 // Expected format: https://<server>/artifactory/api/jetbrainsplugins/<repo-key>
 func extractRepoKeyFromRepositoryURL(repositoryURL string) string {
 	if repositoryURL == "" {
 		return ""
 	}
 
-	// Look for the pattern: /api/jetbrainsplugins/<repo-key>
-	const prefix = "/api/jetbrainsplugins/"
-
-	startIdx := strings.Index(repositoryURL, prefix)
-	if startIdx == -1 {
+	// Parse the URL to extract the repository key
+	parsedURL, err := url.Parse(repositoryURL)
+	if err != nil {
 		return ""
 	}
-	startIdx += len(prefix)
 
-	// Get everything after the prefix (until end of string or next slash)
-	remaining := repositoryURL[startIdx:]
-	endIdx := strings.Index(remaining, "/")
-	if endIdx == -1 {
-		// No trailing slash, use the rest of the string
-		return remaining
+	// Split the path to find the repository key
+	// Expected path: /artifactory/api/jetbrainsplugins/<repo-key>
+	pathParts := strings.Split(strings.TrimPrefix(parsedURL.Path, "/"), "/")
+
+	// Look for the jetbrainsplugins API path
+	for i, part := range pathParts {
+		if part == "api" && i+1 < len(pathParts) && pathParts[i+1] == "jetbrainsplugins" && i+2 < len(pathParts) {
+			return pathParts[i+2]
+		}
 	}
 
-	return remaining[:endIdx]
+	return ""
 }