Documentation ¶
Index ¶
Constants ¶
const DefaultPrompt = "-> "
DefaultPrompt is the default prompt line prefix to use for user input querying.
const HistoryFile = "history"
HistoryFile is the file within the data directory to store input scrollback.
Variables ¶
var Stdin = newTerminalPrompter()
Stdin holds the stdin line reader (also using stdout for printing prompts). Only this reader may be used for input because it keeps an internal buffer.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { DataDir string // Data directory to store the console history at Client *rpc.Client // RPC client to execute Vite requests through DocRoot string // Filesystem path from where to load JavaScript files from Prompt string // Input prompt prefix string (defaults to DefaultPrompt) Preload []string // Absolute paths to JavaScript files to preload Printer io.Writer // Output writer to serialize any display strings to (defaults to os.Stdout) Prompter UserPrompter // Input prompter to allow interactive user feedback (defaults to TerminalPrompter) }
Config is the collection of configurations to fine tune the behavior of the JavaScript console.
type Console ¶
type Console struct {
// contains filtered or unexported fields
}
Console is a JavaScript interpreted runtime environment. It is a fully fledged JavaScript console attached to a running node via an external or in-process RPC client.
func New ¶
New initializes a JavaScript interpreted runtime environment and sets defaults with the config struct.
func (*Console) AutoCompleteInput ¶
AutoCompleteInput is a pre-assembled word completer to be used by the user input prompter to provide hints to the user about the methods available.
func (*Console) Evaluate ¶
Evaluate executes code and pretty prints the result to the specified output stream.
func (*Console) Execute ¶
Execute runs the JavaScript file specified as the argument.
func (*Console) Interactive ¶
func (c *Console) Interactive()
Interactive starts an interactive user session, where input is propted from the configured user prompter.
func (*Console) Stop ¶
Stop cleans up the console and terminates the runtime environment.
type UserPrompter ¶
type UserPrompter interface { // PromptInput displays the given prompt to the user and requests some textual data to be entered, returning the input of the user. PromptInput(prompt string) (string, error) // PromptPassword displays the given prompt to the user and requests some textual data to be entered, but one which must not be echoed out into the terminal. // The method returns the input provided by the user. PromptPassword(prompt string) (string, error) // PromptConfirm displays the given prompt to the user and requests a boolean choice to be made, returning that choice. PromptConfirm(prompt string) (bool, error) // SetHistory sets the the input scrollback history that the prompter will allow the user to scroll back to. SetHistory(history []string) // AppendHistory appends an entry to the scrollback history. It should be called if and only if the prompt to append was a valid command. AppendHistory(command string) // ClearHistory clears the entire history ClearHistory() // SetWordCompleter sets the completion function that the prompter will call to fetch completion candidates when the user presses tab. SetWordCompleter(completer WordCompleter) }
UserPrompter defines the methods needed by the console to promt the user for various types of inputs.
type WordCompleter ¶
WordCompleter takes the currently edited line with the cursor position and returns the completion candidates for the partial word to be completed. If the line is "Hello, wo!!!" and the cursor is before the first '!', ("Hello, wo!!!", 9) is passed to the completer which may returns ("Hello, ", {"world", "Word"}, "!!!") to have "Hello, world!!!".