Documentation
¶
Index ¶
- Constants
- Variables
- type Config
- type Editor
- 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) Run(logger func(format string, a ...interface{}))
- func (e *Editor) SetEnable(enable bool)
- func (e *Editor) Stop()
- func (e *Editor) User(username string, password string) *Editor
Constants ¶
const (
DefaultPort = 4444
)
Default values for the configuration
Variables ¶
var ( // NoOpLogger can be used as the logger argument, it prints nothing. NoOpLogger = func(string, ...interface{}) {} )
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Hostname if empty used the iris 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
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns the default 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 iris' 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) 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 iris and the alm-tools, the browser-based IDE for client-side sources.
func (*Editor) Run ¶
Run starts the editor's server.
Developers should call the `Stop` to shutdown the editor's server when main server will be closed.
Source Files