Howl Documentation

This is the documentation for the 0.1* releases of Howl. To view the latest documentation, please visit the main documentation page

User manual

1 Getting started

2 Configuring Howl

3 Using Howl completions

4 Working with files

5 Editing

6 Using multiple views

7 What's next?

API reference

howl.Application

howl.bindings

howl.Buffer

howl.Chunk

howl.config

howl.inputs

howl.regex

howl.signal

howl.timer

howl.ui.Cursor

howl.ui.Editor

howl.ui.Readline

howl.ui.Selection

howl.ui.Window

howl.ustring (String extensions)

(.. WIP)

Howl specs (tests)

Below are the Howl specs in HTML format. While the specs are certainly not complete, they are provided here in the hope that they may be useful for better understanding the API, as well as providing some code examples. Bundle specs are currently not included in the below list.

Spec - howl.Application

Spec - howl.aux.destructor(callback, ...)

Spec - howl.aux.lpeg_lexer

Spec - howl.aux.moon.PropertyObject

Spec - howl.aux.PropertyTable(table)

Spec - howl.aux.Sandbox(env, options)

Spec - howl.aux.SandboxedLoader(dir, name, sandbox_options)

Spec - howl.aux.ScintilluaLexer

Spec - howl.bindings

Spec - howl.BufferContext

Spec - howl.BufferLines

Spec - howl.Buffer

Spec - howl.bundle

Spec - howl.Chunk

Spec - howl.command

Spec - howl.Completer

Spec - howl.completion.api_completer(api, resolver)

Spec - howl.completion.InBufferCompleter.complete()

Spec - howl.completion

Spec - howl.config

Spec - howl.editing.auto_pair.handle(event, editor)

Spec - howl.editing.text

Spec - howl.formatting

Spec - howl.fs.File

Spec - howl.Globals

Spec - howl.inputs.File inputs

Spec - howl.inputs.ProjectFile

Spec - howl.inputs.search_inputs

Spec - howl.inputs.VariableAssignmentInput

Spec - howl.inputs

Spec - howl.log

Spec - howl.mode

Spec - howl.modes.DefaultMode

Spec - howl.Project

Spec - howl.Regex

Spec - howl.Scintilla

Spec - howl.Settings

Spec - howl.signal

Spec - howl.styler

Spec - howl.timer

Spec - howl.ui.ActionBuffer

Spec - howl.ui.Cursor

Spec - howl.ui.Editor

Spec - howl.ui.highlight

Spec - howl.ui.List

Spec - howl.ui.Readline

Spec - howl.ui.Searcher

Spec - howl.ui.Selection

Spec - howl.ui.style

Spec - howl.ui.theme

Spec - howl.ui.Window

Spec - howl.ustrings

Spec - howl.util.Matcher(candidates)

Spec - howl.VC