Welcome to the Nova API Docs.
The official home of documentation for Nova’s Extension API.
Documentation
- The basics of developing Nova extensions.
- Getting started with extension development.
- Changes to the documentation by Nova version.
- How to contribute debug adapters to the IDE to provide interactive debugging.
- How an extension can contribute sidebars with one or more sections.
- Description of the Snippets placeholder format for Clips and Completions.
- Key-Value reference for the extension JSON manifest.
- How to localize extensions for multiple languages.
- A set of rules defining how issues are automatically detected in output.
- How to use image assets for interface elements in your extension.
- How to contribute tasks to the IDE within a user's project.
- How to define commands that can be invoked from the menu bar and command palette.
- How to use private and user-visible preferences to save state on a workspace or global basis.
- How to define a custom theme for the IDE and editor.
-
- How to extend Nova with support for new languages.
- How to use the built-in inspection tool when working on a language extension.
- Building a language around a Tree-sitter grammar.
- The basic building blocks of a language.
- Providing autocomplete items for a language's standard library.
- Defining a language grammar which uses regular expression rules.
-
- Interfaces exposed to allow building features and functionality from JavaScript.
- Registration of helpers for specific editor and workspace features
- A set of Unicode characters used in search operations
- Reading and writing to the clipboard
- A color represented in a color space
- A possible value that may be parsed into color information
- An annotatable color instance within a document
- Information about a request for colors
- A textual form in which a color can be represented when inserted into a document
- Information about a request for color presentations
- Management of user-invocable commands
- A color pop option displayed in the completions list
- Information about the request for completion items within an editor
- An item displayed in the editor completions list
- A collection for multiple disposable objects
- Storing and retrieving settings and persistent state
- The standard logging console
- Storage of secure credentials
- Cryptographic primitives
- A debug session running in the workspace
- A custom event sent from a debug adapter
- Objects which can be torn down
- Dispatches event notifications to listeners
- Top-level global object representing the application
- Information about the running extension
- Read and write files on disk
- Attributes of a file on disk
- Query and modify attributes of file system objects
- Observe changes to files in the workspace
- A single diagnostic from a linter or other tool
- Manages a set of issues displayed to the user
- Parses issues from textual content using rules
- Interfaces to Language Server Protocol support
- Dispatching unubtrusive requests and notices to the user
- A request to show a notification
- The result of presenting a notification
- A parse tree node captured as part of a match found during evaluation of a Tree-sitter query
- A match found during evaluation of a Tree-sitter query
- Manipulation of file system paths
- Launching background helper tools
- A message sent between an extension and subprocess over JSON-RPC
- A contiguous, linear region of text
- A string parser that progressively scans for substrings or characters
- A descriptor for a set of text highlighting classes used in syntax grammars
- A symbolic construct within a document
- A runnable task which is provided dynamically
- Information about a task action being resolved
- A task action which invokes an extension command
- A task action which invokes a Debug Adapter
- A task action which invokes a helper tool
- A task action placeholder which can resolve to a concrete action once invoked
- An open document in the workspace
- A single edit that may be applied to an editor
- An open editor in the workspace
- An atomic edit operation that may combine multiple changes
- An interface for objects that provided data to a TreeView
- An item shown within a TreeView
- A custom tree sidebar
- Interfaces supported from open Web API standards
- An open workspace window
-