Skip to content

Commit 1cadde9

Browse files
author
Marc Jakobi
committed
docs: lx check -> lx lint
1 parent 628f046 commit 1cadde9

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/guides/formatting-linting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ Linting is the process of analyzing code for stylistic and logic error (lines to
3535
Lux comes with `luacheck`, a linter for Lua code, built-in. To run `luacheck` on your project, use the following command:
3636

3737
```sh
38-
lx check
38+
lx lint
3939
```
4040

4141
We recommend running this automatically through a git hook, or running it manually at the end of every significant
4242
addition/refactor of your code.
4343

4444
## Git Hooks
4545

46-
We recommend setting up a Git hook to run `lx check` and `lx fmt` before
46+
We recommend setting up a Git hook to run `lx lint` and `lx fmt` before
4747
each commit to ensure that you never forget to lint and format your code.
4848

4949
To set up a Git hook, create a file called `.git/hooks/pre-commit` in your
@@ -52,7 +52,7 @@ project directory with the following content:
5252
```sh
5353
#!/bin/sh
5454

55-
lx check
55+
lx lint
5656
lx fmt
5757
```
5858

docs/tutorial/07-code-hygiene.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ title: Code Hygiene
66
Code hygiene is the practice of writing code that is readable and maintainable.
77
In this chapter, we'll let tools automatically clean up our code for us.
88

9-
## Linting with `lx check`
9+
## Linting with `lx lint`
1010

1111
Linting is the process of analyzing code for potential errors and stylistic issues (lines too long, unused variables, etc.).
1212
To lint the entire project, we can run:
1313

1414
```sh
15-
lx check
15+
lx lint
1616
```
1717

18-
<!--TODO: show output of lx check and fix the errors that exist there-->
18+
<!--TODO: show output of lx lint and fix the errors that exist there-->
1919

2020
## Formatting with `lx fmt`
2121

0 commit comments

Comments
 (0)