README.md

Official ls-lint github action

ls-lint is an extremely fast directory and filename linter. It brings some structure to your project filesystem.

This repository is the GitHub action that brings ls-lint to your project easily.

Inputs

config

ls-lint config file path(s)

default: .ls-lint.yml

More information about the content of this file can be found on ls-lint.org

workdir

change working directory before executing the given sub-command

default: .

error-output-format

use a specific error output format (text, json)

default: text

warn

write lint errors to stdout instead of stderr (exit 0)

default: false

debug

write debug information to stdout

default: false

paths

file or directory path(s) to lint

Example usage

- uses: actions/checkout@v4
- uses: ls-lint/action@v2