Welcome to the Nova API Docs.

The official home of documentation for Nova’s Extension API.

Documentation

• Building Extensions
  The basics of developing Nova extensions.
  • Getting Started
    Getting started with extension development.
  • Documentation Release Notes
    Changes to the documentation by Nova version.
  • Debug Adapters
    How to contribute debug adapters to the IDE to provide interactive debugging.
  • Sidebars
    How an extension can contribute sidebars with one or more sections.
  • Snippets
    Description of the Snippets placeholder format for Clips and Completions.
  • Manifest Reference
    Key-Value reference for the extension JSON manifest.
  • Localization
    How to localize extensions for multiple languages.
  • Issue Matchers
    A set of rules defining how issues are automatically detected in output.
  • Images
    How to use image assets for interface elements in your extension.
  • Tasks
    How to contribute tasks to the IDE within a user's project.
  • Commands
    How to define commands that can be invoked from the menu bar and command palette.
  • Preferences
    How to use private and user-visible preferences to save state on a workspace or global basis.
  • Themes
    How to define a custom theme for the IDE and editor.
• Contributing Languages
  How to extend Nova with support for new languages.
  • Using the Syntax Inspector
    How to use the built-in inspection tool when working on a language extension.
  • Tree-sitter
    Building a language around a Tree-sitter grammar.
  • Defining a Syntax
    The basic building blocks of a language.
  • Language Completions
    Providing autocomplete items for a language's standard library.
  • Regex Grammars
    Defining a language grammar which uses regular expression rules.
• JavaScript API Reference
  Interfaces exposed to allow building features and functionality from JavaScript.
  • AssistantsRegistry
    Registration of helpers for specific editor and workspace features
  • Charset
    A set of Unicode characters used in search operations
  • Clipboard
    Reading and writing to the clipboard
  • Color
    A color represented in a color space
  • ColorCandidate
    A possible value that may be parsed into color information
  • ColorInformation
    An annotatable color instance within a document
  • ColorInformationContext
    Information about a request for colors
  • ColorPresentation
    A textual form in which a color can be represented when inserted into a document
  • ColorPresentationContext
    Information about a request for color presentations
  • CommandsRegistry
    Management of user-invocable commands
  • CompletionColorPop
    A color pop option displayed in the completions list
  • CompletionContext
    Information about the request for completion items within an editor
  • CompletionItem
    An item displayed in the editor completions list
  • CompositeDisposable
    A collection for multiple disposable objects
  • Configuration
    Storing and retrieving settings and persistent state
  • Console
    The standard logging console
  • Credentials
    Storage of secure credentials
  • Crypto
    Cryptographic primitives
  • DebugSession
    A debug session running in the workspace
  • DebugSessionCustomEvent
    A custom event sent from a debug adapter
  • Disposable
    Objects which can be torn down
  • Emitter
    Dispatches event notifications to listeners
  • Environment
    Top-level global object representing the application
  • Extension
    Information about the running extension
  • File
    Read and write files on disk
  • FileStats
    Attributes of a file on disk
  • FileSystem
    Query and modify attributes of file system objects
  • FileSystemWatcher
    Observe changes to files in the workspace
  • Issue
    A single diagnostic from a linter or other tool
  • IssueCollection
    Manages a set of issues displayed to the user
  • IssueParser
    Parses issues from textual content using rules
  • LanguageClient
    Interfaces to Language Server Protocol support
  • NotificationCenter
    Dispatching unubtrusive requests and notices to the user
  • NotificationRequest
    A request to show a notification
  • NotificationResponse
    The result of presenting a notification
  • ParseTreeCapture
    A parse tree node captured as part of a match found during evaluation of a Tree-sitter query
  • ParseTreeMatch
    A match found during evaluation of a Tree-sitter query
  • Path
    Manipulation of file system paths
  • Process
    Launching background helper tools
  • ProcessMessage
    A message sent between an extension and subprocess over JSON-RPC
  • Range
    A contiguous, linear region of text
  • Scanner
    A string parser that progressively scans for substrings or characters
  • ScopeSelector
    A descriptor for a set of text highlighting classes used in syntax grammars
  • Symbol
    A symbolic construct within a document
  • Task
    A runnable task which is provided dynamically
  • TaskActionResolveContext
    Information about a task action being resolved
  • TaskCommandAction
    A task action which invokes an extension command
  • TaskDebugAdapterAction
    A task action which invokes a Debug Adapter
  • TaskProcessAction
    A task action which invokes a helper tool
  • TaskResolvableAction
    A task action placeholder which can resolve to a concrete action once invoked
  • TextDocument
    An open document in the workspace
  • TextEdit
    A single edit that may be applied to an editor
  • TextEditor
    An open editor in the workspace
  • TextEditorEdit
    An atomic edit operation that may combine multiple changes
  • TreeDataProvider
    An interface for objects that provided data to a TreeView
  • TreeItem
    An item shown within a TreeView
  • TreeView
    A custom tree sidebar
  • Web APIs
    Interfaces supported from open Web API standards
  • Workspace
    An open workspace window