Linting

The ubCode language server has a linting feature built in and detects a broad range of RST issues. The linting feature is enabled by default. Specific rules can be deactivated in the ubproject.toml file.

Lint errors appear in the editor as well as in the problems tab.

Supported lint rules:

Identifier

Description

source.tab_in_line

Warns on tabs in a line, which can degrade performance of source mapping.

block.blank_line

Warns on missing blank lines between syntax blocks.

block.title_line

Warns on issues with title under/over lines.

block.title_disallowed

Warns on unexpected titles in a context where they are not allowed.

block.paragraph_indentation

Warns on unexpected indentation of a paragraph line.

block.literal_no_content

Warns on literal blocks with no content.

block.target_malformed

Warns on malformed hyperlink targets.

block.substitution_malformed

Warns on malformed substitution definition.

block.table_malformed

Warns on malformed tables.

block.inconsistent_title_level

Warns on inconsistent title levels, e.g. a level 1 title style followed by a level 3 style.

block.directive_unknown

Warns on unknown directives.

block.directive_indented_options

Warns if the second line of a directive starts with an indented :.

block.directive_malformed

Warns on malformed directives.

block.directive_no_content

Warns on directives with missing required content.

inline.no_closing_marker

Warns on inline markup with no closing marker.

inline.role_malformed

Warns on malformed inline roles.

inline.role_no_name

Warns on inline roles with no name.