plugins.qmk.settings

Options provided to the require('qmk').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  auto_format_pattern = "*keymap.c";
  comment_preview = {
    keymap_overrides = { };
    position = "top";
    symbols = {
      bl = "└";
      bm = "┴";
      br = "┘";
      horz = "─";
      ml = "├";
      mm = "┼";
      mr = "┤";
      space = " ";
      tl = "┌";
      tm = "┬";
      tr = "┐";
      vert = "│";
    };
  };
  layout = [
    "x x"
    "x^x"
  ];
  name = "LAYOUT_preonic_grid";
  timeout = 5000;
  variant = "qmk";
}

Declared by:

plugins.qmk.settings.auto_format_pattern

The autocommand file pattern to use when applying QMKFormat on save.

Type: null or string or raw lua code

Default: null

Plugin default: "*keymap.c"

Declared by:

plugins.qmk.settings.layout

The keyboard key layout.

The layout config describes your layout as expected by qmk_firmware. As qmk_firmware is simply expecting an array of key codes, the layout is pretty much up to you.

A layout is a list of strings, where each string in the list represents a single row. Rows must all be the same width, and you’ll see they visually align to what your keymap looks like.

Type: list of string

Example:

[
  "x x"
  "x^x"
]

Declared by:

plugins.qmk.settings.name

The name of your layout, for example LAYOUT_preonic_grid for the preonic keyboard, for zmk this can just be anything, it won’t be used.

Type: string

Example: "LAYOUT_preonic_grid"

Declared by:

plugins.qmk.settings.timeout

Duration of vim.notify timeout if using nvim-notify.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 5000

Declared by:

plugins.qmk.settings.variant

Chooses the expected hardware target.

Type: null or one of “qmk”, “zmk” or raw lua code

Default: null

Plugin default: "qmk"

Declared by: