yutu 0.1.1

Modern Lua linter
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# Yutu
[![Crates.io](https://img.shields.io/crates/v/yutu)](https://crates.io/crates/yutu)
[![MIT/Apache 2.0](https://img.shields.io/crates/l/yutu)](./LICENSE-MIT)
[![Crates.io](https://img.shields.io/crates/d/yutu)](https://crates.io/crates/yutu)
[![Rust](https://img.shields.io/github/actions/workflow/status/0x2a-42/yutu/rust.yml)](https://github.com/0x2a-42/yutu/actions)

[Yutu](https://en.wikipedia.org/wiki/Moon_rabbit) (玉兔) is a linter for Lua (5.4 and 5.5) inspired by [Clippy](https://github.com/rust-lang/rust-clippy).

The list of supported lints can be found [here](./lints.md).

## Example

```lua
goto foo
local a, b = 1, 2, 3
::foo::
if not (a > b) then
  print(b)
end
```
![Demo](./tests/diagnostics/demo.term.svg)

## Quickstart

Install `yutu` using `cargo`.
```sh
cargo install yutu
```

```
Modern Lua linter

Usage: yutu <COMMAND>

Commands:
  check  Checks the code for errors and warnings
  init   Creates a new yutu.toml configuration
  list   Lists all lints as markdown
  help   Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help
```

## License
Yutu is licensed under either of

 * Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.