---
id: lua
title: Lua
sidebar_label: Lua
---

## What

Display the currently active [Lua][lua] or [LuaJIT][luajit] version.

## Sample Configuration

import Config from "@site/src/components/Config.js";

<Config
  data={{
    type: "lua",
    style: "powerline",
    powerline_symbol: "\ue0b0",
    foreground: "white",
    background: "blue",
    template: " \ue620 {{ .Full }} ",
  }}
/>

## Properties

| Name                   | Type       | Description                                                                                                                                                                               |
| ---------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled`         | `boolean`  | display the segment in the HOME folder or not - defaults to `false`                                                                                                                       |
| `fetch_version`        | `boolean`  | display the lua version - defaults to `true`                                                                                                                                              |
| `missing_command_text` | `string`   | text to display when the command is missing - defaults to empty                                                                                                                           |
| `display_mode`         | `string`   | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.lua`, `*.rockspec` files or the `lua` folder are present (**default**)</li></ul> |
| `version_url_template` | `string`   | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes                                                                     |
| `preferred_executable` | `string`   | the preferred executable to use when fetching the version<ul><li>`lua`: the Lua executable (**default**)</li><li>`luajit`: the LuaJIT executable</li></ul>                                |
| `extensions`           | `[]string` | allows to override the default list of file extensions to validate                                                                                                                        |
| `folders`              | `[]string` | allows to override the list of folder names to validate                                                                                                                                  |
| `cache_version`        | `boolean`  | cache the executable's version or not - defaults to `false`                                                                                                                               |

## Template ([info][templates])

:::note default template

```template
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
```

:::

### Properties

| Name          | Type     | Description                                        |
| ------------- | -------- | -------------------------------------------------- |
| `.Full`       | `string` | the full version                                   |
| `.Major`      | `string` | major number                                       |
| `.Minor`      | `string` | minor number                                       |
| `.Patch`      | `string` | patch number                                       |
| `.URL`        | `string` | URL of the version info / release notes            |
| `.Error`      | `string` | error encountered when fetching the version string |
| `.Executable` | `string` | the executable used to fetch the version           |

[go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates
[lua]: https://www.lua.org/
[luajit]: https://luajit.org/