lux-cli-lint(1)

okay so bestie, welcome to lux-cli-lint(1) from the General Commands Manual — it's literally the page for linting your project with luacheck, and it's giving very useful terminal main character energy 💅✨

🌸 NAME

lux-cli-lint — Lint the current project using luacheck 💖

✨ SYNOPSIS ✨

Here's the whole spell, bestie:

lux-cli lint [--path] [--no-ignore] [--server] [--extra-servers]
[--namespace] [--lua-dir] [--lua-version] [--tree] [--cache-dir]
[--data-dir] [--variables] [--profile] [--verbose] [--no-progress]
[--no-prompt] [--preset] [--nvim] [--no-tfa] [--timeout] [--max-jobs]
[--no-luarc] [--no-wrap-bin] [--user-agent] [-h|--help] [ARGS]

🎀 DESCRIPTION 🎀

Lint the current project using luacheck. That's the whole assignment, and it ate. 🫶

💅 OPTIONS 💅

• --path <PATH> — Path to a workspace, directory, or Lua file to lint. Defaults to the current workspace 🦋
• --no-ignore — By default, Lux will add top-level ignored files and directories (like those in .gitignore) to luacheck's exclude files. This flag disables that behaviour. 🚫
• --server <server> — Fetch rocks/rockspecs from this server (takes priority over config file) 🌈
• --extra-servers <extra-server> — Fetch rocks/rockspecs from these servers in addition to the main server (overrides any entries in the config file) ✨
• --namespace <namespace> — Specify the luarocks server namespace to use 🎀
• --lua-dir <prefix> — Specify the directory in which to install Lua if not found 💜
• --lua-version <ver> — Which Lua installation to use. Valid versions are: '5.1', '5.2', '5.3', '5.4', '5.5', 'jit' and 'jit52'. If not set, Lux will attempt to detect the Lua version:
  • From the current project, if it has an exact Lua version requirement.
  • From the Lua installation that is available on the PATH 🌸
• --tree <tree> — Which tree to operate on. In a workspace, this can be used to specify a detached workspace tree 🌳
• --cache-dir <cache-dir> — Specifies the cache directory, e.g. for luarocks manifests 🗂️
• --data-dir <data-dir> — Specifies the data directory, in which the default user install tree resides (e.g. ~/.local/share/lux) 🏠
• --variables <variable> — Override config variables. Example: lx -v "LUA=/path/to/lua" ... 🔧
• --profile <profile> — The build profile to use when compiling packages. Default: release 🎚️
  • Possible values:
    • release
    • dev
• --verbose — Display verbose output of commands executed, enabling DEBUG logs. To enable TRACE logs, set RUST_LOG=trace 🔍
• --no-progress — Don't print any progress bars or spinners 🙈
• --no-prompt <NO_PROMPT> — Skip prompts, selecting the default option. Prompting is enabled by default in terminal/TTY environments 🤖
  • Possible values:
    • true
    • false
• --preset <preset> — Configure Lux for a specific environment. Valid presets are: 'nvim' 🧚
  • Possible values:
    • nvim: Configure Lux for Neovim plugins
• --nvim — [DEPRECATED] Configure lux for installing Neovim packages. Use --preset nvim instead ⚠️
• --no-tfa — Disable prompts for two-factor authentication (2FA) codes. It is strongly recommended to enable 2FA instead see (https://luarocks.org/settings/two-factor-auth) 🔐
• --timeout <seconds> — Timeout on network operations, in seconds. 0 means no timeout (wait forever). Default is 30 ⏱️
• --max-jobs <MAX_JOBS> — Maximum buffer size for parallel jobs, such as downloading rockspecs and installing rocks. 0 means no limit. Default is 0 🧵
• --no-luarc — Do not generate or update a .luarc.json file when building a project 📄
• --no-wrap-bin — Do not wrap Lua bin scripts 🎁
• --user-agent <USER_AGENT> — The user agent to set when making web requests. Default is "lux/<version>" 🕵️
• -h, --help — Print help (see a summary with -h) 🆘
• [ARGS] — Arguments to pass to the luacheck command. If you pass arguments to luacheck, Lux will not pass any default arguments 🫶

Footer sign-off, because we respect the bottom line: lint and lux-cli-lint(1) are down there doing their little source/version + manual-name dance, and there's no extra date printed on that line — so I'm not inventing one, bestie 🙈 Stay linted, stay iconic, periodt. 💖✨🎀