Skip to content

Commit c4ea832

Browse files
committed
refactor: rename binary invocations from lux -> lx
1 parent 1b70f6c commit c4ea832

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

docs/tutorial/02-getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ Make sure that `~/.cargo/bin/` is part of your shell's `$PATH`!
3838

3939
## Checking Installation
4040

41-
Ensure that installation was successful by running `lux help`.
41+
Ensure that installation was successful by running `lx help`.
4242
You should see output similar to the following:
4343
```
4444
A fast and efficient Lua package manager
4545
46-
Usage: lux [OPTIONS] <COMMAND>
46+
Usage: lx [OPTIONS] <COMMAND>
4747
4848
...
4949
```

docs/tutorial/03-creating-a-project.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ We'll store our code in a `my-lua-project/` directory.
1111
To do so, we can run:
1212

1313
```bash
14-
lux new my-lua-project
14+
lx new my-lua-project
1515
```
1616

1717
We'll now be asked to provide information about our project so `lux` can generate
@@ -75,7 +75,7 @@ To check whether our project was made successfully, first make sure you're in th
7575
Now, you can run a secret command:
7676

7777
```bash
78-
lux debug project
78+
lx debug project
7979
```
8080

8181
This will show information about the project if it was properly created. If everything

docs/tutorial/04-adding-dependencies.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Lua has a very little standard library, so let's download some dependencies to g
77
Since we want to develop a CLI, we need a library capable of parsing flags and arguments.
88
To do so, we will use [`argparse`](https://luarocks.org/modules/argparse/argparse). We'll install it with the following command:
99
```sh
10-
10+
1111
```
1212

1313
:::note
@@ -24,14 +24,14 @@ with our code. However, just running `lua` will *not* load our dependenices. To
2424
`lua` REPL with our dependencies loaded, we need to run the following command:
2525

2626
```sh
27-
lux lua
27+
lx lua
2828
```
2929

3030
This acts as a direct wrapper around the `lua` program.
3131
Once in the REPL, let's try to require our `argparse` code. Type `require("argparse").version`
3232
and press enter. Below is the successful output:
3333

34-
```sh title="lux lua"
34+
```sh title="lx lua"
3535
Lua 5.4.7 Copyright (C) 1994-2024 Lua.org, PUC-Rio
3636
> require("argparse").version
3737
0.7.1

docs/tutorial/05-making-the-application.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,11 @@ end
7474
We've transformed our program to check if the input contains the word "hello".
7575
Below are some example outputs:
7676

77-
```none title='lux run "Hello, world!"'
77+
```none title='lx run "Hello, world!"'
7878
Your input has the word 'hello' in it!
7979
```
8080

81-
```none title='lux run "Hi, world!"'
81+
```none title='lx run "Hi, world!"'
8282
Your input does not have the word 'hello' in it!
8383
```
8484

docs/tutorial/06-testing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ end)
8181

8282
## Running the Tests
8383

84-
We're now ready to run our tests! `lux test` will run all the tests in your
84+
We're now ready to run our tests! `lx test` will run all the tests in your
8585
project. After the automatic installation of `busted` you should see the following output:
8686

87-
```sh title="lux test"
87+
```sh title="lx test"
8888
●●
8989
2 successes / 0 failures / 0 errors / 0 pending : 0.001615 seconds
9090
```

docs/tutorial/07-code-hygiene.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ Linting is the process of analyzing code for potential errors and stylistic issu
1414
`lux` comes with `luacheck`, a linter for Lua code, built-in. To run `luacheck` on your project, use the following command:
1515

1616
```sh
17-
lux check
17+
lx check
1818
```
1919

20-
<!--TODO: Add output of `lux check` command for our current code and see if there are any issues.-->
20+
<!--TODO: Add output of `lx check` command for our current code and see if there are any issues.-->
2121

2222
## Formatting with `stylua`
2323

2424
`stylua` is a Lua code formatter that can automatically format your Lua code to a consistent style.
2525
It's highly recommended to use `stylua` to ensure that your code is consisent across the board.
2626

2727
```sh
28-
lux fmt
28+
lx fmt
2929
```
3030

31-
`lux fmt` will format all Lua files in your project to the style defined in
31+
`lx fmt` will format all Lua files in your project to the style defined in
3232
your
3333
[`.stylua.toml`](https://github.com/JohnnyMorganz/StyLua?tab=readme-ov-file#options)
3434
file, defined in the project root. Otherwise, it will use the default style.
@@ -44,8 +44,8 @@ project directory with the following content:
4444
```sh
4545
#!/bin/sh
4646

47-
lux check
48-
lux fmt
47+
lx check
48+
lx fmt
4949
```
5050

5151
Make sure to make the file executable:

docs/tutorial/08-publishing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ type = "builtin"
6464
With the API key in hand, we can now publish our rock. Run the following command in your project directory:
6565

6666
```sh
67-
LUX_API_KEY=your-api-key lux upload
67+
LUX_API_KEY=your-api-key lx upload
6868
```
6969

7070
`lux` will now package your project and upload it to luarocks!

0 commit comments

Comments
 (0)