pyang-vscode

YANG Language Support using pyang.

This package can be used on Visual Studio Code, as well as any other Code - OSS and Theia derivatives that are compatible with VS Code Extension API.

Features

Inbuilt

Following features are provided directly by this Language Extension

• Syntax highlighting
• Comment toggling
• Brackets definition
• Autoclosing
• Autosurrounding

See: Syntax Highlight, Language Configuration

Language Server Based

pyang provides LSP based features for YANG, all of which are supported by the extension, except pull diagnostics since it is not automatically triggered.

See pyang documentation corresponding to installation for expected features.

See: Programmatic Language Features, Language Server Extension Guide

Requirements

The extension requires a pyang version installation that supports LSP. At the time of writing, only a work in progress pyang supports --lsp --no-env-path arguments, which are used to execute it as an LSP server.

The WIP pyang fork supporting LSP can be found here, and needs to be installed instead of official pyang package. Note that all versions of the fork are not necessarily compatible with every version of this extension, hence latest versions of both should be used, unless advised otherwise.

Extension Settings

This extension contributes the following settings:

• pyang.cli.args

  Extra pyang CLI arguments, above --lsp --no-env-path (which are already provided). This allows for tuning of LSP server defaults, providing search paths, and provisioning of pyang plugins, for example.

• pyang.trace.server

  LSP trace level.

• pyang.debug.server.enable

  LSP is used via TCP socket, instead of stdio.

• pyang.debug.server.host

  LSP Server Host, when LSP is used via TCP socket.

• pyang.debug.server.port

  LSP Server Port, when LSP is used via TCP socket.

Extension Commands

This extension contributes the following commands:

• pyang.client.restart

  pyang: Restart Language Server restarts the language client and in turn reinstantiates the language server. When pyang.debug.server.enable is set, it merely reinitiates the TCP connection and hence TCP server should already be initiated.

• pyang.editor.tree.diagram

  pyang: Generate YANG Tree Diagram generates the YANG Tree diagram source text corresponding to the YANG file in the active editor, and brings the generated file into focus.

• pyang.editor.puml.diagram

  pyang: Generate PlantUML Diagram generates the PlantUML diagram source text corresponding to the YANG file in the active editor, and brings the generated diagram via 'jebbs.plantuml' into focus.

Known Issues

Missing pyang or older installations that do not meet requirements are not handled gracefully.

Change of some settings e.g., CLI arguments, requires reload of manual reload of the editor. pyang: Restart Language Server command reuses the settings from the last startup.

For issues pertaining to the language server, please refer to documentation for pyang.

Release Notes

0.7.0

• Added YANG file template snippets for module and submodule
• Added Markdown code fenced syntax highlighting for yang and yangtree
• Updated keybinding for pyang: Generate YANG Tree Diagram to Alt+Y T
• Updated keybinding for pyang: Generate PlantUML Diagram to Alt+Y U

0.6.0

• Added menu items in editor context to generate PlantUML and YANG Tree Diagrams
• Improved usability of the PlantUML and YANG Tree Diagram generation. Requires latest version of pyang with LSP support.
• Improved syntax highlighting of YANG Tree Diagrams
• Added status bar item pyang for editors which are served by the extension.
• Associated .yang.tree extension with YANG Tree Diagram

0.5.0

• Extension now has an icon
• YANG Tree Diagram has a file icon
• Added command pyang: Generate PlantUML Diagram
• Added command pyang: Generate YANG Tree Diagram

0.4.0

• pyang.cli.args configuration is now empty by default
• pyang startup arguments now include --verbose, in addition to --lsp and --no-env-path arguments earlier
• Added support for YANG Tree Diagram syntax highlighting. .yangtree and .ytd file extensions are registered as YANG Tree Diagram by default.

0.3.0

• Added support for pyang's "References" Code Lens command

0.2.0

• Added support for older VS Code >= 1.65.0
• Added command pyang: Restart Language Server

0.1.0

Initial release of the extension

---