setup

Documentation

Index

• Variables
• func SupportedIdes(workDir string, port int) map[string]Ide
• type Ide
• type VsCode
  • func (v VsCode) Detected() (bool, error)
  • func (v VsCode) Disable() error
  • func (v VsCode) Enable() error
  • func (v VsCode) GebugInstalled() (bool, error)

Variables

var AppFs = afero.NewOsFs()

AppFs hold the file-system abstraction for this package

Functions

func SupportedIdes

func SupportedIdes(workDir string, port int) map[string]Ide

SupportedIdes returns a dictionary holds the IDE name along with the corresponding instance

Types

type Ide

type Ide interface {
	// Detected tells if the IDE trails were found in the working directory. e.g: `.vscode` or `.idea` directories.
	Detected() (bool, error)

	// GebugInstalled tells if Gebug debugger mode was set in the IDE
	GebugInstalled() (bool, error)

	// Enable Gebug's debugger configurations
	Enable() error

	// Disable Gebug's debugger configurations
	Disable() error
}

Ide defines the expected behaviour of each IDE that will have a Gebug integration

type VsCode

type VsCode struct {
	// contains filtered or unexported fields
}

VsCode is the 'Visual Studio Code' integration with Gebug

func (VsCode) Detected

func (v VsCode) Detected() (bool, error)

Detected tells if the IDE trails were found in the working directory (the `.vscode` directory exists)

func (VsCode) Disable

func (v VsCode) Disable() error

Disable Gebug's debugger configurations by removing the Gebug object from the configurations json in 'launch.json'

func (VsCode) Enable

func (v VsCode) Enable() error

Enable Gebug's debugger configurations by adding the Gebug object from the configurations json in 'launch.json'

func (VsCode) GebugInstalled

func (v VsCode) GebugInstalled() (bool, error)

GebugInstalled tells if Gebug debugger mode was set in the IDE 'launch.json' file