 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- Constants
- type Config
- type Editor
- func (e *Editor) Attach(app *siris.Application)
- func (e *Editor) Dir(workingDir string) *Editor
- func (e *Editor) DisableOutput()
- func (e *Editor) GetDescription() string
- func (e *Editor) Port(port int) *Editor
- func (e *Editor) SetEnable(enable bool)
- func (e *Editor) User(username string, password string) *Editor
 
Constants ¶
const (
	DefaultPort = 4444
)
    Default values for the configuration
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
	// Hostname if empty used the siris server's hostname
	Hostname string
	// Port if 0 4444
	Port int
	// KeyFile the key file(ssl optional)
	KeyFile string
	// CertFile the cert file (ssl optional)
	CertFile string
	// WorkingDir if empty "./"
	WorkingDir string
	// Username defaults to empty, you should set this
	Username string
	// Password defaults to empty, you should set this
	Password string
	// DisableOutput set that to true if you don't care about alm-tools' messages
	// they are useful because that the default value is "false"
	DisableOutput bool
}
    Config the configs for the Editor plugin
type Editor ¶
type Editor struct {
	// contains filtered or unexported fields
}
    Editor is the alm-tools adaptor.
It holds a logger from the siris' station username,password for basic auth directory which the client side code is keyfile,certfile for TLS listening and a host which is listening for
func (*Editor) Attach ¶
func (e *Editor) Attach(app *siris.Application)
Attach adapts the editor to one or more Siris instance(s).
func (*Editor) Dir ¶
Dir sets the directory which the client side source code alive
func (*Editor) DisableOutput ¶
func (e *Editor) DisableOutput()
DisableOutput call that if you don't care about alm-tools' messages they are useful because that the default configuration shows them
func (*Editor) GetDescription ¶
GetDescription EditorPlugin is a bridge between Siris and the alm-tools, the browser-based IDE for client-side sources.
func (*Editor) Port ¶
Port sets the port (int) for the editor adaptor's standalone server
func (*Editor) SetEnable ¶
SetEnable if true enables the editor adaptor, otherwise disables it
       Source Files
      ¶
      Source Files
      ¶
    
- config.go
- editor.go