Language server which implements LSP protocol for Nobl9 configuration files.

LSP stands for Language Server Protocol. It defines the protocol used between an editor or an IDE and a language server (this project) that provides language features like auto complete, diagnose file, display documentation etc.

Installation

The Language Server binary has to be installed in your PATH, so that the IDE can access it by calling nobl9-language-server executable. If installed outside the PATH, the location must be supplied to the IDE through a dedicated option. Refer to specific IDE and plugin/extension documentation for more details.

Prebuilt Binaries

The binaries are available at Releases page.

Go install

go install github.com/nobl9/nobl9-language-server/cmd/nobl9-language-server@latest

Integrations

Visual Studio Code

Refer to the extension documentation for more details.

Intellij Platform

[!WARNING] Work in progress. The plugin is not yet available!

Refer to the plugin documentation for more details.

Neovim

Minimal Neovim setup which assumes you've already configured snippets support and LSP would look like this:

local lsp = require("lspconfig")
local configs = require("lspconfig.configs")

configs.nobl9_language_server = {
  default_config = {
    cmd = { "nobl9-language-server" },
    filetypes = { "yaml" },
    root_dir = function(fname)
      return vim.fs.dirname(vim.fs.find(".git", { path = fname, upward = true })[1])
    end,
    settings = {},
  },
}

Full, working configuration can be found here. You can play with it and adjust to your needs.

nvim --clean -u ./docs/neovim-config/init.lua service.yaml

Features

Currently only YAML format is supported.
Server supports the following LSP features:

• Auto completion
  • YAML key names
  • Enum values
  • Nobl9 platform resource names
• Diagnostics
  • YAML syntax errors
  • Static validation of the Nobl9 configuration
  • Dynamic Nobl9 resource references validation
• Hover documentation
  • Property documentation
  • Nobl9 resource documentation
• Code Actions
• Snippets

How it works

The language server is integrated with several development environments through dedicated plugins and extensions. However, in theory, every IDE which supports LSP should work with Nobl9 Language Server.

The server communicates over standard input/output streams (stdio) using JSON-RPC 2.0 protocol. Typically, an IDE (which in LSP nomenclature is called a client) would run the server, write requests to servers' standard input stream and read the responses from servers' standard output stream.
The following diagram demonstrates how an example communication flow between client (IDE) and server looks like:

sequenceDiagram
    participant C as Language Client (IDE)
    participant S as Language Server
    Note right of C: User opens a YAML file with Nobl9 configuration
    C ->> S: textDocument/didOpen (file opened)
    loop File Editing
        C ->> S: textDocument/didChange (file changed)
        S -->> C: publishDiagnostics (errors, warnings)
    end
    C ->> S: textDocument/completion (autocomplete request)
    S -->> C: completion items
    Note over C, S: Other LSP requests such as:<br/>textDocument/codeAction, textDocument/hover, etc.

Configuration

The Language Server comes with several configuration options. Each option can be supplied via a dedicated flag when starting the server.

# Display help information.
nobl9-language-server -h

# Log level, by default 'INFO'.
# One of: TRACE, DEBUG, INFO, WARN, ERROR.
# Env: NOBL9_LANGUAGE_SERVER_LOG_LEVEL
nobl9-language-server --logLevel=TRACE

# Path to the server's log file.
# It supports env variables and resolves '~' to user's home directory.
# By default the logs are written into stderr.
# Env: NOBL9_LANGUAGE_SERVER_LOG_FILE_PATH
nobl9-language-server --logFilePath=/path/to/my-log-file.txt

# Configure file patterns, comma separated list of patterns.
# Remember to quote them if they include glob patterns!
# If this option is provided, the server will only work with the files matching these patterns.
# Env: NOBL9_LANGUAGE_SERVER_FILE_PATTERNS
nobl9-language-server --filePatterns='foo,bar/*,baz/**/*.yml'

# Display version information.
nobl9-language-server version

YAML

[!IMPORTANT] By default, the language server will only offer its capabilities for files which contain the following text: apiVersion: n9/.

If you're working on an empty file, the server won't work until you write this text. Likewise, If your file had this text, but you removed it (maybe you cleared the whole file), the server will no longer work.

Internally, the server keeps track of every YAML file, even if it is skipped. In the current version of LSP, there's no way to tell the client we're skipping a file. If you experience overhead when working with many YAML files other than Nobl9 configuration, consider fine tuning your IDE to only send certain files to the server.

How can I force the server to work on a file which does not include this text?

• Add # nobl9-language-server: activate comment to the top of your file.
• Configure file patterns with --filePatterns flag (see configuration).

Nobl9 API

In order for the server to work correctly, it requires valid Nobl9 API access keys. Under the hood the server uses nobl9-go which is an official Golang SDK for Nobl9 platform. The SDK provides ways of authenticating with the Nobl9 platform, see this document for more information on different ways the API access keys can be provided.

If you're a sloctl user and you already have the config.toml file, the server will reuse it.

If you don't yet have any access keys, you can create them by following the official documentation.

If you're opting to configure the server using environment variables, use the following prefix: NOBL9_LANGUAGE_SERVER_ with any of the environment variables supported by the SDK.

Example:

export NOBL9_LANGUAGE_SERVER_CLIENT_ID=<your-client-id>
export NOBL9_LANGUAGE_SERVER_CLIENT_SECRET=<your-client-secret>

Development

Refer to the development documentation for more details.