Neocmakelsp

Appearance

Configuration Reference ​

The configuration file can either be named .neocmake.toml or .neocmakelint.toml and is resolved in the current project directory. If neither is found, a user configuration file in $XDG_CONFIG_DIR/neocmakelsp either named config.toml or lint.toml can be used.

WARNING

This document describes the configuration of the latest git version of neocmakelsp.

INFO

Only a single configuration file will be used. The first file found in the order described above will be used.

Top-Level Configuration ​

command_case ​

  • Type: String
  • Description: Enable linting of consistency in command casing.
  • Valid values:
    • "upper_case": Commands must be uppercase.
    • "lower_case": Commands must be lowercase.
  • Default: Unset
  • Example:
toml
# Check that commands are lowercase.
command_upcase = "upcase"

enable_external_cmake_lint ​

  • Type: Boolean
  • Description: Enable linting with cmake-lint.
  • Default: false
  • Example:
toml
# Run `cmake-lint` as part of the linting process.
enable_external_cmake_lint = true

line_words_max ​

  • Type: Integer
  • Description: Maximum number of words allowed on a single line.
  • Default: 80
  • Example:
toml
# Set maximum line length to 100 characters.
line_words_max = 100

Format Configuration ​

program ​

  • Type: String
  • Description: External program to use for auto-formatting.
  • Default: Unset
  • Example:
toml
[format]
# Format with an external formatter.
program = "gersemi"

args ​

  • Type: Array of strings
  • Description: Extra arguments to pass to the formatting program.
  • Default: Unset
  • Example:
toml
[format]
program = "gersemi"
# Use two space indentation.
args = ["--indent", "2"]