Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
code

GitHub Action

StyLua

v1.1.2

StyLua

code

StyLua

GitHub Action to run StyLua, an opinionated Lua code formatter

Installation

Copy and paste the following snippet into your .yml file.

              

- name: StyLua

uses: JohnnyMorganz/stylua-action@v1.1.2

Learn more about this action in JohnnyMorganz/stylua-action

Choose a version

StyLua GitHub Action stylua-action status

GitHub Action to run StyLua, a Lua code formatter.

Installs the StyLua binary (from GitHub releases), and caches it. Any StyLua command can then be run.

NOTE: We recommend using a toolchain manager such as aftman to manage StyLua, as it allows you to define the version used throughout your project - both on the command line, and in GitHub actions.

Usage

- uses: actions/checkout@v2
- uses: JohnnyMorganz/stylua-action@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    version: latest # NOTE: we recommend pinning to a specific version in case of formatting changes
    # CLI arguments
    args: --check .

Parameters

token (Required)

GitHub token. Required since the binary is downloaded from GitHub releases (to speed download)

args (Required)

The arguments to pass to the StyLua binary

version (Optional)

The version of StyLua to use. Follows semver syntax. If not specified, installs the latest release. It is recommended to pin your version so that updates to StyLua don't lead to unwanted changes in the action without explicitly updating.

Based off https://github.com/Roblox/setup-foreman, licensed under MIT