Vscode persistence by agrasth · Pull Request #282 · jfrog/jfrog-cli-artifactory

agrasth · 2025-10-15T19:35:01Z

All tests passed. If this feature is not already covered by the tests, I added new tests.
All static analysis checks passed.
Appropriate label is added to auto generate release notes.
I used gofmt for formatting the code before submitting the pull request.
PR description is clear and concise, and it includes the proposed solution/fix.

Introduced a new IDE integration system for configuring VSCode-based editors (VSCode, Cursor, Windsurf) and JetBrains IDEs to use JFrog Artifactory as their extension/plugin marketplace.

New Commands

jf ide setup vscode --repo-key <key>      # Configure VSCode
jf ide setup cursor --repo-key <key>      # Configure Cursor
jf ide setup windsurf --repo-key <key>    # Configure Windsurf
jf ide setup jetbrains --repo-key <key>   # Configure JetBrains IDEs

Architecture & Design Patterns

1. Configuration-Based Design (VSCode Forks)

Uses a registry pattern to handle multiple VSCode-based IDEs with a single implementation:

aieditorextensions/
├── vscode_fork_registry.go    # Configuration registry
├── vscode_fork.go              # Single generic implementation
└── vscode_setup.go             # Entry points (SetupVSCode, SetupCursor, SetupWindsurf)

2. Common Package Pattern

Extracted shared logic into ide/common/ to eliminate duplication:

ide/
├── common/base.go              # Shared: Server config, validation, URL building
├── commands/
│   ├── aieditorextensions/     # AI Editor Extensions specific
│   └── jetbrains/              # JetBrains specific

3. Unified Command Structure

Single setup command with IDE name as argument:

jf ide setup <IDE_NAME> [OPTIONS]

Routing:

cli.go
    ├─> vscode/cursor/windsurf  → aieditorextensions.Setup*()
    └─> jetbrains               → jetbrains.SetupJetBrains()

📁 Final Structure

ide/
├── cli/
│   ├── cli.go              # Command registration + setup command & routing
│   ├── cli_test.go         # CLI tests
│   └── common.go           # Shared server flags
│
├── common/
│   └── base.go             # Shared utilities (server, validation, URLs)
│
└── commands/
    ├── aieditorextensions/
    │   ├── base.go                 # Package-specific config
    │   ├── vscode_fork_registry.go # VSCode fork configurations
    │   ├── vscode_fork.go          # Generic implementation
    │   ├── vscode_setup.go         # Entry points
    │   ├── settings_helper.go      # settings.json handling
    │   ├── instructions.go         # Manual setup instructions
    │   ├── vscode_fork_test.go     # Tests
    │   └── settings_helper_test.go # Tests
    │
    └── jetbrains/
        ├── base.go             # Package-specific config
        ├── jetbrains.go        # JetBrains implementation
        ├── jetbrains_setup.go  # Entry point
        ├── instructions.go     # Manual setup instructions
        └── jetbrains_test.go   # Tests

Technical Details

API Types

aieditorextensions - VSCode, Cursor, Windsurf (all VSCode forks)
jetbrainsplugins - IntelliJ, PyCharm, WebStorm, etc.

VSCode Fork Registry

var VSCodeForks = map[string]*VSCodeForkConfig{
    "vscode":   { Name: "vscode", DisplayName: "Visual Studio Code", ... },
    "cursor":   { Name: "cursor", DisplayName: "Cursor", ... },
    "windsurf": { Name: "windsurf", DisplayName: "Windsurf", ... },
}

Common Package Functions

common.GetServerDetails()           // Server configuration
common.ValidateRepository()         // Repository validation (parameterized)
common.BuildURL()                   // Generic URL builder
common.ExtractRepoKeyFromURL()      // Parse repo key from URL

CLI Common Flags

cli.GetCommonServerFlags()          // Shared server flags (url, user, password, etc.)

Notes

VSCode-based IDEs: Modifies product.json and optionally settings.json
JetBrains IDEs: Modifies idea.properties files
Automatic backup/restore on configuration errors
Graceful fallback to manual instructions on permission issues

Related PRs

jfrog-cli: Integration tests updated to use new command structure
- Updated IDE design and added support for vscode persistence jfrog-cli#3164

reshmifrog · 2025-10-16T04:46:12Z

-		}
-		return errors.New(errorMsg)
+// GetSetupCommand returns the setup command with IDE_NAME as argument
+func GetSetupCommand() components.Command {


let's not make a separate methods to get command components , can be done like this
func GetCommands() []components.Command { return []components.Command{ { Name: "setup", Description: setup.GetDescription(), Arguments: setup.GetArguments(), Flags: commands.GetSetupFlags(), Action: setupCmd, Aliases: []string{"s"}, Category: ideCategory, }, } }

ok will update this

reshmifrog · 2025-10-16T04:50:49Z

-		return errors.New(errorMsg)
+}
+
+func getSetupArguments() []components.Argument {


move this to help doc section for ide and then use it like this in command components
Description: setup.GetDescription(), Arguments: setup.GetArguments(),

great point, will update this.

reshmifrog · 2025-10-16T04:52:25Z

+		return errors.New("IDE_NAME is required. Usage: jf ide setup <IDE_NAME>\nSupported IDEs: vscode, cursor, windsurf, jetbrains")
+	}
+
+	ideName := strings.ToLower(c.GetArgumentAt(0))


we should not convert the ide name to lower case and validate , it should fail in case the command is jf ide setup VSCODE

Sorry I didn't get the second line, can you pls elaborate this point.

reshmifrog · 2025-10-16T04:53:14Z

-	return []string{commands.IdeVSCode, commands.IdeJetBrains}
+func setupCmd(c *components.Context) error {
+	if c.GetNumberOfArgs() == 0 {
+		return errors.New("IDE_NAME is required. Usage: jf ide setup <IDE_NAME>\nSupported IDEs: vscode, cursor, windsurf, jetbrains")


i think for now only vscode and jetbrains are supported , please confirm this

This PR, I have also added support for cursor and windsurf.

reshmifrog · 2025-10-16T04:54:54Z

+	return append(flags, ideSpecificFlags...)
 }

-func supportedIDEs() []string {


why did we removed this method can we not use it and instead of adding every the suported ide's we can just use this unified method which will have the list of all the supported ide's

great point, added this method.

reshmifrog · 2025-10-16T04:59:24Z

+    sudo jf ide setup %s --repo-key <your-repo-key>
+
+Or with direct URL:
+    sudo jf ide setup %s '%s'


why have we added %s two times?

sudo jf ide setup %s '%s' ↑ ↑ │ └─ serviceURL └───── ideName

reshmifrog · 2025-10-17T05:37:59Z

+
+// createBackup creates a backup of product.json
+func (vc *VSCodeForkCommand) createBackup() error {
+	timestamp := time.Now().Format("20060102_150405")


can you please check if this format is correct and the required timstamp format

reshmifrog · 2025-10-17T05:48:50Z

+}
+
+// validateRepository validates that the repository exists and is the correct type
+func (vc *VSCodeForkCommand) validateRepository() error {


i think we have the same method for validating repository in jetbrains as well can you please check and make sure we don't have redundant code, let's make it exported and use it

This is handled here.

reshmifrog · 2025-10-17T05:50:41Z

+	DisplayName  string              // User-facing name (e.g., "Visual Studio Code", "Cursor")
+	InstallPaths map[string][]string // OS -> possible installation paths
+	ProductJson  string              // Relative path to product.json (usually just "product.json")
+	SettingsDir  string              // Settings directory name (e.g., "Code", "Cursor")


let's remove these comments from struct fields

reshmifrog · 2025-10-17T05:56:20Z

+}
+
+// ValidateRepository validates that the repository exists and is of the specified type
+func ValidateRepository(repoKey string, rtDetails *config.ServerDetails, apiType string) error {


we already have ValidateRepository method in other files and we just use this one everywhere

Will update this thanks

bhanurp · 2025-10-28T10:23:38Z

+		return fmt.Errorf("repository '%s' is not of type '%s': %w", repoKey, apiType, err)
+	}
+
+	log.Info("Repository validation successful")


Suggested change

log.Info("Repository validation successful")

log.Debug("Repository validation successful")

Added support for vscodePersistence using update.mode:flag

a77ccef

agrasth had a problem deploying to frogbot October 15, 2025 19:35 — with GitHub Actions Failure

agrasth added the improvement Automatically generated release notes label Oct 15, 2025

agrasth requested review from bhanurp and reshmifrog October 15, 2025 19:48

agrasth mentioned this pull request Oct 15, 2025

Updated IDE design and added support for vscode persistence jfrog/jfrog-cli#3164

Merged

4 tasks done

agrasth force-pushed the vscodePersistence branch from 8b23e4e to a675a45 Compare October 15, 2025 20:13

agrasth had a problem deploying to frogbot October 15, 2025 20:13 — with GitHub Actions Failure

Updated IDE design and added support for vscode persistence

ee64429

agrasth force-pushed the vscodePersistence branch from a675a45 to ee64429 Compare October 15, 2025 20:24

agrasth had a problem deploying to frogbot October 15, 2025 20:25 — with GitHub Actions Failure

reshmifrog requested changes Oct 17, 2025

View reviewed changes

Merge branch 'main' into vscodePersistence

595da46

agrasth had a problem deploying to frogbot October 26, 2025 17:31 — with GitHub Actions Failure

Resolved comments

4771fd8

agrasth had a problem deploying to frogbot October 26, 2025 19:27 — with GitHub Actions Failure

agrasth requested a review from reshmifrog October 27, 2025 06:26

bhanurp approved these changes Oct 29, 2025

View reviewed changes

Merge branch 'main' into vscodePersistence

4277646

agrasth had a problem deploying to frogbot October 29, 2025 09:08 — with GitHub Actions Failure

agrasth merged commit 348f357 into jfrog:main Oct 29, 2025
10 of 11 checks passed

	log.Info("Repository validation successful")
	log.Debug("Repository validation successful")

Conversation

agrasth commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Commands

Architecture & Design Patterns

1. Configuration-Based Design (VSCode Forks)

2. Common Package Pattern

3. Unified Command Structure

📁 Final Structure

Technical Details

API Types

VSCode Fork Registry

Common Package Functions

CLI Common Flags

Notes

Related PRs

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This branch had an error being deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

agrasth commented Oct 15, 2025 •

edited

Loading